Початок роботи

Помилки

Якщо щось пішло не так, API повертає відповідний HTTP-статус і тіло з полями code та message всередині error.

У своїй програмі орієнтуйтеся на code. message — це текст англійською, який допомагає під час налагодження й може змінюватися.

Формат помилки404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

Без ключа401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Коди помилок

Статус	Код	Коли виникає
400	`key_in_query`	Ключ передано в URL-адресі (параметри `api_key`, `apikey`, `key` або `token`). Передавайте його в заголовку й створіть новий ключ, бо попередній міг залишитися в журналах.
400	`invalid_parameter`	Параметр має недійсне значення, наприклад `per_page` понад максимум.
401	`missing_api_key`	Запит не містить ключа.
401	`invalid_api_key`	Ключ не існує, його відкликано або його користувача деактивовано.
404	`not_found`	Ендпоінт не існує, або об’єкт не існує чи належить компанії, яку користувач не може бачити.
404	`organization_not_found`	Указаний `organization` не належить до компаній, у яких користувач може бачити об’єкти цього типу.
405	`method_not_allowed`	API приймає лише `GET` (і `HEAD`).
429	`rate_limited`	Ліміт запитів вичерпано. Зачекайте стільки секунд, скільки вказано в `Retry-After`.
500	`server_error`	Внутрішня помилка. Спробуйте ще раз трохи згодом; якщо помилка повторюється, зверніться до служби підтримки.

Повторювати той самий запит варто лише після 429 (зачекавши Retry-After) або 500. Інші помилки потребують виправлення запиту чи ключа.