Preskočiť na obsah
ShopentlyLearn

Požiadavky a odpovede

Vyhodnocujte spoločne stav HTTP, typovaný obsah JSON a metaúdaje požiadavky.

Požiadavka

Content-Type: application/json
Zápisy v JSON posielajte s Content-Type: application/json.
data · meta
Úspešné odpovede obsahujú data a meta; odpovede so zoznamom navyše opisujú stránkovanie.
error.code · error.message
Chyby obsahujú error.code, error.message a prípadne informácie o poliach.

Dátové typy

  • Povinnosť uviesť pole a možnosť hodnoty null sú nezávislé vlastnosti.
  • Povinné pole môže platne obsahovať null, ak to jeho schéma povoľuje.
  • Zachovávajte logické hodnoty, celé čísla, reťazce a null v JSON bez prevodu typov.
  • Peňažné sumy sú desatinné reťazce; ceny nepočítajte pomocou binárnej aritmetiky s pohyblivou desatinnou čiarkou.

64-bit · expected_version

  • Niektoré verzie na riadenie súbežných zmien používajú 64-bitové celé čísla so znamienkom.
  • Klient v JavaScripte musí pri hodnotách nad Number.MAX_SAFE_INTEGER spracúvať JSON bez straty presnosti a odoslať pôvodný celočíselný zápis.
  • Verziu nezaokrúhľujte ani neprevádzajte na reťazec JSON.

Hlavičky

Cache-ControlReťazecVoliteľné

Pravidlá ukladania odpovede do vyrovnávacej pamäte.

const: "no-store"
X-Correlation-IDReťazecVoliteľné

Identifikátor na sledovanie tejto požiadavky HTTP.

WWW-AuthenticateReťazecVoliteľné

Spôsob overenia požadovaný serverom.

AllowReťazecVoliteľné

Metódy HTTP podporované týmto zdrojom.

Retry-AfterCelé čísloVoliteľné

Minimálne oneskorenie pred opakovaním v sekundách.

minimum: 0
LocationReťazecVoliteľné

Relatívna URL vytvoreného zdroja.