Pierwsze kroki

Błędy

Gdy coś pójdzie nie tak, API odpowiada odpowiednim kodem statusu HTTP i treścią z polami code i message wewnątrz error.

W swoim programie korzystaj z code. Pole message to tekst w języku angielskim, który ma pomóc przy debugowaniu, i może się zmienić.

Format błędu404

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

Brak klucza401

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

Kody błędów

Status	Kod	Kiedy występuje
400	`key_in_query`	Klucz został wysłany w adresie (parametry `api_key`, `apikey`, `key` lub `token`). Wysyłaj go w nagłówku i wygeneruj nowy klucz, ponieważ poprzedni mógł zostać zapisany w logach.
400	`invalid_parameter`	Parametr ma nieprawidłową wartość, np. `per_page` powyżej maksimum.
401	`missing_api_key`	Żądanie nie zawierało klucza.
401	`invalid_api_key`	Klucz nie istnieje, został unieważniony lub jego użytkownik jest dezaktywowany.
404	`not_found`	Endpoint nie istnieje albo element nie istnieje lub należy do organizacji, której użytkownik nie może widzieć.
404	`organization_not_found`	Podany parametr `organization` nie wskazuje organizacji, w której użytkownik może widzieć ten typ elementów.
405	`method_not_allowed`	API akceptuje tylko `GET` (i `HEAD`).
429	`rate_limited`	Osiągnięto limit żądań. Odczekaj liczbę sekund podaną w `Retry-After`.
500	`server_error`	Błąd wewnętrzny. Spróbuj ponownie za chwilę; jeśli problem się powtarza, skontaktuj się z pomocą techniczną.

Kiedy ponowić próbę

To samo żądanie warto powtórzyć tylko po błędzie 429 (po odczekaniu czasu z Retry-After) lub 500. Pozostałe błędy wymagają poprawienia żądania lub klucza.