Developer API

Modul Developer API umožňuje získat z databáze aplikace vybrané souhrnné informace ve standardizovaném formátu pro další použití. Poskytuje seznam dostupných metod pro vzdálený přístup k datům aplikace. Exportovaná data nejsou zobrazována přímo v aplikaci, ale jsou generována a vrácena webovou službou, jejíž popis a parametry se zobrazí po volbě požadovaného exportu, taková data je tedy později možné využít v libovolné jiné klientské aplikaci nezávisle na Knize jízd, případně z dat můžete vytvořit vlastní grafický výstup.

Pokud v hlavním menu nevidíte odkaz na modul Developer API, kontaktujte prosím Provozovatele, protože přístup k této funkci je pouze na vyžádání a může ji povolit pouze superadministrátor aplikace.

Zvolte si požadovaný export a po kliknutí na něj se zobrazí stránka se stručným popisem vybraného exportu, podrobnostmi o všech vstupních a výstupních parametrech a volbách, které je nutné webové službě předat. Stránka s detailem exportu je popsána na následujícím obrázku:

V části Export (1) se zobrazuje název a stručný popis vybraného exportu. V části Informace k použití naleznete všechny potřebné informace pro získání požadovaných dat. V prvé řadě potřebujete znát internetovou adresu (2), kde je služba pro export spuštěna, ta je vždy ve formátu

https://app.sherlogtrace.cz/ssl/Export.asmx

Dále je třeba službě předat přihlašovací údaje uživatele, který má přístup k požadovaným exportovaným záznamům, jazyk pro výsledná data a identifikátor, požadované parametry pro export jsou popsány v prostřední části stránky (3).

V dalším odstavci (4) jsou vypsány všechny názvy parametrů specifické pro vybraný export, které musíte webové službě předat pro získání dat v poli paramKeys. Jejich hodnoty musí být předány v poli paramValues ve stejném pořadí, v jakém byly zadány v poli názvů.

V posledním odstavci (5) jsou vypsány názvy a typy výstupních parametrů a hodnot pro vybraný export, které webová služba vrací při úspěšném volání.

Pokud byly zadány všechny požadované údaje ve správném formátu a platné uživatelské jméno a heslo s dostatečným oprávněním, vrátí webová služba požadované záznamy v tzv. DataSetu pro další zpracování.

Poznámka
Volání exportů pro jednotku a export je většinou limitované na 1 volání za 5 minut. U méně náročnějších exportů jako je poslední pozice vozidla je limit nastaven na 1 volání za 2 minuty. Limit je uveden v popisu reportu. Není-li tento limit dodržen, webová služba vrátí informaci o překročení počtu povolených volání.

Pokud zadá uživatel nesprávné přístupové údaje, webová služba vrátí informaci o chybě.

Pozor
V případě, že bude docházet k opakovanému volání služby pro generování exportů s přihlašovacími údaji uživatele příliš často (např. služba bude vracet chybový stav, proto bude volání opakováno) a bude dosaženo limitu počtu volání služby pro dané přihlašovací údaje (limit 25 volání služby do 30 sekund), tak bude účet uživatele zablokován, aby se předešlo dalšímu opakovanému volání. Po odblokování účtu uživatele v aplikaci je možné znovu dotazy s těmito přihlašovacími údaji provádět, do doby, než bude případně opět překročen limit volání.