Начало работы

Ошибки

Если что-то пошло не так, 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. Остальные ошибки требуют исправить запрос или ключ.