Obecné

Webová služba Create package label (dále jen CPL, může být zmiňována i jako CPL2) je určená pro zákazníky a partnery společnosti PPL CZ s.r.o. (dále jen PPL), kteří prostřednictvím této služby mají potřebu obousměrně přenášet data mezi svým informačním systémem a informačním systémem společnosti PPL.
Integrace CPL API do podnikových procesů přispívá ke zjednodušení logistických operací, snižuje administrativní zátěž a zlepšuje celkovou uživatelskou zkušenost jak pro odesílatele, tak i pro koncové zákazníky.

CPL je přístupné přes internet pomocí zabezpečeného protokolu.

Poskytuje sadu metod umožňujících výměnu údajů o zásilkách, stavech zásilek, objednávkách svozu.
Dále poskytuje vždy aktualizovaný seznam Parcelshopů, velké množství číselníků.

Projekt CPL se neustále rozvíjí a soubor metod se doplňuje o další nové služby. Z tohoto důvodu je při provádění nezbytné sledovat nejaktuálnější verzi této dokumentace, případně si kontrolovat novinky prostřednictvím metody v CPL.

V počátku doporučujeme navštívit stránky jak začít, které Vás mohou navést správným směrem

Jedná se o asynchronní REST API

K jeho používání budete potřebovat splnit následující podmínky.

Přistupovat pouze přes zabezpečený protokol HTTPS.

Autentizovat se pomocí HTTP Bearer autentizace.

Pro získání přístupů pro hotová / schválená řešení je potřeba kontaktovat svého obchodního zástupce.

V případě zájmu stát se tzv. schváleným integrátorem, prosím kontaktujte ithelp@ppl.cz

Omezení

Maximální počet zásilek na request: 1 000

Maximální počet kusů balíků na adresu: 20 v requestu

Platnost batchID k vyzvednutí etikety je maximálně 30 dnů

Maximální počet požadavků pro vygenerovaní tokenů je 12 požadavků/min

Minimální interval mezi odesláním dvou po sobě jdoucích požadavků je 40 ms

Etikety

Minimální rozměr etiket je v případě, že zákazník tiskne na samostatné etikety (např. Termoetikety):
• V případě posílání do CZ 127×110 mm.
• V případě posílání do zahraničí 150×100 mm.
(viz číselník produktů a zemí)
Alternativou jsou zásilky tisknuté na A4 (4 etikety na stránku).

Napojení

Napojení/Autentizace probíhá ve standardu OAuth 2.0 viz https://cs.wikipedia.org/wiki/OAuth nebo https://oauth.net/2/

Swagger: (GET) https://api.dhl.com/ecs/ppl/myapi2/swagger/v1/swagger.json

Platnost generovaného tokenu je 30 min - vždy využít celou platnost, negenerovat pro každý request nový token

Access token URL: https://api.dhl.com/ecs/ppl/myapi2/login/getAccessToken
Grand type: Client credentials
ClientID: individuální
Client secret: individuální
Scope: myapi2

Produkční prostředí: https://api.dhl.com/ecs/ppl/myapi2
Testovací prostředí: https://api-dev.dhl.com/ecs/ppl/myapi2

Vývoj a testování

Pro vývoj a testování Vám poskytneme přístup do testovacího prostředí. Jde o separátní prostředí s oddělenou databází, ve kterém nedochází k reálnému objednávání přepravy, avšak chová se stejně jako produkční. Pouze odezvy na testovacím prostředí mohou být pomalejší než následně na produkci

Sandbox

Sandbox je další testovací prostředí, které vývojářům a integrátorům umožňuje bezpečně a bezrizikově vyvíjet, testovat a ladit propojení s CPL API. V sandboxu lze ověřit funkčnost generování štítků, načítání informací o zásilkách a další integrační kroky, aniž by došlo k reálnému vytvoření a odbavení zásilky. Tento přístup usnadňuje odhalování a odstranění chyb ještě před nasazením do ostrého provozu.
Do Sandboxu se přihlašujete přes https://sandbox.ppl.cz/ a přístup vám přidělí podpora společně hlavními přístupovými údaji. Po přihlášení do Sandboxu proběhne automaticky autentizace pomocí bearer tokenu. Není tedy potřeba při volání jednotlivých metod autentizovat. Po vypršení platnosti tokenu je potřeba stránku aktualizovat, aby se načetl nový token.

Omezení#

Etikety#

Napojení#

Vývoj a testování#

Sandbox#

Omezení

Etikety

Napojení

Vývoj a testování

Sandbox