İlk addımlar

Xətalar

Nəsə səhv getdikdə API müvafiq HTTP status kodu və error daxilində code və message olan gövdə ilə cavab verir.

Proqramınızda code dəyərindən istifadə edin. message sazlama aparan şəxsə kömək etmək üçün ingilis dilində yazılmış mətndir və dəyişə bilər.

Xətanın formatı404
{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}
Açar yoxdur401
{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Xəta kodları

Status Kod Nə zaman baş verir
400 key_in_query Açar URL-də göndərilib (api_key, apikey, key və ya token parametrləri). Açarı başlıqda göndərin və yeni açar yaradın, çünki əvvəlki açar loglarda qeydə alınmış ola bilər.
400 invalid_parameter Parametrin dəyəri yanlışdır, məsələn, per_page maksimumdan böyükdür.
401 missing_api_key Sorğuda açar yoxdur.
401 invalid_api_key Açar mövcud deyil, etibarsız edilib və ya onun istifadəçisi deaktiv edilib.
404 not_found Endpoint mövcud deyil, ya da element mövcud deyil və ya istifadəçinin görə bilmədiyi şirkətə aiddir.
404 organization_not_found Göstərilən organization istifadəçinin bu növ elementləri görə bildiyi şirkətə aid deyil.
405 method_not_allowed API yalnız GET (və HEAD) metodunu qəbul edir.
429 rate_limited Sorğu limitinə çatılıb. Retry-After başlığında göstərilən saniyə qədər gözləyin.
500 server_error Daxili xəta. Bir azdan yenidən cəhd edin; problem davam edərsə, dəstək xidməti ilə əlaqə saxlayın.

Nə vaxt yenidən cəhd etməli

Eyni sorğunu yalnız 429 (Retry-After müddətini gözlədikdən sonra) və ya 500 xətasından sonra təkrarlamaq olar. Digər xətalar sorğuda və ya açarda düzəliş tələb edir.