API und ERP-Anbindung
Wie sich DGAssistant in Ihr ERP, Ihr Lagerverwaltungssystem oder Ihre Versandplattform einfügt.
Brauche ich ein eigenes Modul, um die API zu nutzen?
Ja, die API ist ein gesondert lizenziertes Modul zusätzlich zu Ihren Standardlizenzen. Sie nehmen es in Ihr Abonnement auf, wenn Sie sich für die Anbindung entscheiden.
Wie wird die Nutzung der API gemessen und abgerechnet?
Die API wird je Lizenz gemessen: Jede deckt 1 500 Sendungen und 7 500 Dienstaufrufe im Jahr ab und erlaubt der Datenbank bis zu 5 000 Objekte, die keine Sendungen sind, etwa Güter und Beteiligte (Empfänger, Lieferanten, Fahrer und die übrigen). Erwarten Sie mehr Volumen, nehmen Sie einfach weitere Lizenzen hinzu. Den genauen Einzelpreis des API-Moduls finden Sie neben dem übrigen Katalog in unserem Shop; er lässt sich auch in jedes individuelle Angebot aufnehmen.
Was sind die beiden Arten, die API zu nutzen: Stapel oder Dialog?
Im Stapelbetrieb erhält die API die vollständige Beschreibung der Sendung in einem einzigen Dienstaufruf — ideal, wenn das ERP Güter, Beteiligte und Mengen bereits kennt. Im Dialogbetrieb bauen Sie die Sendung Schritt für Schritt auf und prüfen jedes Gut beim Hinzufügen; das kommt der Arbeitsweise der Webanwendung nahe und hilft, wenn Sie auf der API benutzergeführte Abläufe aufsetzen wollen.
Soll ich Güter und Beteiligte im Voraus anlegen oder unmittelbar übergeben?
Beides ist möglich. Empfohlen sind „vordefinierte Daten“: Güter und Beteiligte einmal in der Webanwendung anlegen (oder übernehmen) und in den API-Aufrufen über ihren Code ansprechen. Bei der unmittelbaren Übergabe schicken Sie alles in jedem Aufruf mit, was praktisch ist, wenn Ihr ERP der führende Ort dieser Daten ist und Sie nichts vorab laden wollen.
Wie hole ich die erzeugten PDF-Dateien über die API ab?
Dafür gibt es zwei Möglichkeiten. Sie erhalten die Dokumente in der Antwort der API als Base64-kodierte PDF-Dateien (Beförderungspapier, Versendererklärung, Prüfliste, Versandstückkennzeichnung usw.), oder die Plattform sendet sie von selbst per E-Mail an eine eingerichtete Adresse.
Kann ich die über die API erzeugten Dokumente automatisch drucken?
Ja. Zwei Muster bewähren sich: (a) Ihr ERP lädt die PDF-Datei über die API und übergibt sie der eigenen Druckwarteschlange; (b) DGAssistant sendet die Dokumente an ein eigenes Postfach, und ein kleines Druckprogramm auf Ihrer Seite gibt sie auf dem richtigen Drucker aus. Viele Kunden wählen den Weg über E-Mail, weil er auf der ERP-Seite keinen zusätzlichen Code verlangt.
Wo finde ich die Spezifikation der API?
Die vollständige OpenAPI-Spezifikation mit interaktiven Beispielen ist in der Dokumentation der Gefahrgut-API veröffentlicht. Zusätzlich stellen wir ein SoapUI-Projekt mit realitätsnahen Testaufrufen bereit, damit Ihre Entwickler sie in wenigen Minuten erkunden können.
Was ist requestGuid und warum wird sie verlangt?
Jeder Aufruf der API muss eine eindeutige requestGuid enthalten, die die Anfrage in unseren Protokollen kennzeichnet und unserem Support erlaubt, genau den Vorgang zu finden, wenn Sie eine Störung melden. Jeder eindeutige alphanumerische Wert wird angenommen; wir empfehlen, auf der Clientseite eine gewöhnliche UUID/GUID zu erzeugen.
Was ist der häufigste Grund, warum ein API-Aufruf beim ersten Versuch fehlschlägt?
Zugangsdaten, die der Dienst nicht annimmt: entweder ein fehlender oder falscher HTTP-Basic-Authorization-Header oder, wenn der Aufruf mit OAuth2 authentifiziert wird, ein Zugriffstoken, das nie angefordert wurde, das zu einer anderen Umgebung gehört oder das bereits abgelaufen ist. Es gibt eine eigene Support-Adresse, die Sie aufrufen können, um zu bestätigen, dass die API erreichbar und Ihre Zugangsdaten gültig sind. Kommen Sie nicht weiter, senden Sie uns die vollständige HTTP-Anfrage und -Antwort (einschließlich requestGuid) sowie eine Beschreibung des erwarteten Verhaltens — das löst die Sache am schnellsten.