Първи стъпки
Грешки
Когато нещо се обърка, 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 |
Ключът е изпратен в адреса (параметри 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. Другите грешки изискват корекция в заявката или в ключа.