Kedr.Cloud API

Kedr.Cloud API представляет собой HTTP-сервис для интеграции со сторонними системами

API работает в режиме сервера

Обмен данными осуществляется посредством GET- и POST-запросов. Данные передаются в формате JSON. Некоторые функции API могут вызываться любым запросом на усмотрение пользователя

Для исключения несанкционированного доступа к данным в каждом запросе должен передаваться параметр apiKey, который генерируется в личном кабинете в разделе Настройки  ->  Интеграция по API . Он представляет собой параметр формата GUID

apiKey может передаваться двумя способами:

  • как параметр URL (?apiKey=<значение_ключа>)
  • в качестве заголовка (apiKey=<значение_ключа>)

В ответ на любой запрос возвращается поле result, содержащее флаг успешного выполнения

Если запрос был выполнен с ошибкой, то в дополнительном поле error будет приведено её текстовое описание


{
  "result": false,
  "error": "Invalid apiKey"
}

Доступны две версии API. Они работают параллельно.

Описание API v.1

Описание API v.2