DAX-БУС. Обмен. V2.0. Техническое задание на расширения RestApi в Битрикс Управление Сайтом. 4 Общая информация 4 Модуль symmetron restapi 5
 Скачать 74.23 Kb.
|
  2021 БУС. RestApi Оглавление Глоссарий 3 Техническое задание на расширения RestApi в Битрикс Управление Сайтом. 4 Общая информация 4 Модуль symmetron.restapi 5 Описание Rest-методов 5 Страницы для создания вебхуков. 5 Форматы ответов 6 Успех 6 Ошибка 6 Описание методов и структуры данных 7 Структура полей для разделов ИБ 7 Структура полей элементов ИБ 7 Получения списка типов ИБ 9 Получения списка ИБ 11 Получение информации о ИБ по ID или CODE 13 Получение полей и пользовательских полей раздела ИБ 14 Получение разделов ИБ 16 Получение информации о разделе ИБ по ID или CODE 18 Добавление раздела ИБ 19 Изменение разделов ИБ 20 Удаление раздела ИБ 21 Деактивация разделов каталога с подсчетов количества товаров 22 Получение полей и свойств элемента ИБ 23 Получение элементов ИБ 26 Получение элемента ИБ 28 Добавление элемента ИБ 30 Изменение элемента ИБ 31 Удаление элемента ИБ 32 Обновление аналогов товара 33 Обновление сопутствующих товаров 34 Спецификация обмена DAX - БУС 35 Таблица полей сущности Производитель 35 Таблица полей разделов каталога 36 Таблица полей элемента каталога 37 ГлоссарийБУС – Bitrix. Управления сайтом ИБ – инфоблок. Источник данных в модуле Инфоблоки в БУС. Имеет набор стандартных полей и возможность создания свойств для каждого отдельно инфоблок Техническое задание на расширения RestApi в Битрикс Управление Сайтом.Данный раздел документа касается только доработок на стороне Битрикс Управление Сайтом Общая информацияДанное техническое задание предназначено для расширения базовых возможностей системы Битрикс Управление Сайтом (БУС) по работе с RestApi. Должны быть следующие методы: Получения списка типов ИБ Получения списка ИБ Получение информации о ИБ по ID или CODE Получение полей и свойств элемента ИБ Получение полей и пользовательских полей раздела ИБ Получение разделов ИБ Получение информации о разделе ИБ по ID или CODE Получение списка элементов ИБ Получение информации о элементе ИБ по ID Добавление раздела ИБ Изменение раздела ИБ Удаление раздела ИБ Добавление элемента ИБ Изменение элемента ИБ Удаление элемента ИБ Все разработки должны быть реализованы с в виде модуля sm.iblockrest с возможностью включения/выключения методов RestApi. Все обработчики событий должны устанавливаться в момент установки модуля и удаляться в момент деинсталляции модуля. Модуль sm.iblockrestНеобходимо реализовать модуль (sm.iblockrest), который должен решить следующий задачи Дать возможность пользоваться дополнительными rest-методами Дать возможность контролировать включение/выключения работы rest-методов Создать на сайте страницы, который позволяют администратору сайта создать web-hook и выдавать scope для работы по restapi Описание Rest-методовСтруктура нейминга всех разрабатываемых методов (endpoint) подчиняется общему правилу: vendor.module.systemelement.action где, vendor – название вендора, который предоставляет api (в данном случае всегда symmetron) module – модуль системы БУС (например iblock) systemelement – объект системы, с которым нужно производить действия (например section для разделов ИБ) action – действие запроса. Могут быть следующий значения add – добавление update - изменение delete - удаление get – получение всего объекта list – получение списка объектов (не более 50 в одном запросе) field – получение всех полей и свойств объекта renew – обновление данных по уникальному id внешней учетной системы Пример: Endpoint для получения информации о разделе ИБ будет выглядеть следующим образом: symmetron.iblock.section.get Все результаты успешно выполненных запросов и все ошибки возвращаются в рамках стандартных правил RestApi Битрикса (https://dev.1c-bitrix.ru/rest_help/). Важно: При выполнении рест-методов на создание/изменение/удаление объектов системы должны срабатывать все стандартные и дополнительные (если установлены сторонние модули или зарегистрированные пользовательские) обработчики событий. |