Webové služby DPD Verze 2015-05-05
Webové služb y DPD Verze 2015-05-05
Obsah 1
Úvod ..................................................................................................................................................3
2
Moje DPD / IT4EM ............................................................................................................................4
2.1
ShipmentService..........................................................................................................................4
2.2
ManifestService ...........................................................................................................................4
2.3
PickupOrderService ....................................................................................................................4
3
DeliCom / DPD ..................................................................................................................................5
3.1
LoginService ................................................................................................................................5
3.2
ParcelShopFinderService ...........................................................................................................6
3.3
DepotDataService ........................................................................................................................6
3.4
ParcelLifeCycleService ...............................................................................................................7
3.5
ShipmentService..........................................................................................................................8
4 4.1
Hotová řešení pro e-commerce.........................................................................................................9 Magento ........................................................................................................................................9
Webové služby DPD - verze 2015-05-05
Strana 2 / 9
Webové služb y DPD Verze 2015-05-05
1
Úvod
Tento dokument je popisem poskytovaných webových služeb DPD, které zjednodušují tvorbu zákaznických řešení. K dispozici jsou dvě sady služeb: Moje DPD / IT4EM (poskytovatelem je servisní IT organizace regionu spravující hlavní SW vybavení DPD CZ) a DeliCom / DPD (poskytovatelem je servisní IT organizace centrály DPD). Následující kapitoly popisují základní vlastnosti jednotlivých webových služeb. Zmiňované detailní specifikace a vzory naleznete na webu www.dpd.cz/dokumentace
Webové služby DPD - verze 2015-05-05
Strana 3 / 9
Webové služb y DPD Verze 2015-05-05
2 Moje DPD / IT4EM Aktivace služeb poskytovaných se děje na vyžádání. Depo DPD CZ musí webové služby aktivovat. Poskytované služby jsou: • • •
ShipmentService ManifestService PickupOrderService
Služby jsou určeny pro kompletní správu zásilek – vytvoření zásilky, případně editaci, následný tisk, objednávku svozu, správu seznamu zásilek. Je vhodná, pokud • akceptujete nutnost zásilku vytvořit a teprve v následném (samostatném) kroku její štítky tisknout • preferujete logiku vytvoření, případně editace zásilky, v DPD systému • preferujete kompletní zajištění funkcionality na straně DPD, tedy kromě správy zásilek a tisku štítků zejména i správu číselných řad, objednávku svozu, tisk seznamu zásilek Služby, jejich metody a použití jsou detailně popsány v dokumentu Příručka programátora pro integraci zákaznických řešení a DPD systémů pomocí webových služeb IT4EM. K jejich použití potřebujete uživatelské jméno a heslo, identifikaci plátce (payerId), identifikaci adresy svozu (addressId), nastavení jazyka (CZ) a parametr applicationType=9.
2.1
ShipmentService
Služba je určena pro výpočty ceny, vytvoření zásilek, tisk jejich přepravních štítků a vyhledávání. ShipmentService WSDL https://www.mojedpd.cz/IT4EMWebServices/eshop/ShipmentServiceImpl?wsdl
2.2
ManifestService
Služba je určena pro vytváření seznamu zásilek v procesu dokončení expedice zásilek ManifestService WSDL https://www.mojedpd.cz/IT4EMWebServices/eshop/ManifestServiceImpl?wsdl
2.3
PickupOrderService
Služba je určena pro objednávku svozu vytvořených zásilek PickupOrderService WSDL https://www.mojedpd.cz/IT4EMWebServices/eshop/PickupOrderServiceImpl?wsdl
Webové služby DPD - verze 2015-05-05
Strana 4 / 9
Webové služb y DPD Verze 2015-05-05
3
DeliCom / DPD
Aktivace služeb poskytovaných se děje na vyžádání. Depo DPD CZ musí poskytovatele webové služby požádat o aktivaci dané webové služby pro dané DelisID. Poskytované služby jsou: • • • • •
LoginService ParcelShopFinderService DepotDataService ParcelLifeCycleService ShipmentService
Služby LoginService, ParcelShopFinderService, DepotDataService a ParcelLifeCycleService jsou servisní služby poskytující informace (dle svého účelu). Služba ShipmentService je určena pro zjednodušení vytváření štítků a souvisejících dat, než by tomu bylo při kompletní implementaci ve vlastním softwaru. Je vhodná, pokud • akceptujete nutnost evidence, správy a unikátního přidělování číselných řad pro balíky • logiku vytvoření, případně editace zásilky, máte implementovánu ve vlastním řešení • požadujete pouze tisk štítků (a související export dat) zajištěný voláním služby Přístupy jsou vždy aktivovány do testovacího prostředí (stage system) a provozního prostředí (live system). Přístup do provozního prostředí ShipmentService je podmíněn úspěšnými testy v testovacím prostředí.
3.1
LoginService
Služba slouží k vytvoření přístupového tokenu, který je použit pro přístup k ostatním službám. K vygenerování tokenu pro stage system je použito heslo poskytnuté v potvrzení registrace. Je odlišné od standardního hesla k DelisID. K vygenerování tokenu pro live system je použito standardní DelisID heslo. Stage system LoginService URL: https://public-ws-stage.dpd.com/services/LoginService/V2_0 LoginService WSDL: https://public-ws-stage.dpd.com/services/LoginService/V2_0?wsdl Live system LoginService URL: https://public-ws.dpd.com/services/LoginService/V2_0 LoginService WSDL: https://public-ws.dpd.com/services/LoginService/V2_0?wsdl
Webové služby DPD - verze 2015-05-05
Strana 5 / 9
Webové služb y DPD Verze 2015-05-05
3.2
ParcelShopFinderService
Služba slouží k vyhledávání vyhledávání psč a měst, DPD ParcelShop podle adresy a DPD ParcelShop podle zeměpisné šířky a délky. Poskytuje menší rozsah informací než doporučený vyhledávač na ParcelShop integračním webu http://www.dpdparcelshop.cz/integrace/ Může ale poskytovat informace o jakémkoliv ParcelShop v systému DPD, nejen v CZ. Při vyhledávání ParcelShop pro použití v ShipmentService může být vhodnější z hlediska vývoje, kvůli shodnému poskytovateli služby. Stage system ParcelShopFinderService URL: https://public-ws-stage.dpd.com/services/ParcelShopFinderService/V5_0 WSDL popis pro ParcelShopFinderService: https://public-ws-stage.dpd.com/services/ParcelShopFinderService/V5_0?wsdl Live system ParcelShopFinderService URL: https://public-ws.dpd.com/services/ParcelShopFinderService/V5_0 ParcelShopFinderService WSDL: https://public-ws.dpd.com/services/ParcelShopFinderService/V5_0?wsdl
3.3
DepotDataService
Služba vyhledává adresní a kontaktní údaje depa podle čísla depa nebo PSČ Stage system DepotDataService URL: https://public-ws-stage.dpd.com/services/DepotDataService/V1_0 WSDL description pro DepotDataService : https://public-ws-stage.dpd.com/services/DepotDataService/V1_0?wsdl Live system DepotDataService: https://public-ws.dpd.com/services/DepotDataService/V1_0 DepotDataService WSDL: https://public-ws.dpd.com/services/DepotDataService/V1_0?wsdl
Webové služby DPD - verze 2015-05-05
Strana 6 / 9
Webové služb y DPD Verze 2015-05-05
3.4
ParcelLifeCycleService
Služba vyhledává údaje o životním cyklu zásilky podle čísla balíku. Umožňuje zobrazení životního cyklu balíku ve vlastním informačním systému zákazníka. Stage system ParcelLifeCycleService URL: https://public-ws-stage.dpd.com/services/ParcelLifeCycleService/V2_0 WSDL description can be found for ParcelLifeCycleService : https://public-ws-stage.dpd.com/services/ParcelLifeCycleService/V2_0?wsdl Live system ParcelLifeCycleService URL: https://public-ws.dpd.com/services/ParcelLifeCycleService/V2_0 ParcelLifeCycleService WSDL: https://public-ws.dpd.com/services/ParcelLifeCycleService/V2_0?wsdl
Webové služby DPD - verze 2015-05-05
Strana 7 / 9
Webové služb y DPD Verze 2015-05-05
3.5
ShipmentService
Služba vytváří štítky k DPD zásilkám. Výhodou proti kompletnímu vlastnímu řešení je fakt, že není nutné vyhledávat směrování, uvádět označení služeb, sestavovat čárové kódy a export dat ve formátu MPSEXPDATA Stage system ShipmentService URL: https://public-ws-stage.dpd.com/services/ShipmentService/V3_2 ShipmentService WSDL: https://public-ws-stage.dpd.com/services/ShipmentService/V3_2?wsdl Live system ShipmentService URL https://public-ws.dpd.com/services/ShipmentService/V3_2 ShipmentService WSDL: https://public-ws.dpd.com/services/ShipmentService/V3_2?wsdl Testy je možné provádět bez omezení ve „stage“ systému. Na vyžádání jsou pak požadavky na stage systém validovány. Pro úspěšně validované požadavky na stage systému jsou stejné kombinace produktů a služeb aktivovány v live systému. Při opakovaném výskytu chyb na live systému bude přístup deaktivován. Pro stage systém je poskytnuta náhodně vygenerovaná číselná řada v rámci aktivace služby. Pro live systém je poskytnuta skutečná číselná řada přiřazená DPD CZ zákazníkovi. Tyto řady musejí být evidovány v informačním systému zákazníka. V každém požadavku musí informační systém, který požadavek vznáší, přiřadit číslo z této řady. Použití každého čísla musí být unikátní. Duplicita není možná. Před vyčerpáním celé číselné řady musí systém upozornit správce systému, že číselná řada dochází, aby mohl DPD CZ požádat o přiřazení nové číselné řady. Poté, co DPD CZ požádá DeliCom o aktivaci této řady v ShipmentService, může být použita zákazníkem v požadavku služby. Odpověď na požadavek vrací base64 stream, který po dekódování tvoří PDF soubor se štítkem. Úspěšný požadavek současně zajišťuje vygenerování příslušných MPSEXPDATA.
Webové služby DPD - verze 2015-05-05
Strana 8 / 9
Webové služb y DPD Verze 2015-05-05
4 Hotová řešení pro e-commerce DPD zajišťuje vývoj modulů pro snadnou integraci DPD přepravy do e-commerce platforem. Tyto moduly, dostupné ve formě plug-in rozšíření jsou nyní dostupné pro e-shop platformy Magento a Prestashop. Další jsou v přípravě. Moduly využívají webové služby popsané v kapitole 2, proto je pro jejich funkčnost nutná aktivace těchto služeb, jako by byly využívány přímo, a tyto údaje jsou uvedeny v nastavení modulů
4.1
Magento
Rozšíření je kompatibilní s Magento CE verze 1.6 a 1.7. Před instalací doporučujeme zálohu systému Magento. K funkčnosti je nutná přítomnost PHP rozšíření mbstring a SOAP. Vzhledem k tomu, že přepravné je v DPD odvozeno od hmotnosti zásilky, musí být pro zboží definována, jinak se DPD nezobrazí v nabídce přepravy. Po instalaci rozšíření do platformy Magento je nutné • nastavit v menu System / Shipping method položky nastavení pro spojení s webovými službami DPD • nastavit v menu Sales / Shipping settings adresu odesílatele • nastavit v menu Promotions / Interactiv4 Table Rates / DPD GeoPost sazby cen přepravy • v případě využití dobírek nastavit v menu System / Configuration / Payment Method / Cash on Delivery for DPD By Interactiv4 volby dobírky jako platební metody
Webové služby DPD - verze 2015-05-05
Strana 9 / 9