Dokumentace API

Integrační příručka pro vývojářské borce

Dokumentace

Úvod do API.
Důležité informace pro práci s API.
Formáty komunikace, produkční a testovací prostředí a autentizace.

API metody

Popis REST API metod a endpointů pro vytváření a editaci zásilek. Tisk štítků, získávání informací o stavech. Příklady requestů a responzí.

Přepravci a číselníky

Značení a specifikace přepravců, přepravních a doplňkových služeb. Terminologie a přehled všech identifikátorů využívaných ve Štíteknabalík.cz API a při importu CSV.

Nejčastější dotazy

Seznam dotazů a odpovědí, na které se zákazníci nejčastějí ptají. Doporučujeme přečíst před samotnou integrací API Štíteknabalík.cz.

Víte, že...

API Štíteknabalík.cz sjednocuje všechny přepravce do jediného systému?
Stačí Vám jedna integrace a díky číselníkům získáte celou škálu přepravců a jejich přepravních i doplňkových služeb!
Proč integrovat několik systémů, když Vám stačí jen jeden?

Log změn

Změny jsou seřazeny od nejnovějších po nejštarší

2022-04-21

Podpora platformKey

Do metody deliveries/POST jsme přidali parametr platformKey pro lepší identifikaci poskytovatele API napojení. platformKey se týká pouze vývojářů doplňků, CMS a WMS systémů.

2022-04-20

Vylepšení svozových protokolů

Do metody collection-protocols/POST jsme přidali možnost vyžádat si protokol pouze pro konskrétní zásilky.

2022-04-19

APIdoc jsme rozšířili o angličtinu

V dokumentaci si nyní mohou počíst i Vaši anglicky hovořící kolegové. Přepínání jazyků je umístěno na pravé straně v horní navigaci.

Starší logy naleznete v této sekci.

Nemáte zaregistrované API?

OAuth API přístup můžete získat po registraci OAuth klienta.
Nebo si můžete vygenerovat basic token v nastavení Štíteknabalík.cz.

Zaregistrovat OAuth přístup