Общая информация

Предыдущая API

Ссылка на описание предыдущей версии API: https://crm.lotinfo.ru/webMasters
Предыдущая API поддерживается, но более не обновляется. Поддержка будет осуществляться до последнего клиента.

Описание

Данное API даёт возможность добавлять, получать и изменять данные в системе LotInfo.
Задать вопросы по API можно в Telegram-канале: @lotinfodevelop

Формат выдачи

Каждое значение выводится в формате JSON:
1
"id": {
2
"fieldName": "ID в системе lotinfo",
3
"fieldType": "key",
4
"fieldMulti": "not_multi",
5
"values": [
6
{
7
"id": "12"
8
}
9
]
10
}
11
12
"cityId": {
13
"fieldName": "Город",
14
"fieldType": "key_value",
15
"fieldMulti": "not_multi",
16
"values": [
17
{
18
"value": "Москва",
19
"id": "1067"
20
}
21
]
22
}
Copied!
В поле fieldName указывается название/описание поля.
В поле fieldType указывается тип поля. Может быть "key" - указан только ключ (id), "value" - указано только значение, "key_value" - указан ключ и значения. Также могут быть кастомные типы (contact, comment и другие). У каждой базы свои кастомные поля, параметры этих полей можно посмотреть на странице нужной базы.
В поле fieldMulti указывается, сколько значений может быть у поля. Может быть "not_multi" - имеет только одно значение (как в примере выше), "multi" - имеет множество значений.
В поле values выводится одно или несколько значений.

Формат ошибок

Ошибки выводятся в следующем формате:
1
{
2
"errors": [
3
{
4
"error": 19,
5
"error_text": "У Вас нет на объекте 12001 клиента с таким id: 11.",
6
"error_field": "clientId",
7
"error_array": 0
8
},
9
{
10
"error": 14,
11
"error_text": "Только один элемент должен быть с полем lpr равным 1.",
12
"error_field": "lpr"
13
}
14
]
15
}
Copied!
В поле error указывается код ошибки.
В поле error_text указывается описание ошибки.
В поле error_field указывается поле, в котором допущена ошибка.
В поле error_array указывается номер элемента во входящем массиве данных, в котором допущена ошибка. Выводится, если на вход поступает массив данных. Начинается с 0.
Last modified 1mo ago