Перейти к содержанию

Схема запросов

Общие принципы работы API

API Liner построено на принципах REST и использует стандартные HTTP-методы и статусы ответов.

  • Все запросы выполняются по протоколу HTTPS
  • Ответы возвращаются с корректными HTTP-кодами состояния
  • Формат всех ответов — JSON, независимо от типа запроса
  • Ошибки также возвращаются в формате JSON с описанием причины

HTTP-методы

Запросы к API Лайнер выполняются с использованием стандартных HTTP-методов:

  • GET — получить список сущностей или информацию о конкретной сущности
  • POST — создать сущность
  • PUT — обновить значения сущности
  • DELETE — архивирование сущности

Ресурсы

Адрес ресурса в запросе содержит: адрес хоста, версию API, путь метода.

Примечание

v1 - актуальная версия, в которой доступны все обсновления.

Пример

https://YOUR_LINER_API_HOST/v1/health/check/

Авторизация

Все запросы должны содержать токен интеграции, передаваемый в HTTP заголовке:

X-Api-Key: <токен_интеграции>

Токен интеграции выдаётся при создании интеграции в Liner. Подробная инструкция доступна в разделе С чего начать?

Формат тела запроса

Тело запроса передается в формате JSON.

Примечание

Обязательно укажите заголовок: Content-Type: application/json.

Контент тела запроса зависит от типа операции:

  • для фильтрации — JSON-объект с фильтрами
  • для создания/обновления — JSON-объект со значениями сущности

Примечание

Если поле необязательное, но его требуется очистить, передайте одно из значений:

  • пустую строку: ""
  • null

Формат ответа

Любой вызов API-метода возвращает JSON-объект со следующей структурой и корректным HTTP-кодом ответа.

Поля ответа

  • success — статус выполнения запроса true или false
  • message — сообщение об ошибке (если success = false), иначе пустая строка
  • data — полезные данные ответа
    Например: идентификатор созданной сущности, список сущностей, результат операции и т.д.

Пример

{
  "success": true,
  "message": "",
  "data": []
}