API (Aplikačné programovacie rozhranie) umožňuje používateľom integrovať systém sledovania s vlastnými systémami, vyťahovať či presúvať dáta o rôznych entitách.
Klient dá požiadavku HTTP do systému, poskytujúce informáciu o zamýšľanej akcii. Obvykle používané príkazy HTTP:
- GET – Čítaj zdroj;
- POST – Zmeň stav zdroje;
Požadovaný obsah sa poskytuje vo formáte JSON s kódovaním UTF-8. Ak je použitý iný formát, je to uvedené v popise metódy.
Stavový kód HTTP identifikuje stav požiadavke – pre úspešné požiadavky sa vracia kód 200. Spolu s touto odpoveďou prichádza zo servera požadované informácie. Odpovede sa líši podľa typu použitého API. Odpovede API pre rôzne typy API sú popísané v príslušných oddieloch.
Ak nastane chyba pri odoslanom požiadavke, systém vráti správu s kódom stavu. Obvyklé chybové kódy:
- Kód 400 – Nesprávna požiadavka – nebol rozpoznaný požiadavka API.
- Kód 401 – Neautorizovaný – Znamená to, že chýba overenie prihlasovacích údajov alebo sú nesprávne;
- Kód 403 – Zakázané – Klient nemá právo prístupu k požadovanému zdroju alebo na vykonanie požadovanej akcie;
- Kód 404 – Nenájdené – Požadovaný zdroj nebol nájdený.
- Kód 500 – Vnútorná chyba servera -kontaktujte technickú podporu poskytovaleľa služby.
Chybové kódy poskytujú všeobecnú informáciu o type chyby, umožňujú tak užívateľovi identifikovať koreň problému.
Niektoré API majú vo svojich odpovediach voliteľné elementy (parametre), voliteľné parametre môžu byť z rôznych dôvodov systémom preskočia (žiadne dáta, zlé dáta, uplynutí času na odpoveď, atď.). Nemožno predpokladať, že určitá voliteľná dáta budú vždy v odpovedi zahrnutá.
Limity API
Všetky API majú jedno obmedzenie:
- Maximálne 1000 požiadaviek za minútu.
Toto obmedzenie platí pre všetky existujúce API v systéme sledovania.
Autentizácia API
Na použitie API pre rôzne klientov a ich integráciu s rôznymi systémami je požadovaná autorizácia. Pre to je nutné mať API_key.
Klienti môžu získať kľúč API iba od svojho poskytovateľa služby. Kľúč API obsahuje náhodne generované písmená, číslice a symboly.
Príklad požiadavke s použitím kľúča API:
Ak kľúč API expiroval, bol odstránený alebo deaktivovaný, systém vráti nasledujúce odpoveď:
Koncové body API, parametre požiadaviek a odpovede poskytuje “Swagger” prostredníctvom odkazu: https://api.fm-track.com
Poznámka
Vo všetkých typoch API sa vždy musí špecifikovať verzia API.
Dôležité!
Z dôvodu neustáleho vývoja API aj systémov z ktorých sa vyžadujú informácie, môžu občas užívatelia obdržať parametre neuvedené v popisoch. Odporúča sa ignorovať neznáme parametre, ktoré nie sú v popise jednotlivých API dokumentované.