Основы взаимодействия с АПИ

📥 Заголовки запроса:

X-App-Token — токен, который вшивается в сборку приложения и является одинаковым для всех приложений в рамках одного клиента.

Этот заголовок (X-App-Token) обязательно должен отправляться при всех запросах. Он выполняет две ключевые роли:

1. Аутентификация — используется для проверки доступа к публичному API.
2. Идентификация клиента — позволяет определить, к какому клиенту относится запрос.

Статус-коды API

API может возвращать следующие статус-коды:

• 200 — запрос выполнен успешно и имеет возвращаемый результат.
• 204 — запрос выполнен успешно, но не имеет возвращаемого результата.
• 401 — запрос не авторизован. Требуется обновление токена доступа (access token) с использованием refresh token.
• 404 — запрашиваемый ресурс не найден (Not Found).
• 429 — слишком много запросов (Too Many Requests). Превышен лимит запросов к API.
• 500 — внутренняя ошибка сервера.

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

• При успешном выполнении запроса (статус-коды 200 или 204) возвращается целевой объект или коллекция.
• В случае ошибки (любой статус-код, кроме 200 и 204) возвращается объект следующего формата:

{
  "error": "Описание ошибки",
  "messages": [
    "Дополнительное сообщение об ошибке 1",
    "Дополнительное сообщение об ошибке 2"
  ]
}

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

{
  "error": "Недействительный токен",
  "messages": [
    "Срок действия токена истёк.",
    "Пожалуйста, обновите токен."
  ]
}