Darba sākšana

Kļūdas

Ja kaut kas noiet greizi, API atbild ar atbilstošu HTTP statusu un pamattekstu, kurā laukā error ir code un message.

Savā programmā izmantojiet code. message ir teksts angļu valodā, kas palīdz atkļūdošanā, un tas var mainīties.

Kļūdas formāts404

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

Nav atslēgas401

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

Kļūdu kodi

Statuss	Kods	Kad rodas
400	`key_in_query`	Atslēga tika nosūtīta URL (parametros `api_key`, `apikey`, `key` vai `token`). Sūtiet to galvenē un izveidojiet jaunu atslēgu, jo iepriekšējā var būt saglabājusies žurnālos.
400	`invalid_parameter`	Parametram ir nederīga vērtība, piemēram, `per_page` pārsniedz maksimumu.
401	`missing_api_key`	Pieprasījumā nebija atslēgas.
401	`invalid_api_key`	Atslēga neeksistē, ir atsaukta vai tās lietotājs ir deaktivizēts.
404	`not_found`	Galapunkts neeksistē, vai arī vienums neeksistē vai pieder organizācijai, kuru lietotājs nevar redzēt.
404	`organization_not_found`	Norādītais `organization` nav organizācija, kurā lietotājs var redzēt šāda veida vienumus.
405	`method_not_allowed`	API pieņem tikai `GET` (un `HEAD`).
429	`rate_limited`	Sasniegts pieprasījumu ierobežojums. Nogaidiet `Retry-After` norādīto sekunžu skaitu.
500	`server_error`	Iekšēja kļūda. Pēc brīža mēģiniet vēlreiz; ja kļūda atkārtojas, sazinieties ar atbalsta dienestu.

To pašu pieprasījumu ir vērts atkārtot tikai pēc 429 (nogaidot Retry-After) vai 500. Citu kļūdu gadījumā jālabo pieprasījums vai atslēga.