Vklop API Vmesnika
API vmesnik je potrebno pred prvo uporabo omogočiti. To lahko stori Administrator računa in sicer v "Uredi -> Nastavitve računa -> Prikaži dodatne nastavitve -> Vklop API-ja".
Po kliku na gumb "Shrani" se v polju "Api ključ" izpiše unikatnen ključ, katerega je potrebno uporabiti pri vseh nadalnjih klicih API vmesnika.
Format podatkov
API vmesnik vse podatke vrača v UTF-8 JSON (application/json) formatu.
Overjanje uporabnika
Poleg API ključa, je pred uporabo API vmesnika potrebno pridobiti tudi avtentikacijski žeton (ang. authentication token).
V primeru uspešnega klica, API vmesnik vrne žeton, ki ga poleg API ključa uporabljate pri vseh nadalnjih klicih. Žeton (ang. token), ki ga pridobite s klicom na "api/login" metodo ima privzeto veljavnost 90 dni, ki se avtomatsko podaljša z vsakim klicem. V primeru, ko žetona ne uporabite več kot 90 dni, le ta poteče in ni več veljaven. V tem primeru je potrebno pridobiti nov žeton.
Žeton lahko razveljavimo tudi s klicem na metodo "api/logout".
Vračilo večjega števila rezultatov
Vsakemu API klicu za katerega se pričakuje večje število vrnjenih rezultatov je potrebno v parametre poizvedbe (ang. query string parameters) dodati naslednja parametra:
start: ničelni (ang. zero based) indeks, ki določi začetni položaj kurzorja.
count: število rezultatov, ki naj jih API vmesnik vrne (max. 1000) v enem klicu.
V primeru, ko parametri poizvedbe niso prisotni se upoštevajo privzete nastavitve start (0) in count (10).
Dodatni opisi napake klica
V primeru, ko API klic vrne status 400, se lahko v odogovru nahaja tudi dodaten opis razloga napake.
1001 - eden izmed elementov JSON zbirke vsebuje neveljavne podatke,
1002 - invenuta s tem imenom že obstaja,
1003 - eden izmed elemetnov JSON zbirke vključuje podatek, ki ni unikaten (npr. koda OS znotraj iste inventure.),
1004 - izvedba akcije ni mogoča, ker trenutno ni aktivne inventure,
1005 - izvedba akcije ni mogoče, ker je trenutna inventura zaklenjena