Tato dokumentace popisuje všechny metody API pro následující akce:
Rozhraní API přijímá požadavky pouze z omezeného seznamu IP adres (například z webu klienta nebo webu back office).
Jakýkoli požadavek na rozhraní API z adresy IP, která není na seznamu povolených, bude zamítnut.
To se provádí, aby se zabránilo DDoS útokům na API, pokusům o falšování požadavků a hackerským experimentům.
Uživatelé vždy přistupují na veřejnou stránku platformy (kancelář zákazníka nebo back office) a tato stránka sama vyžaduje potřebná data z API platformy. Protože je IP adresa webu pevná, bude na seznamu povolených.
Všechny požadavky API se provádějí pomocí následujících metod HTTP:
Každá sekce API obsahuje URL, na kterou je zasílán požadavek na získání příslušných dat.
Před každou adresou URL je uvedena metoda požadavku HTTP.
Každý požadavek API musí vždy obsahovat 4 proměnné:
Pokud je požadavek úspěšný, API vždy vrátí dvě proměnné:
Pokud požadavek selže, API zobrazí proměnné:
Každý požadavek API musí obsahovat hash proměnnou, která je digitálním podpisem požadavku.
hash = md5($json . $time . $salt)