Skip to main content

Интеграции

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

  • Интеграции лучше описывать в формате таблицы и при необходимости прикладывать пример запроса и ответа

Название интеграции в документе формируется по правилу

Система источник-Система потребитель-Название метода-Порядковый номер

Шаблон:

Название интеграции

ИнициаторСистема-инициатор
Периодичность

Периодичность или триггер

Прочерк, если отсутствует

Тип интеграцииhttps, ftp, web и др
ДоступИнформация по авторизации

Параметры запроса

ПолеМассивТипОбяз.Описание
Название поляНазвание массив или объекта, в которое вложено поле

Тип поля

array

object

string

int

да/нетДополнительное описание, обычно то , на что влияет параметр запрос

Столбец массив можно удалить, если вложенность отсутствует.

Параметры ответа

(При успешном запросе)

ПолеМассивТипОбяз.ОписаниеВыход
Название поляНазвание массив или объекта, в которое вложено поле

Тип поля

array

object

string

int

да/нетДоп. описание

Указывается поле и таблица в БД

(если получаем данные, то куда должно сохраниться;

если передаем данные, то из какого поля взять)

Ошибки

Код ошибкиТекстОбработка ошибки
400, 401 и тдОтвет при ошибкеНеобязательный столбец, используется в случае необходимо обработки ошибок (создания уведомлений , вывод ошибок и др)

Пример:

ИнициаторСистема-инициатор
Периодичность

Периодичность или триггер

Прочерк, если отсутствует

Тип интеграцииhttps, ftp, web и др
ДоступИнформация по авторизации

Параметры запроса

ПолеТипОбяз.Описание
typestringДаMOB/DESK/ADAPTIVE
cityIdintegerНетИдентификатор города (код ФИАС), если есть
regionIdДаИдентификатор региона (код ФИАС)Уникальный идентификатор девайса (для неавторизованных пользователей)

Столбец массив можно удалить, если вложенность отсутствует.

Параметры ответа

ПолеМассивТипОбяз.ОписаниеВыход
data--нетОбъект
iddataintда Идентификаторmenu_footer/id
isHeaderdatabooleanда

Является ли заголовко

true/false

menu_footer/type_node
groupdataintда

Возможные значения:

- 1

- 2

- 3

- 4

menu_footer/node_group
namedatastringдаНазвание узлаmenu_footer/name_ru
codedatastringдаКод узлаmenu_footer/code
typedatastringда

Тип начертания

CLASSIС

ITALICS

BOLD

menu_footer/font_custom
urldatastringнетСсылкаmenu_footer/url
imageUrldatastringнетИконка узлаmenu_footer/image

Ошибки

Код ошибкиТекст
401

Unauthorized

{

"errors": [

{

"code": "string",

"message": "string",

"meta": {}

}

],

"meta": {}

}