...
API jest interfejsem stateless.
Kody odpowiedzi HTTP
Kody odpowiedzi HTTP, które mogą wystąpić w odpowiedzi od serwera:
| Kod HTTP | Opis |
|---|---|
200 OK | Odpowiedź prawidłowa. |
201 CREATED | Zasób został utworzony. |
204 NO CONTENT | Odpowiedź prawidłowa, żadna wartość nie została zwrócona. Spotykane np. podczas usuwania zasobów. |
400 BAD REQUEST | Dane przesłane metodą POST lub PUT są niepoprawne. W odpowiedzi z serwera znajduje się więcej szczegółów. |
401 UNAUTHORIZED | Dostęp do zasobu wymaga autoryzacji. |
403 FORBIDDEN | Brak lub zestaw uprawnień jest niewystarczający aby uzyskać dostęp do określonego zasobu. |
404 NOT FOUND | Zasób nie został odnaleziony. |
500 SERVER ERROR | Wystąpił błąd po stronie serwera. |
Błędy
W przypadku wystąpienia błędu, API zwraca obiekt błędu, który zawiera następujące atrybuty:
...
Kluczami obiektu details są nazwy atrybutów przesłanych metodą POST lub PUT, dla których wystąpiły błędy walidacji. Natomiast ich wartości to tablica kluczy błędów, które są prawdziwe dla przesłanej wartości. Poniżej opisana jest lista generycznych kluczy błędów walidacji.
Klucze błędów
Poniższa tabela przedstawia klucze błędów, które mogą zostać zwrócone przez serwer, wraz z możliwymi kodami HTTP:
| Klucz błędu | Kod HTTP | Opis |
|---|---|---|
resource_not_found | 404 | Szukany zasób nie został odnaleziony, np. adres URL jest niepoprawny lub zasób nie istnieje. |
validation_failed | 400 | Przy przesyłaniu danych metodą POST lub PUT wystąpiły błędy w walidacji. Szczegółowe błędy walidacji zawarte są pod atrybutem details. |
unauthorized | 401 | Dostęp do zasobu jest niemożliwy ponieważ zapytanie nie zostało podpisane kluczem access token. |
access_forbidden | 403 | Dostęp do określone zasobu jest zabroniony dla tego zapytania (np. z powodu braku lub niewłaściwego zakresu uprawnień). |
Klucze błędów walidacji
Poniższa tabela przedstawia generyczne klucze błędów walidacji, które zwracane są pod atrybutem details dla odpowiedzi błędu validation_failed:
...