Táto dokumentácia popisuje všetky metódy API pre nasledujúce akcie:

• získanie zoznamov objektov (metóda zoznamu)
• filtrovanie zoznamu (metóda zoznamu s údajmi filtra)
• získanie podrobných informácií o objekte (metóda zobrazenia)
• získanie údajov pre formulár pridania objektu (metóda pridania)
• ukladanie údajov ako nového objektu (metóda ukladania)
• získanie údajov pre formulár aktualizácie objektu (metóda úpravy)
• uloženie údajov aktualizovaného objektu (metóda aktualizácie)

Rozhranie API prijíma len požiadavky z obmedzeného zoznamu adries IP (napríklad zo stránky účtu klienta alebo stránky back office).

Akákoľvek požiadavka na rozhranie API z adresy IP, ktorá nie je na zozname povolených, bude zamietnutá.

Deje sa tak s cieľom zabrániť DDoS útokom na API, pokusom o falšovanie požiadaviek a hackerským experimentom.

Používatelia vždy pristupujú na verejnú stránku platformy (zákaznícka kancelária alebo back office) a táto stránka sama vyžaduje potrebné údaje z API platformy. Keďže adresa IP stránky je pevná, bude na zozname povolených.

Všetky požiadavky API sa uskutočňujú pomocou nasledujúcich metód HTTP:

• GET pre zoznam, zobrazenie, pridanie a úpravu
• POST pre obchod
• PUT na aktualizáciu
• DELETE na vymazanie

Každá sekcia API obsahuje URL, na ktorú sa odošle požiadavka na získanie relevantných údajov.

Metóda požiadavky HTTP je uvedená pred každou adresou URL.

Každá požiadavka API musí vždy obsahovať 4 premenné:

1. data (reťazec json s dátovým poľom pre API)
2. user (reťazec json s poľom údajov o aktuálnom používateľovi)
3. time (aktuálny čas v časovom pásme UTC)
4. hash (digitálny podpis vo forme hash na overenie, že požiadavka na API je určite z autorizovaného zdroja)

Ak je požiadavka úspešná, API vždy vráti dve premenné:

1. status = true (stav úspechu)
2. data (reťazec json s dátovým poľom z API)

Ak požiadavka zlyhá, API zobrazí premenné:

1. status = false (chybový stav)
2. error (textový reťazec popisujúci chybu)

Každá požiadavka API musí obsahovať hash premennú, ktorá je digitálnym podpisom požiadavky.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — dostupné šifrovacie algoritmy
• $json — json reťazec s údajmi požiadavky
• $time — čas vo formáte "DD.MM.RRRR HH:MM:SS"
• $salt — pevná jedinečná hodnota ("soľ") pre platformu API