Jak získat přístupové údaje k PPL, které potřebuje rozšíření SemaShipping PPL for VirtueMart.
Přístupové údaje k PPL
Co si u PPL vyžádat a jak o to požádat
Potřebujete dvoje údaje, ne jedny
PPL vydává dvě různé věci a žádá se o ně zvlášť. Rozšíření potřebuje obojí:
1. Client ID a Client Secret pro CPL API (myAPI2) — přes ně rozšíření zakládá zásilky, stahuje štítky a ruší zásilky. Client ID vypadá například jako AB1234567, Client Secret je dlouhý náhodný řetězec.
2. Klíč mapového widgetu ve tvaru ak_… — přes něj se zákazníkovi v košíku otevře mapa výdejních míst. S Client ID nemá nic společného a je vázaný na doménu: klíč vydaný pro jeden e-shop na jiném webu nefunguje.
Bez prvního nevzniknou zásilky, bez druhého si zákazník nevybere výdejní místo. Pokud doručujete jen na adresu, vystačíte si s prvním.
Kde o ně požádat
O obojí požádejte svého obchodního zástupce PPL, nebo zákaznickou podporu PPL, pod kterou spadá vaše zákaznické číslo. Přístupy vydává PPL přímo vám — jsou vázané na vaše zákaznické ID a my se k nim nedostaneme.
V žádosti uveďte, že jde o napojení přes schválené řešení integrátora Semakin.cz (integrátorské ID 4801974). PPL tenhle model zná a žádost pak nemusí nikam putovat.
Co PPL potřebuje vědět
- vaše zákaznické ID u PPL
- IČO a název firmy
- doménu e-shopu, pro kterou má být vydaný klíč widgetu — uveďte ji i s variantou
www, tedy napříkladeshop.cziwww.eshop.cz - kontaktní osobu a e-mail
- jestli chcete přístup produkční, testovací, nebo obojí
- u widgetu země, do kterých doručujete (CZ, SK, …)
Vzor žádosti
Zkopírujte a doplňte údaje v hranatých závorkách.
Dobrý den,
pro náš e-shop [doména] nasazujeme napojení na PPL přes schválené řešení integrátora Semakin.cz (integrátorské ID 4801974) a potřebovali bychom k tomu vydat přístupové údaje.
Zákaznické ID: [zákaznické ID]. Firma: [název firmy], IČO [IČO]. Kontaktní osoba: [jméno], [e-mail].
Prosíme o vydání: 1) Client ID a Client Secret pro CPL API (myAPI2), přístup produkční; 2) API klíč mapového widgetu výdejních míst (widget 2.0) pro domény [doména] a www.[doména], země doručení [CZ, SK].
Děkujeme.
Až přístupy dorazí
V administraci e-shopu otevřete Systém → Pluginy a otevřete plugin SemaShipping PPL – doručení na adresu a výdejní místa pro VirtueMart. Vyplňte tři pole:
- Client ID
- Client Secret
- API klíč mapového widgetu — ten ve tvaru
ak_…
Zbytek nastavení — metody dopravy, ceny, doprava zdarma, dobírka, štítky — popisuje návod k rozšíření.
Když widget hlásí „Neplatný API klíč"
Nejčastější příčiny jsou dvě a obě jsou na straně klíče, ne rozšíření:
Doména nesedí. Klíč je vydaný na konkrétní domény. Když web běží na www.eshop.cz a klíč je vydaný jen pro eshop.cz, widget se neotevře. Řešením je požádat PPL o doplnění druhé varianty.
Klíč byl vydaný vadný. Stává se to — máme ověřený případ, kdy první vydaný klíč nefungoval na žádné doméně a druhý prošel napoprvé. PPL vrací na neznámý klíč i na nepovolenou doménu stejnou chybu, takže se to zvenčí nerozliší.
Klíč umíme ověřit bez nasazování na web — napište nám a řekneme vám, jestli je vadný, nebo jde jen o doménu.
Na localhost a na testovacích doménách widget nefunguje, pokud pro ně klíč není vydaný. Není to chyba.
Připravujeme: vydání přístupu na pár kliknutí
S PPL máme domluvené, že přístupy k CPL API budeme moci vydávat i my. Až to bude hotové, objeví se generátor přímo na téhle stránce: přihlásíte se ke svému účtu, vyplníte zákaznické ID u PPL a údaje se vygenerují.
Do té doby vede cesta přes vašeho obchodního zástupce PPL, jak je popsáno výš. Adresa téhle stránky se měnit nebude.
English
SemaShipping PPL needs two separate credentials from PPL. First, a Client ID and Client Secret for the CPL API (myAPI2) — the extension uses them to create shipments, download labels and cancel shipments. Second, a map widget key in the ak_… format, which opens the pick-up point map in the cart. The two are unrelated, they are requested separately, and the widget key is bound to your domain.
Request both from your PPL account manager or from PPL customer support. Credentials are issued to you directly and are tied to your PPL customer ID. State that the integration is done through the approved Semakin.cz integrator solution (integrator ID 4801974), and include your PPL customer ID, company name and registration number, the shop domain including the www variant, a contact person with e-mail, whether you need production or test access, and the countries you deliver to.
Enter the values in System → Plugins, in the SemaShipping PPL shipment plugin. If the widget reports an invalid API key, it is almost always the domain not matching the key, or a key that was issued faulty — write to us and we will verify the key for you.