Po navázání spojení a autorizaci už probíhá veškerá komunikace formou dotazů s metodou POST a parametry předávané, stejně jako ty získávané, jsou ve formátu JSON.
| Hlavička | Hodnota |
|---|---|
| Content-Type | application/json;charset=UTF-8 |
| Authorization | ShortTimeToken získaný pomocí: POST v1/Authorize/GetShortTimeToken |
S každým dotazem je také vhodné odesílat aktuální čas v UTC. A to v proměnné TimeStamp. Formát tohoto času, stejně jako veškerých proměnných s časem, je Unix Time Stamp.
| Název proměnné | Příklad hodnoty |
|---|---|
| TimeStamp | 1769346743 |
V brzké době může dojít k validaci této hodnoty, proto je vhodné ji nejen zadávat, ale zadávat ji také správně vyplněnou (konstantní hodnota např. není příliš vhodná).
Pro zahájení dotazů přímo na funkce API je nutné ještě získat ShortTimeToken (dále jen STT). Tento token se generuje vždy na krátký časový interval (např. 30 minut) a musí být vždy přítomen v hlavičce při volání funkcí API.
STT lze získat pomocí akce: POST v1/Authorize/GetShortTimeToken
Server vždy odpovídá daty ve formátu JSON.
| Název proměnné | Příklad hodnoty | Popis |
|---|---|---|
| IsError | true | Indikuje, zda vznikla chyba. |
| ErrorParameter | CustomerId | Případný chybně zadaný parametr v požadavku. |
| ErrorMessage | Hledaný zákazník neexistuje! | Chybová hláška doplňující chybu (např. pro debug). |
| ErrorParameters | ["CustomerId"] | Pole chybně zadaných parametrů. Pokud je chybný jen 1 parametr, tak je tu jen 1. |
| ErrorMessages | ["Hledaný zákazník neexistuje!"] | Pole chybových hlášek. Pokud vznikla jen 1 chyba, tak je tu jen 1 chybová hláška. |
Podle určité akce odpověď potom obsahuje ještě další proměnné s daty (v případě chyby většinou výchozí hodnoty).
| Stavový kód | Popis | Vysvětlení |
|---|---|---|
| 200 | OK | Dotaz proběhl v pořádku, na výstupu je odpověď. |
| 400 | Bad Request | Klient se pravděpodobně pokouší použít nezabezpečené spojení. Je třeba přejít na adresu začínající https://. |
| 401 | Unauthorized | Klient není autorizovaný pomocí STT, nebo už vypršel. Je nutné nechat znovu vygenerovat STT podle kapitoly Získání ShortTimeToken. |
| 403 | Forbidden | Klient se současnými právy nemá přístup k dané funkci. Nová oprávnění je třeba si nechat znovu odsouhlasit obchodníkem. |
| 404 | Not Found | Na dané adrese se nenachází žádná funkce Reservanto API. |
| 415 | Unsupported Media Type | Daný typ obsahu (hlavička "Content-Type") Reservanto API nepodporuje. |
| 500 | Internal Server Error | Error Na serveru vznikla chyba (vývojáři Reservanta se to dozvědí, nicméně můžete pomoci chybu odladit, pokud předáte další informace o jejím vzniku např. na podpora@reservanto.cz). |