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

Предыдущая API

Ссылка на описание предыдущей версии API: https://crm.lotinfo.ru/webMasters​

Предыдущая API поддерживается, но более не обновляется. Поддержка будет осуществляться до последнего клиента.

Описание

Данное API даёт возможность добавлять, получать и изменять данные в системе LotInfo.

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

Каждое значение выводится в следующем формате:

"id": {
  "fieldName": "ID в системе lotinfo",
  "fieldType": "key",
  "fieldMulti": "not_multi",
  "values": [
    {
      "id": "12"
    }
  ]
}
​
"cityId": {
  "fieldName": "Город",
  "fieldType": "key_value",
  "fieldMulti": "not_multi",
  "values": [
    {
      "value": "Москва",
      "id": "1067"
    }
  ]
}

В поле fieldName указывается название/описание поля.

В поле fieldType указывается тип поля. Может быть "key" - указан только ключ (id), "value" - указано только значение, "key_value" - указан ключ и значения. Также могут быть кастомные типы (contact, comment и другие). У каждой базы свои кастомные поля, параметры этих полей можно посмотреть на странице нужной базы.

В поле fieldMulti указывается, сколько значений может быть у поля. Может быть "not_multi" - имеет только одно значение (как в примере выше), "multi" - имеет множество значений.

В поле values выводится одно или несколько значений.

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

Ошибки выводятся в следующем формате:

{
  "errors": [
    {
      "error": 19,
      "error_text": "У Вас нет на объекте 12001 клиента с таким id: 11.",
      "error_field": "clientId",
      "error_array": 0
    },
    {
      "error": 14,
      "error_text": "Только один элемент должен быть с полем lpr равным 1.",
      "error_field": "lpr"
    }
  ]
}

В поле error указывается код ошибки.

В поле error_text указывается описание ошибки.

В поле error_field указывается поле, в котором допущена ошибка.

В поле error_array указывается номер элемента во входящем массиве данных, в котором допущена ошибка. Выводится, если на вход поступает массив данных. Начинается с 0.