Выполнение запросов

Все запросы к API осуществляются методом POST. Для отправки запросов к API используется Endpoint полученный при создании локальной или тиражируемой интеграции.

Узнайте как получить Endpoint

Каждый запрос должен содержать обязательные Заголовки (Headers):

Название Обязательность Значение
Content-Type Обязательный application/json;charset=utf-8

При корректном выполнении метода сервер вернет ответ с кодом 200. Иные коды ответа, могут возникать при ошибке на стороне сервера.

Выходные параметры (Body):

Название Тип данных Обязательность Описание параметра
ok bool Обязательный True/False – метка успешного ответа
result Object, array of objects Обязательный Массив возвращаемых данных. Единичное значение либо массив данных

Пример успешного ответа (Object)

{
    "ok": true,
    "result": 
        {
            "new_id": 1
        }
}

Пример успешного ответа (Object) при добавлении массива данных

{
  "ok": true,
  "result": {
    "row_affected": 2,
    "ids": [
      1016537,
      1016538
    ]
  }
}

Стоит учесть, что на текущий момент массив ids возвращается только для части методов. В большинстве случаев он будет null.

Пример успешного ответа (Array of Objects)

{
    "ok": true,
    "result": 
        [
            {
                "id": 1,
                "name": "зелёный",
                "last_update": 1534151629
            }
        ]
}

Пример ответа с ошибкой

{
    "ok": false,
    "result": 
        {
            "error": 9000,
            "description": "Ошибка авторизации. Отсутствует заголовок Token"
        }
}

Полный перечень возможных ошибок