Przejdź do treści
ShopentlyLearn

Żądania i odpowiedzi API

Odczytuj łącznie status HTTP, typowane dane JSON oraz metadane żądania.

Żądanie

Content-Type: application/json
Przy zapisie JSON wysyłaj Content-Type: application/json.
data · meta
Poprawne odpowiedzi zawierają data i meta; odpowiedzi list opisują dodatkowo stronicowanie.
error.code · error.message
Błędy zawierają error.code, error.message i w odpowiednich przypadkach informacje o polach.

Typy danych

  • Wymagalność i dopuszczalność null są niezależne.
  • Wymagane pole może prawidłowo zawierać null, jeśli pozwala na to schemat.
  • Zachowuj wartości logiczne, liczby całkowite, tekst i null bez konwersji typów.
  • Kwoty są tekstem dziesiętnym; nie obliczaj cen przy użyciu binarnych liczb zmiennoprzecinkowych.

64-bit · expected_version

  • Niektóre wersje do kontroli współbieżności są 64-bitowymi liczbami całkowitymi ze znakiem.
  • Klient JavaScript musi bezstratnie obsłużyć JSON z wartościami przekraczającymi Number.MAX_SAFE_INTEGER i wysłać oryginalną reprezentację liczby.
  • Nie zaokrąglaj wersji ani nie zamieniaj jej na tekst JSON.

Nagłówki

Cache-ControlTekstOpcjonalne

Zasady przechowywania odpowiedzi w pamięci podręcznej.

const: "no-store"
X-Correlation-IDTekstOpcjonalne

Identyfikator służący do prześledzenia tego żądania HTTP.

WWW-AuthenticateTekstOpcjonalne

Schemat uwierzytelniania wymagany przez serwer.

AllowTekstOpcjonalne

Metody HTTP obsługiwane przez ten zasób.

Retry-AfterLiczba całkowitaOpcjonalne

Minimalny czas przed ponowieniem, w sekundach.

minimum: 0
LocationTekstOpcjonalne

Względny adres utworzonego zasobu.