FAQ - API Štíteknabalík.cz

Kde naleznu dokumentaci k API Štíteknabalík.cz?

Na adrese: https://apidoc.stiteknabalik.cz .

Kde zjistím identifikátor (zkratku) přepravce, přepravní služby či doplňkové služby?

Přehled všech identifikátorů naleznete na adrese https://apidoc.stiteknabalik.cz/specs .

V jakém čase probíhá údržba nebo plánované výpadky systému?

Systém je spuštěn stále, při plánovaném výpadku uživatele dopředu informujeme.

Je lepší vybrat pro autentizaci Basic Token nebo OAuth?

Pakliže nevíte, jaký je mezi těmito přístupy rozdíl, bude pro Vás určitě jednodušší zvolit Basic Token :). Pokud Vás zajímá více informací, doporučujeme spojit se s Vaším programátorem.

Notifikujete nějakým způsobeném systémy napojené na Štíteknabalík.cz o změně stavu zásilky (např. Push Notifikace)?

Nikoli, na stav zásilky je nutné se dotazovat.

Existuje způsob jak nejdříve otestovat nasazení Štíteknabalík.cz?

Jistě, je k dispozici kompletní testovací rozhraní, které je oddělené od produkční aplikace. Přístup k němu je popsán v dokumentaci (viz výše).

Jak je propojeno testovací rozhraní a produkční část?

Testovací a produkční prostředí jsou zcela oddělená a v testovací části je možné nasimulovat jakékoli úkony ve Štíteknabalík.cz, aniž by došlo k reálnému odeslání dat přepravcům.

Přenese se má registrace a nastavení z testovacího prostředí do produkčního?

Nikoli. Testovací prostředí nijak neovlivňuje produkční. Naopak data z produkce se cca jednou za měsíc naklonují do testovacího prostředí a dojde ke smazání dat původních. Pokud je tedy registrace pouze v testu a ne v produkci, bude touto migrací smazána.

Jak mohu vytvořit registraci na produkci i v testovacím prostředí ve stejný čas?

V tomto případě je nutné se registrovat do obou prostředí samostatně a zároveň pro obě získat token či OAuth2 certifikát, viz API dokumentace výše.