Интеграция
Шаблон включает в себя требования к описанию новой/обновляемой интеграции.
Заголовок: Название интеграции в документе формируется по правилу
Система источник-Система потребитель-Название метода-Порядковый номер
Шаблон:
Название интеграции
| Инициатор | Система-инициатор |
|---|---|
| Периодичность | Периодичность или триггер Прочерк, если отсутствует |
| Тип интеграции | https, ftp, web и др |
| Доступ | Информация по авторизации |
Параметры запроса
| Поле | Массив | Тип | Обяз. | Описание |
|---|---|---|---|---|
| Название поля | Название массив или объекта, в которое вложено поле | Тип поля array object string int | да/нет | Дополнительное описание, обычно то , на что влияет параметр запрос |
Столбец массив можно удалить, если вложенность отсутствует.
Параметры ответа
(При успешном запросе)
| Поле | Массив | Тип | Обяз. | Описание | Выход |
|---|---|---|---|---|---|
| Название поля | Название массив или объекта, в которое вложено поле | Тип поля array object string int | да/нет | Доп. описание | Указывается поле и таблица в БД (если получаем данные, то куда должно сохраниться; если передаем данные, то из какого поля взять) |
Ошибки
| Код ошибки | Текст | Обработка ошибки |
|---|---|---|
| 400, 401 и тд | Ответ при ошибке | Необязательный столбец, используется в случае необходимо обработки ошибок (создания уведомлений , вывод ошибок и др) |
Пример:
| Инициатор | Система-инициатор |
|---|---|
| Периодичность | Периодичность или триггер Прочерк, если отсутствует |
| Тип интеграции | https, ftp, web и др |
| Доступ | Информация по авторизации |
Параметры запроса
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
| type | string | Да | MOB/DESK/ADAPTIVE |
| cityId | integer | Нет | Идентификатор города (код ФИАС), если есть |
| regionId | Да | Идентификатор региона (код ФИАС) | Уникальный идентификатор девайса (для неавторизованных пользователей) |
Столбец массив можно удалить, если вложенность отсутствует.
Параметры ответа
| Поле | Массив | Тип | Обяз. | Описание | Выход |
|---|---|---|---|---|---|
| data | - | - | нет | Объект | |
| id | data | int | да | Идентификатор | menu_footer/id |
| isHeader | data | boolean | да | Является ли заголовко true/false | menu_footer/type_node |
| group | data | int | да | Возможные значения: - 1 - 2 - 3 - 4 | menu_footer/node_group |
| name | data | string | да | Название узла | menu_footer/name_ru |
| code | data | string | да | Код узла | menu_footer/code |
| type | data | string | да | Тип начертания CLASSIС ITALICS BOLD | menu_footer/font_custom |
| url | data | string | нет | Ссылка | menu_footer/url |
| imageUrl | data | string | нет | Иконка узла | menu_footer/image |
Ошибки
| Код ошибки | Текст |
|---|---|
| 401 | Unauthorized {
} |
| 403 | Forbidden {
} |
| 404 | Not Found {
} |
| 500 | Internal Server Error {
} |