API a integrácia so systémami ERP
Ako sa DGAssistant začlení do vášho systému ERP, WMS alebo prepravnej platformy.
Potrebujem na používanie API osobitný modul?
Áno, API je samostatne licencovaný modul nad rámec vašich štandardných licencií. Do predplatného si ho pridáte, keď sa rozhodnete pre integráciu.
Ako sa meria a spoplatňuje používanie API?
Používanie API sa meria podľa licencií: každá licencia pokrýva 1 500 zásielok a 10 000 volaní služby ročne a umožňuje, aby databáza obsahovala až 5 000 objektov iných ako zásielky, napríklad výrobky a účastníkov (príjemcov, dodávateľov, vodičov a ďalších). Ak očakávate väčší objem, jednoducho si pridáte ďalšie licencie. Presná jednotková cena modulu API je uvedená spolu so zvyškom katalógu v našom obchode a môže byť súčasťou akejkoľvek individuálnej cenovej ponuky.
Aké sú dva spôsoby používania API: dávkový (Batch) a interaktívny (Interactive)?
Dávkový režim prijme úplnú špecifikáciu zásielky v jedinom volaní služby – ideálne, keď systém ERP už pozná veci, účastníkov a množstvá. Interaktívny režim vám umožňuje zostavovať zásielku krok za krokom a overovať každú vec pri jej pridaní; je bližší tomu, ako funguje webová aplikácia, a je užitočný, keď nad API potrebujete pracovné postupy riadené používateľom.
Mám výrobky a účastníkov vytvoriť vopred, alebo „za behu“?
Podporované sú oba prístupy. Odporúčaným prístupom sú „preddefinované údaje“: veci a účastníkov vytvoríte raz vo webovej aplikácii (alebo ich naimportujete) a vo volaniach API sa na ne odvolávate kódom. Prístup „za behu“ vám umožňuje posielať všetky údaje v každom volaní, čo je výhodné, keď je hlavným zdrojom týchto údajov váš systém ERP a nechcete ich vopred načítavať.
Ako cez API získam vytvorené súbory PDF?
Sú dve možnosti. Dokumenty môžete dostať priamo v odpovedi API ako súbory PDF zakódované v base64 (prepravný doklad, vyhlásenie odosielateľa, kontrolný zoznam, označenie kusov atď.), alebo ich platforma môže automaticky posielať e-mailom na nastavenú adresu.
Môžem dokumenty vytvorené cez API tlačiť automaticky?
Áno. Osvedčili sa dva postupy: (a) váš systém ERP stiahne PDF z API a pošle ho do vlastného tlačového frontu; (b) DGAssistant pošle dokumenty e-mailom do vyhradenej schránky a malý nástroj na automatickú tlač na vašej strane ich vytlačí na správnej tlačiarni. Mnohí zákazníci používajú postup s e-mailom, pretože na strane ERP nevyžaduje žiadny ďalší kód.
Kde nájdem špecifikáciu API?
Úplná špecifikácia OpenAPI je uverejnená v dokumentácii API pre nebezpečné veci. Poskytujeme aj projekt SoapUI s vopred pripravenými realistickými testovacími volaniami, aby si vaši vývojári mohli API vyskúšať v priebehu niekoľkých minút.
Čo je requestGuid a prečo je povinný?
Každé volanie API musí obsahovať jedinečný requestGuid, ktorý identifikuje požiadavku v našich záznamoch a umožní nášmu tímu podpory nájsť presnú transakciu, keď nahlásite problém. Akceptuje sa akákoľvek jedinečná alfanumerická hodnota; odporúčame generovať na strane klienta štandardný UUID/GUID.
Aký je najčastejší dôvod, prečo volanie API pri prvom pokuse zlyhá?
Prihlasovacie údaje, ktoré služba neakceptuje: buď chýbajúca alebo nesprávna hlavička HTTP Basic Authorization, alebo – ak sa volanie overuje cez OAuth2 – prístupový token, o ktorý sa nikdy nepožiadalo, ktorý patrí inému prostrediu alebo ktorého platnosť už uplynula. K dispozícii je vyhradená adresa URL podpory, ktorú môžete zavolať a overiť si tak, že API je dostupné a vaše prihlasovacie údaje sú platné. Ak si neviete rady, pošlite nám celú požiadavku a odpoveď HTTP (vrátane requestGuid) a opis očakávaného správania – práve to vyrieši problém najrýchlejšie.