API a integrace se systémy ERP
Jak se DGAssistant začlení do vašeho systému ERP, WMS nebo přepravní platformy.
Potřebuji k používání API zvláštní modul?
Ano, API je samostatně licencovaný modul, který doplňuje vaše standardní licence. Do předplatného jej přidáte, jakmile se rozhodnete pro integraci.
Jak se využívání API měří a zpoplatňuje?
Využívání API se měří podle licencí: každá licence pokrývá 1 500 zásilek a 10 000 volání služby ročně a umožňuje, aby databáze obsahovala až 5 000 objektů jiných než zásilky, například produkty a účastníky (příjemce, dodavatele, řidiče a další). Pokud očekáváte větší objem, jednoduše přidáte další licence. Přesná jednotková cena modulu API je uvedena spolu se zbytkem katalogu v našem obchodě a lze ji zahrnout do jakékoli individuální nabídky.
Jaké jsou dva způsoby používání API: dávkový a interaktivní?
Dávkový režim přijme úplnou specifikaci zásilky v jediném volání služby – ideální, když systém ERP již zná věci, účastníky a množství. Interaktivní režim umožňuje sestavovat zásilku krok za krokem a ověřovat každou věc při jejím přidání; blíží se tak způsobu práce webové aplikace a hodí se, když nad API potřebujete pracovní postupy řízené uživatelem.
Mám produkty a účastníky vytvořit předem, nebo „za běhu“?
Podporovány jsou oba způsoby. Doporučený přístup jsou „předdefinovaná data“: věci a účastníky vytvoříte jednou ve webové aplikaci (nebo je naimportujete) a ve voláních API na ně odkazujete jejich kódem. Přístup „za běhu“ umožňuje odeslat vše v každém volání, což se hodí, když je zdrojem těchto dat váš systém ERP a nechcete je do aplikace předem nahrávat.
Jak prostřednictvím API získám vytvořené soubory PDF?
Máte dvě možnosti. Dokumenty můžete obdržet v odpovědi API jako soubory PDF kódované v base64 (přepravní doklad, deklarace odesilatele, kontrolní seznam, označení kusů atd.), nebo je platforma může automaticky odesílat e-mailem na nastavenou adresu.
Lze dokumenty vytvořené přes API tisknout automaticky?
Ano. Osvědčily se dva postupy: (a) váš systém ERP stáhne soubor PDF z API a odešle jej do vlastní tiskové fronty; (b) DGAssistant odešle dokumenty e-mailem do vyhrazené poštovní schránky a malý nástroj pro automatický tisk na vaší straně je vytiskne na správné tiskárně. Mnoho zákazníků používá postup s e-mailem, protože nevyžaduje žádný další kód na straně systému ERP.
Kde najdu specifikaci API?
Úplná specifikace OpenAPI je zveřejněna v dokumentaci API pro nebezpečné věci. K dispozici je také projekt SoapUI s předem připravenými realistickými testovacími voláními, takže se vaši vývojáři s API seznámí během několika minut.
Co je requestGuid a proč je povinný?
Každé volání API musí obsahovat jedinečný requestGuid, který identifikuje požadavek v našich protokolech a umožňuje našemu týmu podpory dohledat přesnou transakci, když nahlásíte problém. Přijímá se libovolná jedinečná alfanumerická hodnota; doporučujeme generovat standardní UUID/GUID na straně klienta.
Jaký je nejčastější důvod, proč volání API napoprvé selže?
Přihlašovací údaje, které služba nepřijme: buď chybějící či nesprávná hlavička HTTP Basic Authorization, nebo – pokud se volání ověřuje přes OAuth2 – přístupový token, o který nikdy nebylo požádáno, který patří k jinému prostředí nebo jehož platnost již vypršela. K dispozici je vyhrazená adresa URL podpory, jejímž voláním ověříte, že API je dostupné a vaše přihlašovací údaje jsou platné. Pokud si nevíte rady, pošlete nám úplný požadavek a odpověď HTTP (včetně requestGuid) a popis očekávaného chování – tak se problém vyřeší nejrychleji.