REST API

REST API - твой REST, твои правилаМодуль помогает организовать программный интерфейс для внешних и внутренних приложений.В настоящее время ведётся разработка новой версии модуля.Хотим получить от вас обратную связь, чего бы вам хотелось видеть в модуле, его функциональности.Опишите ваши пожелания на форме обратной связи.С 01.01.2020 запускаем программу поддержки общественных организаций, некоммерческих фондов, сообществ волонтёров, то есть всех тех компаний, которые работают на благо общества.В рамках данной программы уже поддержали проект Автоволонтёров России: https://x-15.ruПодробнее о программе вы можете узнать у наших операторов, по любым доступным каналам связи.Один из фактов о модуле: на основе данного модуля, студенты изучают работу REST API, а также реализуют собственные интерфейсы, которые позже сдают в виде курсовых и даже дипломных работ.Один из часто задаваемых вопросов: может ли модуль загружать на сайт остатки по товарам с сайта поставщика?Нет, модуль не может импортировать остатки по товарам с сайта поставщика.Модуль помогает реализовать API на вашем сайте, чтобы сторонние клиенты (другие сайты, мобильные приложения, и так далее) могли отдавать или забирать данные с вашего сайта. Ранее нами уже был разработан и опубликован на бесплатной основе модуль REST API. Данный модуль хорошо себя зарекомендовал для решения задач межплатформенных обменов, показателями этого факта являются отзывы и количество скачиваний. Со временем стало появляться множество запросов по доработке модуля, и как следствие, мы приняли решение о написании новой, усовершенствованной версии уже полюбившегося модуля.В данной версии мы учли все недостатки и пожелания из прошлой версии, очень хорошо оптимизировали ядро модуля, теперь оно работает гораздо быстрее, и на этом мы делаем свой основной упор. Помимо переработки ядра немаловажным фактором является и добавление карты роутов. За счет карты появилась возможность очень гибко настраивать параметры для любого отдельного роута. Что получите от приобретения модуля:- Уменьшение стоимости разработки API за счет сокращения времени на программирование интерфейса.- Поддержка от профессионалов, имеющих большой опыт создания API.- Готовый RESTful API интерфейс, с библиотекой встроенных методов, а также с возможностью создавать собственные, кастомные методы, реализующие любую, необходимую логику. И конечно, с автогенерируемой документацией, которую можно предоставить сторонним разработчикам. Возможности:- Использование API 1С-Битрикс через нативный рест-провайдер.- Загрузка интерфейса до запуска публичной части сайта.- Отсутствие необходимости в дополнительной настройке платформы.- Виртуальный путь к интерфейсу, в том числе и от корня домена (https://domain.com/ или https://domain.com/{api}/ или https://api.domain.com/).- Настройка доступа в административной части сайта к разделам модуля на уровне групп пользователей.- Автогенерируемая документация в административном разделе.- Автогенерируемая документация для клиента в JSON-формате.- Поддержка карт роутов.- Создание произвольных роутов (/{api}/user/, /{api}/user/get/, /{api}/user/v1/, ... ).- Установка собственных контроллеров для роутов (классы, внешние классы, php-файлы).- Настройка уровня доступа к роутам.- Валидация параметров входящего запроса.- Авторизация по логину и паролю для конкретного роута.- Авторизация по токену для конкретного роута.- Генерация токенов для пользователей.- Поддержка списка "белых" логинов/токенов для конкретного роута.- Проверка групп пользователя при авторизации для конкретного роута.- Возможность ограничения количества запросов в единицу времени на уровне групп пользователей.- Возможность передачи дополнительных заголовков при ответе.- Возможность деактивировать конкретный роут.- Кэширование входящих запросов и ответов средствами платформы.- Журналирование запросов и ответов.- Настройка CORS из административной части сайта.- Наличие функций упрощающих разработку интерфейса.- Наличие библиотеки встроенных роутов ускоряющих разработку интерфейса.- Наличие примеров и руководств для разработчика.Более подробно все возможности, функции и примеры описаны в документации, которая имеется в модуле.FAQ:Чем данный модуль отличается от REST API Битрикса? 1.1. В REST API Битрикса мало гибкости, есть необходимость использовать именно предоставленные роуты. Данный модуль позволяет формировать свои роуты, писать свою логику при обработке запроса, то есть предоставляет больше гибкости;1.2. REST API Битрикса реализовано не совсем согласно архитектурному стилю REST;1.3. В REST API Битрикса, при обработке запроса порой происходят «лишние» действия, которые могут создавать дополнительную задержку при ответе клиенту, может это и не сильно критично, но API должно быть настолько быстрым, насколько это возможно;1.4. API не всегда должно быть доступно всем, иногда оно должно быть уникально (роуты, параметры, ... ) для проекта, но за счет общего стиля REST API Битрикса, документация которого в общем доступе, эта уникальность нарушается и создает дополнительную лайзеку для атак на сайт. Используя данный модуль, можно указывать собственное имя роута, где будет работать API. Например: domain.com/rest/ или domain.com/api/, или domain.com/rest-api/, или api.domain.com, и так далее;1.5. В REST API Битрикса нет возможности как-то управлять интерфейсом из административной части сайта;1.6. В REST API Битрикса нет возможности регулировать доступы к роутам, ограничивать доступ по количеству запросов от клиента, журналировать запросы и ответы, и некоторые другие функции.1.7. На текущий момент, в REST API Битрикса, например, нет возможности создать заказ через API. Используя данный модуль вы можете реализовать этот функционал.1.8 В целом, данный модуль пишется и развивается на основе запросов пользователей, но REST API Битрикса пишется на усмотрение Битрикса. Плюс это или минус - решать вам.Примечание:- Минимальная версия PHP >= 7.4 (согласно требованиям платформы). Использование более ранней версии возможно, но крайне не рекомендуется, в виду возникновения ошибок.- Обязательно наличие файла для обработки 404 ошибки (обычно имеется в корне сайта - 404.php) со всеми "директивами" 1С-Битрикса.- Если используется веб-сервер Apache: обязательно прописать ErrorDocument 404 /404.php в .htaccess, расположенный в корне сайта, или прямо в конфигурационном файле Apache.- Если используется веб-сервер Nginx: обязательно прописать error_page 404 = /404.php?$query_string; в секцию server конфигурационного файла (обычно nginx.conf). - Для работы CORS-запросов необходимо чтобы на веб-сервере были разрешены запросы типа OPTIONS.Спасибо Вам за ознакомление с нашим модулем. Если у Вас имеются какие-либо вопросы/предложения, то мы всегда готовы обсудить их через контакты, указанные в разделе поддержки.Для тестирования работы модуля, вы можете использовать официальную виртуальную лабораторию 1С-Битрикс. Перейти к лаборатории.

REST API

от Компания Webco

Купить: 13 000 руб.

Попробовать (30 дней)

• Описание
• Отзывы (1)
• Обсуждения (26)
• Что нового
• Установка
• Поддержка

Описание

Технические данные

Опубликовано:

06.08.2018

Обновлено:

22.02.2023

Версия:

4.12.0

Установлено:

500 - 999 раз

Подходящие редакции:

«Старт», «Стандарт», «Малый бизнес», «Бизнес», «Корпоративный портал», «Энтерпрайз»

Адаптивность:

Нет

Поддержка Композита:

Нет

Совместимо с Сайты24

Нет

Совместимо с PHP 8.1

Нет

Пользовательское соглашение

Описание

REST API - твой REST, твои правила

Модуль помогает организовать программный интерфейс для внешних и внутренних приложений.

В настоящее время ведётся разработка новой версии модуля. Хотим получить от вас обратную связь, чего бы вам хотелось видеть в модуле, его функциональности. Опишите ваши пожелания на форме обратной связи.

С 01.01.2020 запускаем программу поддержки общественных организаций, некоммерческих фондов, сообществ волонтёров, то есть всех тех компаний, которые работают на благо общества. В рамках данной программы уже поддержали проект Автоволонтёров России: https://x-15.ru Подробнее о программе вы можете узнать у наших операторов, по любым доступным каналам связи.

Один из фактов о модуле: на основе данного модуля, студенты изучают работу REST API, а также реализуют собственные интерфейсы, которые позже сдают в виде курсовых и даже дипломных работ.

Один из часто задаваемых вопросов: может ли модуль загружать на сайт остатки по товарам с сайта поставщика? Нет, модуль не может импортировать остатки по товарам с сайта поставщика. Модуль помогает реализовать API на вашем сайте, чтобы сторонние клиенты (другие сайты, мобильные приложения, и так далее) могли отдавать или забирать данные с вашего сайта.

Ранее нами уже был разработан и опубликован на бесплатной основе модуль REST API. Данный модуль хорошо себя зарекомендовал для решения задач межплатформенных обменов, показателями этого факта являются отзывы и количество скачиваний. Со временем стало появляться множество запросов по доработке модуля, и как следствие, мы приняли решение о написании новой, усовершенствованной версии уже полюбившегося модуля.

В данной версии мы учли все недостатки и пожелания из прошлой версии, очень хорошо оптимизировали ядро модуля, теперь оно работает гораздо быстрее, и на этом мы делаем свой основной упор.

Помимо переработки ядра немаловажным фактором является и добавление карты роутов. За счет карты появилась возможность очень гибко настраивать параметры для любого отдельного роута.

Что получите от приобретения модуля:

- Уменьшение стоимости разработки API за счет сокращения времени на программирование интерфейса.

- Поддержка от профессионалов, имеющих большой опыт создания API.

- Готовый RESTful API интерфейс, с библиотекой встроенных методов, а также с возможностью создавать собственные, кастомные методы, реализующие любую, необходимую логику. И конечно, с автогенерируемой документацией, которую можно предоставить сторонним разработчикам.

Возможности:

- Использование API 1С-Битрикс через нативный рест-провайдер.

- Загрузка интерфейса до запуска публичной части сайта.

- Отсутствие необходимости в дополнительной настройке платформы.

- Виртуальный путь к интерфейсу, в том числе и от корня домена (https://domain.com/ или https://domain.com/{api}/ или https://api.domain.com/).

- Настройка доступа в административной части сайта к разделам модуля на уровне групп пользователей.

- Автогенерируемая документация в административном разделе.

- Автогенерируемая документация для клиента в JSON-формате.

- Поддержка карт роутов.

- Создание произвольных роутов (/{api}/user/, /{api}/user/get/, /{api}/user/v1/, ... ).

- Установка собственных контроллеров для роутов (классы, внешние классы, php-файлы).

- Настройка уровня доступа к роутам.

- Валидация параметров входящего запроса.

- Авторизация по логину и паролю для конкретного роута.

- Авторизация по токену для конкретного роута.

- Генерация токенов для пользователей.

- Поддержка списка "белых" логинов/токенов для конкретного роута.

- Проверка групп пользователя при авторизации для конкретного роута.

- Возможность ограничения количества запросов в единицу времени на уровне групп пользователей.

- Возможность передачи дополнительных заголовков при ответе.

- Возможность деактивировать конкретный роут.

- Кэширование входящих запросов и ответов средствами платформы.

- Журналирование запросов и ответов.

- Настройка CORS из административной части сайта.

- Наличие функций упрощающих разработку интерфейса.

- Наличие библиотеки встроенных роутов ускоряющих разработку интерфейса.

- Наличие примеров и руководств для разработчика.

Более подробно все возможности, функции и примеры описаны в документации, которая имеется в модуле.

FAQ:

Чем данный модуль отличается от REST API Битрикса?

1.1. В REST API Битрикса мало гибкости, есть необходимость использовать именно предоставленные роуты. Данный модуль позволяет формировать свои роуты, писать свою логику при обработке запроса, то есть предоставляет больше гибкости;

1.2. REST API Битрикса реализовано не совсем согласно архитектурному стилю REST;

1.3. В REST API Битрикса, при обработке запроса порой происходят «лишние» действия, которые могут создавать дополнительную задержку при ответе клиенту, может это и не сильно критично, но API должно быть настолько быстрым, насколько это возможно;

1.4. API не всегда должно быть доступно всем, иногда оно должно быть уникально (роуты, параметры, ... ) для проекта, но за счет общего стиля REST API Битрикса, документация которого в общем доступе, эта уникальность нарушается и создает дополнительную лайзеку для атак на сайт. Используя данный модуль, можно указывать собственное имя роута, где будет работать API. Например: domain.com/rest/ или domain.com/api/, или domain.com/rest-api/, или api.domain.com, и так далее;

1.5. В REST API Битрикса нет возможности как-то управлять интерфейсом из административной части сайта;

1.6. В REST API Битрикса нет возможности регулировать доступы к роутам, ограничивать доступ по количеству запросов от клиента, журналировать запросы и ответы, и некоторые другие функции.

1.7. На текущий момент, в REST API Битрикса, например, нет возможности создать заказ через API. Используя данный модуль вы можете реализовать этот функционал.

1.8 В целом, данный модуль пишется и развивается на основе запросов пользователей, но REST API Битрикса пишется на усмотрение Битрикса. Плюс это или минус - решать вам.

Примечание:

- Минимальная версия PHP >= 7.4 (согласно требованиям платформы). Использование более ранней версии возможно, но крайне не рекомендуется, в виду возникновения ошибок.

- Обязательно наличие файла для обработки 404 ошибки (обычно имеется в корне сайта - 404.php) со всеми "директивами" 1С-Битрикса.

- Если используется веб-сервер Apache: обязательно прописать ErrorDocument 404 /404.php в .htaccess, расположенный в корне сайта, или прямо в конфигурационном файле Apache.

- Если используется веб-сервер Nginx: обязательно прописать error_page 404 = /404.php?$query_string; в секцию server конфигурационного файла (обычно nginx.conf).

- Для работы CORS-запросов необходимо чтобы на веб-сервере были разрешены запросы типа OPTIONS.

Спасибо Вам за ознакомление с нашим модулем. Если у Вас имеются какие-либо вопросы/предложения, то мы всегда готовы обсудить их через контакты, указанные в разделе поддержки.

Для тестирования работы модуля, вы можете использовать официальную виртуальную лабораторию 1С-Битрикс. Перейти к лаборатории.

Отзывы (1)

Обсуждения (26)

Обсуждения (26 )

Авторизуйтесь, чтобы оставить отзыв или задать вопрос разработчику.

Пользователь 159164 2 декабря 2022 02:06

Было бы здорово еще к документации добавить, помимо принимаемых переменных, еще и возвращаемые. Ну и возможно пример запроса и пример ответа. А так модуль огонь!

Пользователь 159164 17 апреля 2022 02:01

Приветствую! Какой есть вариант заставить работать глобальную переменную $USER в контроллере? Проблема в том, что я создаю заказ в контроллере, а битрикс в своём ядре вызывает функции из пространства имён \Bitrix\Main\Analytics класс Catalog, в которых задействована эта глобальная переменная, соответственно получаю ошибку, так как по пейджплану загрузки вашего модуля переменная $USER еще не инициализирована.

Денис Артамонов (разработчик) 18 апреля 2022 11:48

Андрей Базыкин, на случае, если не хочется самостоятельно получать данные пользователя, то в модуле предусмотрено два варианта:
1. Отложенная загрузка - по пейджплану загрузка произойдет чуть позже, когда глобальные переменные будут инциализированы.
2. Либо, если не использовать отложенную загрузку и если в модуль были переданы заголовки авторизации, то модуль автоматически подгрузит данные нужно пользователя (см. входящий запрос).

Пользователь 308358 21 октября 2021 14:22

И еще было бы здорово, если бы для параметров можно было бы указывать значение по умолчанию. Что-то типа

'limit' => [
    'type' => 'integer',
    'possibleValue' => [
         '1',
         '...',
         '150'
    ],
    'default' => 10,
    'description' => 'Количество (по умолчанию: 10)'
],

И если значение limit при запросе явно не указано, то var_dump(request()->get('limit')); // 10

Денис Артамонов (разработчик) 21 октября 2021 14:27

Алексей, спасибо, это уже реализовано. Будет доступно в новых версиях модуля. Точную дату релиза пока огласить не могу.

Пользователь 308358 21 октября 2021 11:56

Добрый день. Если в контроллер добавить такой код

Loader::includeModule('iblock');
$dbProducts = \Bitrix\Iblock\ElementTable::query()
    ->setFilter(['IBLOCK_ID' => 2])
    ->setSelect(['NAME', 'DETAIL_TEXT', 'CODE', 'ID', 'XML_ID'])
    ->setCacheTtl(3600)
    ->cacheJoins(true)
    ->exec();
while ($arProduct = $dbProducts->fetch())
{
    $arResult['PRODUCTS'][] = $arProduct;
}

response()->json($arResult);

то запрос не попадет в кеш и будет выполняться каждый раз. Происходит так потому что запись тегированного кеша происходит в самом конце страницы. Т.е. в данном случае до записи просто не доходит. Пока что планирую перед отправкой ответа просто указывать запись в кеш:

\Bitrix\Main\Data\ManagedCache::finalize();

Хотелось бы чтобы это работало из коробки

Денис Артамонов (разработчик) 21 октября 2021 12:07

Алексей, спасибо. Проверим ситуацию, подберем решение.
Плюс, можете попробовать использовать функцию кеширования модуля, которая является оберткой над стандартной функцией.
https://gitlab.com/artamonov.documentation/modules/bitrix/artamonov.rest/-/wikis/Описание/Кэширование

Пользователь 230523 21 августа 2021 18:43

Вы наверно не поняли вопроса.
Есть параметр, не обязательный на первом уровне, пускай будет owner
У него есть под параметры, второй уровень, вот во втором уровне уже есть и обязательные и не обязательные, проверку которых модуль игнорирует.
То есть например:
Покупатель - физическое лицо, необязательный. Но ежели мы выбрали его заполнять то у него должна быть фамилия и имя которые мы хотим получить обязательными, а вот возраст не обязательными.
В текущей реализации мы можем получить физ лицо вообще пустое, и оно запишется в бд.
Ну и вообще логика построения дерева параметров запроса подсказывает, что установление таких ключей как обязательность и тип данных должны работать идентично на любом уровне дерева.
Прошу поправить, потому как получается слишком много трудозатрат на обработку запроса собственными средствами, понадеявшись на Ваш модуль.

1 - 5 из 26

Назад12...6Вперед

Что нового

4.12.0 (22.02.2023)	Доработано: улучшена совместимость с PHP 8 и выше.
4.11.0 (13.01.2023)	Доработано: улучшена совместимость с PHP 8 и выше.
4.10.0 (30.08.2022)	Доработано: на уровне ядра добавлен заголовок Access-Control-Allow-Credentials со значением true. Доработано: отключена проверка модуля безопасности на фишинг при редиректе на страницу документации из административного раздела.
4.9.0 (02.08.2022)	Улучшено: работа с журналом Входящие запросы - переведено на штатное ORM. Улучшено: повышена производительность Монитора поддержки. Доработано: доработана вёрстка Монитора поддержки. Исправления: рефакторинг и оптимизация.
4.8.1 (19.07.2021)	Доработано: добавлена обратная совместимость для старых версий модуля, где еще отсутствует класс Password с методом equals(). Исправления: мелкие правки.
4.8.0 (03.07.2021)	Доработано: в новых версиях главного модуля, поле PASSWORD объявлено приватным. Поэтому, при авторизаци по логину и паролю, могли наблюдаться проблемы. Исправления: незначительные улучшения.
4.7.0 (02.06.2021)	Доработано: теперь учитывается формат даты и времени для не RU локализаций. Исправлено: кодировка копирайта в заголовке ответа. Доработано: мелкие правки и рефакторинг.
4.6.0 (19.12.2020)	Доработано: добавлена возможность выбора сайтов, на которых необходимо запускать модуль. Доработано: улучшена работа модуля в режиме многосайтовости. Доработано: добавлено игнорирование всех запросов, которые выполняются на адрес /bitrix/.
4.5.0 (03.12.2020)	Доработано: авторизация по логину и паролю. Теперь проверка пароля выполняется с помощью метода Bitrix\Main\Security\Password::equals(). Доработано: в связи с устаревшим, начиная с версии PHP 7.2.0, функционалом механизма перегрузки функций (mbstring.func_overload), и отказом от использования его в платформе, строковые функции модуля были переведны в многобайтовый режим работы. Исправлено: проблема при подключении модуля в файле init.php, в случае, если файл имелся в директории, но был абсолютно пустым. Доработано: теперь резервная копия файла init.php создаётся до установки и до удаления модуля. Ранее копия создавалась лишь при установке модуля. Доработано: незначительные технические изменения.
4.4.0 (17.10.2020)	Доработано: авторизация по логину и паролю. Доработано: функция возврата ответа клиенту: response()->json(). Теперь в данную функцию можно передавать значения заголовков не только в виде строки, но и в виде массива. В котором могут быть указаны дополнительные параметры для заголовка (в соответствии с функцией header($header, $replace, $http_response_code)). Подробнее смотрите в роуте-примере (example). Добавлено: класс Artamonov\Rest\Foundation\Token. Теперь можно генерировать токены пользователей с помощью данного класса, при любой необходимости. Класс поддерживает как генерацию токенов, так и другие действия. Генерация токенов возможна для списка пользователей, плюс поддерживаются параметры ($parameters) от метода UserTable::getList(). Для удобства добавлена функция token(). Подробнее смотрите в документации. Добавлено: в разделе Безопасность, пошаговое создание и обновление токенов для пользователей. Полезная функция, если в базе сайта зарегистрировано большое количество пользователей. Доработано: незначительные технические изменения.
4.3.1 (18.09.2020)	Доработано: техническое обновление.
4.3.0 (11.09.2020)	Исправлено: проблема возникающая после истечения демонстрационного периода.
4.2.0 (06.09.2020)	Доработано: метод получения параметров модуля из базы. Теперь получаемые параметры кэшируются. Время кэширования зависит от настроек параметра cache_flags в файле /bitrix/.settings.php. Доработано: метод получения данных пользователя, если была активна авторизация для роута. Теперь метод умеет десериализовывать данные в пользовательских полях. Доработано: ключ карты роутов example был добавлен в роуте {api}/docs. Исправлено: если в карте роутов отсутствует какой-либо контроллер (файл или класс), тогда в документации будет выведено сообщение об этом. Добавлено: параметр для регулирования глобальной проверки сроков годности токенов. Внимание: по умолчанию данный параметр отключен. Подробнее в разделе Безопасность. Добавлено: автогенерация токена при добавлении нового пользователя. Подробнее в разделе Безопасность. Добавлено: сообщения возвращаемые клиенту при возникновении ошибок на этапе запуска интерфейса.
4.1.0 (10.08.2020)	Добавлено: проверка многоуровневых параметров при передаче запроса. Подробнее структуру карты можно посмотреть в документации к модулю. Доработано: раздел документации с картой роутов - теперь поддерживается отображение неограниченного количества уровней параметров роута. Добавлено: поддержка разделителя параметров в документации карты роутов - для лучшего визуального представления списка параметров. Подробнее структуру карты можно посмотреть в примере карты роутов. Доработано: при проверке параметра на integer, в опции max_range теперь используется константа PHP_INT_MAX. Добавлено: теперь числа переданные в виде строки, будут автоматически преобразованы в нужный тип, при проверке входящих параметров. Поддерживаемые типы для преобразования: integer, float.
4.0.2 (07.07.2020)	Исправлено: верстка в разделе Документация - Карта роутов.
4.0.1 (22.05.2020)	Исправлено: проверка типа входящих параметров.
4.0.0 (22.04.2020)	Добавлено: настройка видимости меню модуля в общем меню админ. раздела. Добавлено: нативный роут {{api}}/provider. Роут является провайдером к внутреннему апи платформы 1С-Битрикс. Поддерживает get и post запросы. Подробнее про использование роута можно узнать в документации.
3.5.0 (15.01.2020)	Добавлено: в Helper модуля добавлен метод isBool. Доработано: техническое обновление.
3.4.0 (26.10.2019)	Добавлено: возможность использовать переменные в роутах. Теперь в карте роутов можно указывать шаблон строки с использованием переменных. Например: /example/check/section/{{sectionId}}/{{productId}}/view/. Значения переменных sectionId и productId можно будет получить так же через request()->get(). Примеры шаблонов строк можно посмотреть в документации по картам роутов. Добавлено: константы отключающие сбор статистики, проверки агентов и другие. Исправлено: мелкие правки по дизайну модуля в админ.разделе. Исправлено: мелкие правки по коду.
3.3.2 (31.08.2019)	Исправлено: решена проблема отображения роутов в документации, если контроллеры роутов были прописаны через путь к файлу, а не через неймспейс.
3.3.1 (30.07.2019)	Исправлено: решена проблема отображения технического сообщения на страницах Настройки и Безопасность при активации режима "Установка для разработки".
3.3.0 (24.06.2019)	Доработано: отложенный запуск интерфейса. Теперь можно регулировать момент запуска модуля с помощью параметра в Настройках. Стало возможным запускать модуль либо при старте init.php (1.5), либо перед запуском визуальной части, в событии OnProlog (1.15). Подробнее: https://dev.1c-bitrix.ru/api_help/main/general/pageplan.php Обновлено: документация.
3.2.0 (07.05.2019)	Доработано: техническое обновление.
3.1.0 (16.02.2019)	Изменено: для большего удобства документация по модулю вынесена на сторонний ресурс. Доработано: документация по модулю. Доработано: мелкие улучшения.
3.0.0 (15.02.2019)	Доработано: метод создания таблиц журналов. Исправлено: языковые фразы.
2.9.3 (09.02.2019)	Исправлено: выборка данных по дате в журнале Входящие запросы. Исправлено: ошибка возникающая в случае удаления таблиц при удалении модуля.
2.9.2 (09.02.2019)	Исправлено: логика внутренних функций.
2.9.1 (09.02.2019)	Исправлено: незначительные ошибки.
2.9.0 (09.02.2019)	Доработано: если роут отключен, тогда он будет исключен из документации в публичной части (см. описание версии 2.5.0). Исправлено: теперь функции модуля не доступны из публичной части сайта. Доработано: Оптимизация и увеличение производительности.
2.8.0 (08.02.2019)	Добавлено: в Журнал Запрос/Ответ добавлено поле Метод, а также добавлен фильтр по данному полю. Добавлено: при авторизации через логин и пароль теперь еще происходит проверка на наличие $_SERVER['PHP_AUTH_USER'] и $_SERVER['PHP_AUTH_PW'], для поддержки HTTP Authorization. Добавлено: при несовпадении типа контента запроса с настройками роута, теперь возвращается название типа контента, который необходим при запросе. Добавлено: если запрос производится с участием авторизации, через токен или логин/пароль, тогда в параметры запроса будет добавлена информация о пользователе, которому принадлежат авторизационные данные. Данные пользователя сохраняются в ключ _user. Напоминание: в контроллере, параметры входящего запроса, можно получить с помощью функции request()->get(). Доработано: при отключении нативных роутов они деактивируются и в документации. Доработано: добавлен индикатор активности нативных роутов в раздел Поддержка. Доработано: расширена поддержка типов контента при запросе. Например, ранее, метод PUT или DELETE поддерживали только application/json, теперь поддерживают и application/x-www-form-urlencoded, и другие. Напоминание: не забывайте указывать/ограничивать тип контента запроса через карту роутов, с помощью ключа contentType. Доработано: расширена поддержка типов запросов: HEAD, PATCH. Изменено: название Журнала Запрос/Ответ -> Входящие запросы. Изменено: актуализирована документация по модулю. Удалено: описание модуля из раздела Документация - Основные сведения. Доработано: Незначительные исправления.
2.7.0 (01.02.2019)	Изменено: приведение названий входящих заголовков к нижнему регистру. Добавлено: нативный роут для получения ID пользователя по логину или токену. При запросе требуется авторизация по токену. Уточнение: любой роут может быть перекрыт через собственную карту роутов. То есть, если нативный роут вам чем-то не подходит, то вы можете скопировать его в собственную карту и модифицировать под необходимую логику. Добавлено: возможность включать/отключать использование нативных роутов. Добавлено: возможность указывать путь к собственным картам роутов. Теперь, нет необходимости хранить рабочие файлы в папке модуля. А именно, карты роутов и контроллеры. Напоминаем о том, что контроллером для роута может выступать, как класс доступный по неймспейсу, так и обычный скрипт. Которые могут располагаться за пределами директории модуля. Добавлены: lang-папки для языков: en, de, fr. Внимание, все фразы имеют русский перевод. Папки добавлены для корректной работы модуля на мультиязычных сайтах.
2.6.0 (13.01.2019)	Доработано: добавлен параметр Срок годности токена. Теперь можно указывать срок годности токена при его генерации. Доработано: в карте роутов, в секции security, в ключ token, добавлен ключ checkExpire, регулирующий необходимость проверки срока годности токена, при авторизации через токен. Изменено: в карте роутов, в секции security, ключ authType переименован в type, и перенесен в ключ auth.
2.5.0 (13.01.2019)	Доработано: добавлен встроенный роут /{api}/docs для получения документации в публичной части. Теперь клиенты могут получать автоматически генерируемую документацию в JSON-формате, которая создается на основе карт роутов. Изменено: папка {module_id}/lib/controllers/example/ удалена, а класс Example перенесен в {module_id}/lib/controllers/native/.
2.4.0 (12.01.2019)	Доработано: возможность управлять CORS (кросс-доменными запросами) из административного раздела сайта.
2.3.0 (12.01.2019)	Исправлено: вернули поддержку файлового режима работы. Теперь в карте роута, вместо контроллера, можно указать путь к php-скрипту. Подробнее смотрите в карте-примере: /routes/_example.php.
2.2.0 (12.01.2019)	Доработано: функция json_encode заменена на Bitrix\Main\Web\Json::encode для принудительного кодирования ответа в utf-8. Доработано: заголовки модуля отсылаются только в том случае, если был запущен интерфейс. Исправлено: в карте роутов, в секции security, убран ключ required. Доработано: возможность авторизации по логину/паролю. Тип авторизации настраивается в карте роута - ключ authType - подробнее смотрите в карте-примере: /routes/_example.php. Доработано: все настройки и функционал присущий авторизации через токен, так же действует и для авторизации через логин/пароль.
2.1.1 (11.01.2019)	Доработано: добавлен принудительный перевод в нижний регистр названия класса при его автоматическом подключении
2.1.0 (10.01.2019)	Доработано: в карту роутов, в секцию security, добавлен ключ required, который указывает на необходимость активации параметра Авторизация по токену. Подробнее смотрите в карте-примере: /routes/_example.php
2.0.0 (05.01.2019)	Доработано: отключение использования функции GetModuleID, так как из-за неё возникала проблема в работе модуля на windows-серверах, в виду разности разделителей директорий ("/", "\"). Проблема описана в Отзыве. Доработано: увеличен размер поля IP в таблице artamonov_rest_request_response. Для избежания проблемы, когда запросы посылаются из REST-клиентов. Доработано: добавлены роуты для работы с токенами (создание, получение, удаление). Доработано: добавлены роуты для работы с пользователями (создание, получение, обновление, удаление). Доработано: небольшая оптимизация и ускорение работы ядра.
1.2.0 (11.11.2018)	Доработано: добавлена возможность передавать сообщение при ответе badRequest, internalServerError. Доработано: добавлена валидация входящих параметров при запросе. Происходит проверка на наличие параметра в запросе, а также на соответствие типу. Валидация параметров реализована на два уровня. Поддерживаемые типы параметров при валидации: string, integer, float, email, ip, domain, url. Подробнее смотрите в карте роутов. Доработано: добавлены человеко-понятные ответы при неудачных запросах типа badRequest. Исправлено: проблема при получении GET-параметров при запросах типа PUT и DELETE. Исправлено: проблема при получении заголовков запроса на Nginx (без Apache). Поправлено: стили модуля в административном разделе сайта.
1.1.0 (24.10.2018)	Исправлено: языковые фразы. Доработано: условие при установке кэша для избежания получения Исключения. Доработано: добавлен параметр в разделе Настройки для включения/отключения тестового роута - http|https://{domain}/{api}/example/check. Доработано: в карте роутов добавлен ключ possibleValue, для указания возможных значений параметра запроса. Подробнее смотрите в карте роутов. Доработано: в карте роутов добавлена возможность добавлять пример ответа на запрос. Подробнее смотрите в карте роутов. Доработано: в карте роутов добавлена возможность исключать описание роута. Подробнее смотрите в карте роутов. Доработано: вывод JSON в журнале Запрос/Ответ.
1.0.2 (11.10.2018)	Исправлено: параметры для возможности работы демо-режима
1.0.1 (08.09.2018)	Исправлено: работа CORS-запросов Исправлено: интерфейсные ошибки

Установка

Установка модуля происходит стандартным способом.
После установки модуль будет расположен в разделе Сервисы.

Поддержка

Режим работы
Согласно производственному календарю России
Понедельник – Пятница
10:00 – 18:00 – Россия, Москва
12:00 – 20:00 – Россия, Екатеринбург
14:00 – 22:00 – Россия, Новосибирск
09:00 – 17:00 – Казахстан, Астана
08:00 – 16:00 – Англия, Лондон

Онлайн-чат (срочные вопросы): https://wbc.bitrix24.ru/online/chat
E-mail (вопросы общего характера): hello@webco.io
E-mail (вопросы по документам): documents@webco.io
E-mail (вопросы по техподдержке): support@webco.io
Сайт: https://webco.io

Идентификатор ЭДО – Диадок
2BM-540550482808-20190124090719306397300000000

Банковские реквизиты
Банк – АО "ТИНЬКОФФ БАНК"
БИК – 044525974
Корр.счет – 30101810145250000974
Расч.счет – 40802810200000584808

Социальные сети
Instagram: https://instagram.com/webco.io
Facebook: https://www.facebook.com/webco.company
YouTube: https://www.youtube.com/channel/UCfUcqhqw9BFXY0Ul24aZsRg/videos
Вконтакте: https://vk.com/webco
Одноклассники: https://ok.ru/group/62431699927146
Telegram: https://t.me/WebcoRobot

Сертификаты
https://webco.io/certificates

Отзывы
https://yandex.ru/profile/173517513051

Благодарность
https://pay.cloudtips.ru/p/0a916b16

Другие решения разработчика

REST API Бесплатно 9

Bitrix24 Extension 2 500 руб.

Расширенные настройки продукта 6 000 руб.

Набор инструментов 4 200 руб.