Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API jest interfejsem stateless.

Kody odpowiedzi HTTP

Kody odpowiedzi HTTP, które mogą wystąpić w odpowiedzi od serwera:

Kod HTTPOpis
200 OKOdpowiedź prawidłowa.
201 CREATEDZasób został utworzony.
204 NO CONTENTOdpowiedź prawidłowa, żadna wartość nie została zwrócona. Spotykane np. podczas usuwania zasobów.
400 BAD REQUESTDane przesłane metodą POST lub PUT są niepoprawne. W odpowiedzi z serwera znajduje się więcej szczegółów.
401 UNAUTHORIZEDDostęp do zasobu wymaga autoryzacji.
403 FORBIDDENBrak lub zestaw uprawnień jest niewystarczający aby uzyskać dostęp do określonego zasobu.
404 NOT FOUNDZasób nie został odnaleziony.
500 SERVER ERRORWystą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:

...

(warning) 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łęduKod HTTPOpis
resource_not_found404Szukany zasób nie został odnaleziony, np. adres URL jest niepoprawny lub zasób nie istnieje.
validation_failed400Przy przesyłaniu danych metodą POST lub PUT wystąpiły błędy w walidacji. Szczegółowe błędy walidacji zawarte są pod atrybutem details.
unauthorized401Dostęp do zasobu jest niemożliwy ponieważ zapytanie nie zostało podpisane kluczem access token.
access_forbidden403Dostę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:

...