API en koppeling met het ERP
Hoe DGAssistant past in uw ERP, uw magazijnsysteem of uw verzendplatform.
Heb ik een afzonderlijke module nodig om de API te gebruiken?
Ja, de API is een afzonderlijk gelicentieerde module bovenop uw standaardlicenties. U voegt haar toe aan uw abonnement zodra u tot koppelen besluit.
Hoe wordt het gebruik van de API gemeten en geprijsd?
De API wordt per licentie gemeten: elke licentie dekt 1 500 zendingen en 7 500 serviceaanroepen per jaar en laat de database tot 5 000 objecten bevatten die geen zending zijn, zoals goederen en betrokkenen (geadresseerden, leveranciers, chauffeurs en de overige). Verwacht u meer volume, dan voegt u eenvoudig extra licenties toe. De exacte stukprijs van de API-module staat naast de rest van de catalogus in onze winkel en kan in elke offerte op maat worden opgenomen.
Wat zijn de twee manieren om de API te gebruiken: batch of interactief?
In batchmodus ontvangt de API de volledige beschrijving van de zending in één serviceaanroep — ideaal wanneer het ERP de goederen, betrokkenen en hoeveelheden al kent. In interactieve modus bouwt u de zending stap voor stap op en wordt elk goed bij het toevoegen getoetst; dat ligt dicht bij de werkwijze van de webtoepassing en is nuttig wanneer u op de API door de gebruiker geleide stromen wilt bouwen.
Moet ik goederen en betrokkenen vooraf aanmaken of ze meteen meesturen?
Beide zijn mogelijk. De aanbevolen aanpak is die van de «vooraf vastgelegde gegevens»: maak uw goederen en betrokkenen eenmaal aan in de webtoepassing (of lees ze in) en verwijs er in uw aanroepen naar met hun code. Bij de aanpak waarbij u alles meteen meestuurt, geeft u alles in elke aanroep mee, wat handig is wanneer uw ERP de bron van die gegevens is en u niets vooraf wilt laden.
Hoe haal ik de opgemaakte PDF-bestanden via de API op?
Daarvoor zijn er twee mogelijkheden. U kunt de documenten in het antwoord van de API ontvangen als base64-gecodeerde PDF-bestanden (vervoersdocument, verklaring van de afzender, controlelijst, collokenmerking enzovoort), of het platform ze vanzelf per e-mail naar een ingesteld adres laten sturen.
Kan ik de via de API opgemaakte documenten automatisch afdrukken?
Ja. Twee werkwijzen voldoen goed: (a) uw ERP haalt het PDF-bestand op via de API en geeft het aan zijn eigen afdrukwachtrij; (b) DGAssistant stuurt de documenten naar een eigen postbus en een klein afdrukprogramma aan uw kant drukt ze op de juiste printer af. Veel klanten kiezen de weg via e-mail, omdat die aan de ERP-zijde geen extra programmatuur vraagt.
Waar vind ik de specificatie van de API?
De volledige OpenAPI-specificatie, met interactieve voorbeelden, is gepubliceerd in de documentatie van de API voor gevaarlijke goederen. Daarnaast stellen wij een SoapUI-project met realistische testaanroepen beschikbaar, zodat uw ontwikkelaars haar in enkele minuten kunnen verkennen.
Wat is requestGuid en waarom wordt het verlangd?
Elke aanroep van de API moet een unieke requestGuid bevatten, die het verzoek in onze logboeken kenmerkt en onze ondersteuning in staat stelt precies die transactie terug te vinden wanneer u een storing meldt. Elke unieke alfanumerieke waarde wordt aanvaard; wij raden aan aan de clientzijde een gebruikelijke UUID/GUID op te wekken.
Wat is de meest voorkomende reden waarom een API-aanroep bij de eerste poging mislukt?
Gegevens voor toegang die de dienst niet aanvaardt: een ontbrekende of onjuiste HTTP Basic Authorization-header, of, wanneer de aanroep met OAuth2 wordt geverifieerd, een toegangstoken dat nooit is opgevraagd, dat bij een andere omgeving hoort of dat al is verlopen. Er is een eigen ondersteuningsadres dat u kunt aanroepen om te bevestigen dat de API bereikbaar is en uw gegevens geldig zijn. Komt u er niet uit, stuur ons dan het volledige HTTP-verzoek en -antwoord (met requestGuid) en een beschrijving van het verwachte gedrag — dat helpt het snelst.