Gefahrgut-REST-Schnittstelle
Was die Schnittstelle leistet

Sendungen. Die REST-Schnittstelle mit JSON von DGAssistant legt die Gefahrgutsendung aus Ihrem Verwaltungs- oder Logistiksystem an und gibt Versendererklärung, Checkliste und Versandstückkennzeichnung zurück, bereits gegen das zutreffende Regelwerk geprüft. Ihr System hält die kaufmännischen Daten; DGAssistant liefert das Regelwissen und die Dokumente.
Konsolidierung. Die Schnittstelle deckt auch die Zusammenfassung der Sendungen mehrerer Versender ab, entlang ihrer beiden Achsen. Die vertragliche Achse ist die Hauptsendung — eine Buchung, eine See- oder Luftkonsolidierung, eine Straßenkonsolidierung — mit ihren Beteiligten, ihren Referenzen, den ihr zugeordneten Sendungen, ihren Statusübergängen und ihrer Historie. Die physische Achse ist die Beförderungseinheit (Container, Fahrzeug, Anhänger oder Luftfracht-Ladeeinheit) und der Beförderungsvorgang (Seereise, Flug oder Fahrt) mit seinen Anläufen, zusammen mit den Schiffen, Fahrzeugen und Orten des Kontos. Mehr als die Hälfte des Dienstes ist diesem Teil gewidmet.
Zwei Arbeitsweisen: Stapel und Dialog
Stapel. Ein einziger Aufruf trägt die vollständige Beschreibung der Sendung mit allen ihren Gütern. Das ist der Weg für Verwaltungs- und Logistiksysteme, die fertig zusammengestellte Sendungen übergeben.
Dialog. Zuerst wird die Sendung eröffnet, dann werden die Güter einzeln hinzugefügt. Jede Antwort führt die Prüfhinweise zum soeben Hinzugefügten mit, damit Ihre eigene Anwendung sie dem Benutzer während der Vorbereitung anzeigen kann.
Vorab angelegte Daten oder Daten im Aufruf
Vorab angelegte Daten. Güter und Beteiligte — Absender, Frachtführer, Empfänger, Verlader und Fahrer — werden vorher angelegt, und die Schnittstelle verwendet ihre Codes. Das ist der einfachste Weg und der, den wir empfehlen, weil die Einstufung einmal geklärt und in jeder Sendung wiederverwendet wird.
Daten im Aufruf. Güter und Beteiligte werden in demselben Aufruf festgelegt, der die Sendung anlegt. Das passt zu Systemen, die keinen eigenen Bestand führen oder nur gelegentlich Gefahrgut versenden.
Die Dokumente, die sie zurückgibt
Die API liefert dieselben Dokumente, die die Anwendung erstellt. Die der Sendung und der Konsolidierung werden als PDF, XLSX oder DOCX abgerufen, die der Sendung können außerdem unmittelbar aus dem Dienst per E-Mail versandt werden; die des Frachtbriefs als PDF.
- Je Sendung: das Beförderungsdokument der zutreffenden Vorschrift –das ADR-Beförderungspapier, die IMO-Gefahrguterklärung oder das multimodale IMDG-Formular und die IATA-Versendererklärung–, die Checkliste, die Versandstückkennzeichnung in voller Größe oder in kleiner benutzerdefinierter Größe und im Luftverkehr das Datenblatt für den Luftfrachtbrief.
- Für die Hauptsendung: das Konsolidierungsmanifest, die Containerliste, die Packliste je Einheit, die Ladeliste nach Absender und das Datenblatt des Hauptdokuments.
- Für die Beförderungseinheit: das Container-/Fahrzeugpackzertifikat, das multimodale Gefahrgutformular, den Trennungsbericht der Einheit, die Checkliste vor der Unterzeichnung des Zertifikats und das Konsolidierungsetikett.
- Für die Beförderung: das Gefahrgutmanifest, den Trennungsbericht zwischen den Einheiten an Bord, den Bericht über den Freistellungsgrenzwert nach ADR 1.1.3.6, das Beschränkungsblatt der Beförderung, die Ladeliste, die Mitteilung an den Luftfahrzeugführer (NOTOC) und das zusammengefasste Beförderungspapier des Fahrzeugs.
- Für den Frachtbrief: den Entwurf, die unterzeichnete Ausfertigung, das beigefügte ADR-Beförderungspapier und den Nachweisbericht.
Was die Schnittstelle prüft
In der Sendung. Die Trennung zwischen den gemeinsam beförderten Gütern, die Mengengrenzen der zutreffenden Verpackungsanweisung sowie der begrenzten und freigestellten Mengen, die Zulässigkeit der Güter für den Verkehrsträger, die Zulässigkeit der Verpackung und die Vollständigkeit der Erklärung. Wird etwas nicht erfüllt, nennt die Antwort die nicht eingehaltene Regel und die betroffenen Werte, sodass sich die Meldung in Ihrer eigenen Anwendung anzeigen lässt.
In der Konsolidierung. Die Trennung innerhalb der Beförderungseinheit, die Trennung zwischen den im selben Vorgang geladenen Einheiten, die Berechnung des Schwellenwerts nach 1.1.3.6 des ADR für den Vorgang samt Aufschlüsselung und die Beschränkungen der Fahrt als Daten, etwa der Tunnelbeschränkungscode oder das Vorhandensein gefährlicher Güter mit hohem Gefahrenpotenzial.
Abgedeckte Regelwerke und Beförderungsarten
ADR für die Straße, IMDG für die See, IATA für die Luft und 49 CFR. Die drei Hauptregelwerke werden gemeinsam geführt und nicht als getrennte Module, damit eine Sendung, die den Verkehrsträger wechselt, nicht neu vorbereitet werden muss.
Zusammenpackung, Umverpackungen, Tanks, Beförderung in loser Schüttung, leere ungereinigte Verpackungen, Abfälle, explosive Stoffe und Gegenstände der Klasse 1 –mit ihrer Netto-Explosivstoffmasse je Versandstück– und radioaktive Stoffe der Klasse 7 werden unterstützt, jeweils mit den Daten, die sie verlangen. Die Texte der Dokumente werden in neunzehn Sprachen ausgegeben.
Verfügbarkeit
Der Dienst wird in drei Regionen veröffentlicht — Europa, Amerika und Asien-Pazifik —, jede mit eigener Adresse, damit die Anbindung gegen die Region arbeitet, in der das Konto geführt wird. Die Infrastruktur ist redundant und wird rund um die Uhr überwacht.
Wie man anfängt
Fordern Sie eine kostenlose zweiwöchige Testversion und damit die Zugangsdaten des Dienstes an. Die Anmeldung erfolgt über OAuth 2.0 mit dem Verfahren „client credentials“: Ihr System holt ein Zugriffstoken und sendet es in jeder Anfrage mit.
Die vollständige Spezifikation ist im Format OpenAPI veröffentlicht und lässt sich lesen, erkunden und zur Erzeugung eines Clients in Ihrer eigenen Sprache nutzen, bevor eine einzige Zeile Anbindungscode geschrieben ist.
Abschnitte der Spezifikation der Schnittstelle
| Abschnitt | |
|---|---|
| ÜbersichtVorstellung der Schnittstelle und ihrer Nutzungsgrenzen, mit den OpenAPI-3.0- und -2.0-Dateien der Spezifikation und dem Verzeichnis aller Abschnitte. | Öffnen |
| AuthentifizierungZugriffstoken nach OAuth2, ausgestellt im Verfahren „client credentials“, als Alternative zur HTTP-Basic-Authentifizierung bei allen authentifizierten Vorgängen. | Öffnen |
| VerbindungsprüfungenPrüfung der Verfügbarkeit der Schnittstelle, der Zugangsdaten des Schnittstellenbenutzers und von Anfragen mit und ohne Authentifizierung. | Öffnen |
| StammdatenGefährliche Güter und Radionuklide, Verpackungen und Verpackungsanweisungen, Codes, Länder und Orte, auf die sich Sendungen, Produkte und Konsolidierung beziehen. | Öffnen |
| ProdukteEinfache Produkte und Produkte in Zusammenpackung aus dem Katalog, einschließlich der Erstellung eines Produkts in Zusammenpackung im Dialog für eine Sendung. | Öffnen |
| BeteiligteVorab angelegte Beteiligte: Versender, Empfänger, Verlader, Beförderer, Lieferanten und Fahrzeugführer. | Öffnen |
| Fahrzeuge, Anhänger und SchiffeFahrzeuge, Anhänger und Schiffe der Konten mit amtlichem Kennzeichen, ADR-Fahrzeugbezeichnung und Bescheinigung über die Eignung zur Beförderung gefährlicher Güter. | Öffnen |
| Orte und BeschränkungenHäfen, Flughäfen und Terminals der Konten sowie die Beschränkungen, die gelten, wenn dort eine Beförderungseinheit eingeplant oder beladen wird. | Öffnen |
| SendungenAnlage einer Sendung mit ihrem gesamten Inhalt (Stapel) oder mit ihrem ersten Inhalt (Dialog) sowie Abruf und Löschung von Sendungen. | Öffnen |
| Inhalt der SendungProdukte, Zusammenpackungen und Umverpackungen, die einer im Dialog bearbeiteten Sendung hinzugefügt oder aus ihr entfernt werden. | Öffnen |
| Dokumente der SendungDokumente einer Sendung (Beförderungspapier, Checkliste, Kennzeichnung der Versandstücke und weitere), ihr Versand per E-Mail und eingefrorene Dokumente. | Öffnen |
| FrachtbriefeCMR-Frachtbriefe, elektronische Frachtbriefe (e-CMR) und nationale Frachtbriefe, von der Prüfung, ob das e-CMR-Protokoll die Strecke abdeckt, bis zu Ausstellung, Zustellung und Stornierung. | Öffnen |
| KonsolidierungsanträgeKonsolidierungsanträge der Kundenkonten oder ihres Sicherheitsberaters in deren Namen sowie die Entscheidungen des Konsolidierers. | Öffnen |
| HauptsendungenHauptsendungen mit ihren Sendungen und ihrem Freigabeablauf. | Öffnen |
| BeförderungseinheitenBeförderungseinheiten, ihr Inhalt, ihre Trennungsprüfungen und ihre Bewegungshistorie. | Öffnen |
| Beförderungen und AnläufeReisen, Flüge und Straßenfahrten mit ihren Anläufen und Beförderungseinheiten, Trennungsprüfungen, Berechnung des Schwellenwerts nach ADR 1.1.3.6 und Beschränkungen. | Öffnen |
| KonsolidierungsdokumenteDokumente der Hauptsendungen, der Beförderungseinheiten und der Beförderungen. | Öffnen |
| WebhooksWebhook-Abonnements des Kontos, ihr Test und ihre letzten Zustellungen. | Öffnen |