API (application programming interface) umožňuje uživatelům integrovat systém sledování s vlastními systémy, vytahovat či přesouvat data o různých entitách.
Klient dá požadavek HTTP do systému, poskytující informaci o zamýšlené akci. Obvykle používané příkazy HTTP:
- GET – Čti zdroj;
- POST – Změň stav zdroje;
Požadovaný obsah se poskytyju ve formátu JSON s kódováním UTF-8. Jestliže je použit jiný formát, je to uvedeno v popisu metody.
Stavový kód HTTP identifikuje stav požadavku – pro úspěšné požadavky se vrací kód 200. Spolu s touto odpovědí přichází ze serveru požadovaná informace. Odpovědi se liší podle typu použitého API. Odpovědi API pro různé typy API jsou popsány v příslušných oddílech.
Nastane-li chyba při odeslaném požadavku, systém vrátí zprávu se stavovým kódem. Obvyklé chybové kódy:
- Kód 400 – Chybný požadavek – nebyl rozpoznán požadavek API.
- Kód 401 – Neautorizovaný – Znamená to, že chybí ověření přihlašovacích údajů nebo jsou nesprávné;
- Kód 403 – Zakázáno – Klient nemá právo přístupu k požadovanému zdroji nebo k provedení požadované akce;
- Kód 404 – Nenalezeno – Požadovaný zdroj nebyl nalezen.
- Kód 500 – Vnitřní chyba serveru –kontaktujte technickou podporu poskytovaltele služby.
Chybové kódy poskytují obecnou informaci o typu chyby, umožňuji tak uživateli identifikovat kořen problému.
Některá API mají ve svých odpovědích volitelné elementy (parametry), volitelné parametry mohou být z různých důvodů systémem přeskočeny (žádná data, špatná data, uplynutí času pro odpověď, atd.). Nelze předpokládat, že určitá volitelná data budou vždy v odpovědi zahrnuta.
Limity API
Všechna API mají jedno omezení:
- Maximálně 1000 požadavků za minutu.
Toto omezení platí pro všechna existující API v systému sledování.
Autentizace API
Pro použití API pro různé klienty a jejich integraci s různými systémy je požadována autorizace. Pro to je nutno mít API_key.
Klienti mohou obdržet klíč API pouze od svého poskytovatele služby. Klíč API obsahuje náhodně generované písmena, číslice a symboly.
Příklad požadavku s použitím klíče API:
Jestliže klíč API expiroval, byl odstraněn nebo deaktivován, systém vrátí následující odpověď:
Koncové body API, parametry požadavků a odpovědi poskytuje “Swagger” prostřednictvím odkazu: https://api.fm-track.com
Poznámka
Ve všech typech API se vždy musí specifikovat verze API.
Důležité!
Z důvodu neustálého vývoje API i systémů ze kterých se požadují informace, mohou občas uživatelé obdržet parametry neuvedené v popisech. Doporučuje se ignorovat neznámé parametry, jež nejsou v popise jednotlivých API dokumentovány.