Общие правила и ограничения

Для работы с api в личном кабинете вам необходимо получить данные для авторизации. Все запросы отправляются только по HTTPS протоколу в кодировке: application/x-www-form-urlencoded Каждый запрос должен содержать заголовок: Authorization: <token> В случае отсутствия или в случае некорректного заголовка, в ответ на запрос будет возвращаться ошибка с кодом 401:

{
  error: {
    statusCode: 401,
    name: "Error",
    message: "Access denied"
  }
}

Ограничения: 100 запросов в 15 минут. В случае превышения лимита в указанный промежуток времени, все последующие запросы будут возвращаться с кодом ошибки 429.

{
  error: {
    statusCode: 429,
    name: "Error",
    message: "Too Many Requests",
    expireDate: "2022-12-13T09:02:13.953Z"
  }
}

При многократном превышении данного ограничения, доступ к api временно блокируется для всей компании и на любые запросы будет возвращаться ошибка 403. Разблокировка произойдет автоматически после даты указанной в поле expireDate.

{
  error: {
    statusCode: 403,
    name: "Error",
    message: "Forbidden. Try again later",
    expireDate: "2022-12-13T10:02:13.953Z"
}

В случае если вы получаете ошибку без поля expireDate, это значит что доступ к api был польностью заблокирован и для разблокировки необходимо обратиться в техподдержку.

{
  error: {
    statusCode: 403,
    name: "Error",
    message: "Forbidden"
}

В поле remainRequest приходит количество запросов оставшихся до блокировки.

В поле expireDate приходит время в которое произойдет обновление ограничений.

Все ответы приходят в JSON формате.

Для работы с API необходимы иметь навыки программирования и понимание базовых принципов работы Интернета и протокола HTTPS. Уметь отправлять и обрабатывать HTTPS запросы, в том числе уметь обрабатывать данные в формате JSON. Если вы не обладаете такими навыками, обратитесь к разработчику или вебмастеру.