REST-API för farligt gods

Vad API:et gör

Sändningar. JSON REST-API:et i DGAssistant skapar sändningen av farligt gods från ditt eget affärs- eller logistiksystem och returnerar avsändardeklarationen, checklistan och kollimärkningen, redan kontrollerade mot det regelverk som gäller. Ditt system behåller de kommersiella uppgifterna; DGAssistant står för regelverkskunskapen och dokumenten.

Konsolidering. API:et omfattar även sammanförandet av sändningar från flera avsändare, längs två axlar. Den avtalsmässiga axeln är huvudsändningen — en bokning, en sjö- eller flygkonsolidering, en konsoliderad sändning på väg — med dess parter, referenser, de sändningar som är knutna till den, statusövergångar och historik. Den fysiska axeln är transportutrustningen (container, fordon, släpvagn eller enhetslastanordning) och transportförflyttningen (resa, flygning eller färd) med dess anlöp, tillsammans med kontots fartyg, fordon och platser. Mer än hälften av tjänsten ägnas åt denna del.

Öppna API-specifikationen för farligt gods

Två arbetssätt: satsvis och interaktivt

Satsvis. Ett enda anrop innehåller den fullständiga specifikationen av sändningen med allt dess gods. Det är det arbetssätt som är avsett för affärs- och logistiksystem som skickar hela sändningar som redan är sammanställda.

Interaktivt. Sändningen öppnas först och godsposterna läggs till en i taget. Varje svar innehåller valideringsmeddelandena för det som just har lagts till, så att ditt eget program kan visa dem för användaren medan sändningen förbereds.

Fördefinierade data eller data direkt i anropet

Fördefinierade data. Produkterna och aktörerna — avsändare, transportörer, mottagare, lastare och förare — skapas i förväg och API:et använder deras koder. Det är det enklaste arbetssättet och det som vi rekommenderar, eftersom klassificeringen enligt regelverket fastställs en gång och återanvänds i varje sändning.

Data direkt i anropet. Produkterna och aktörerna definieras i samma anrop som skapar sändningen. Det passar system som inte har en egen katalog eller som skickar gods vid enstaka tillfällen.

Dokumenten som API:et returnerar

API:et returnerar samma dokument som programmet tar fram. Sändningens och konsolideringens dokument hämtas i PDF, XLSX eller DOCX, och sändningens dokument kan även skickas per e-post direkt från tjänsten; fraktsedelns dokument hämtas i PDF.

• För varje sändning: godsdeklarationen enligt det tillämpliga regelverket (ADR-godsdeklarationen, IMO:s godsdeklaration för farligt gods eller IMDG:s multimodala formulär samt IATA:s avsändardeklaration), checklistan, kollimärkningen i full storlek eller i litet, anpassat format och, vid flygtransport, databladet för flygfraktsedeln.
• För huvudsändningen: konsolideringsmanifestet, containerlistan, packlistan för varje enhet, lastlistan per avsändare och databladet för huvuddokumentet.
• För transportenheten: stuvningsintyget för containrar/fordon, det multimodala formuläret för farligt gods, separeringsrapporten för enheten, checklistan innan intyget undertecknas och konsolideringsetiketten.
• För resan: manifestet för farligt gods, separeringsrapporten mellan enheterna ombord, rapporten om gränsvärdet för undantaget i ADR 1.1.3.6, bladet med restriktioner för resan, lastlistan, anmälan till befälhavaren (NOTOC) och fordonets konsoliderade godsdeklaration.
• För fraktsedeln: utkastet, det undertecknade exemplaret, den bifogade ADR-godsdeklarationen och bevisrapporten.

Vad API:et kontrollerar

I sändningen. Separeringen mellan gods som transporteras tillsammans, mängdgränserna i den tillämpliga förpackningsinstruktionen och i reglerna för begränsade och reducerade mängder, att godset är tillåtet för transportslaget, att förpackningen är tillåten och att deklarationen är fullständig. När något inte uppfyller kraven anger svaret vilken regel som inte uppfylls och med vilka värden, så att meddelandet kan visas i ditt eget program.

I konsolideringen. Separeringen inom transportenheten, separeringen mellan de enheter som lastas i samma förflyttning, beräkningen av gränsvärdet enligt ADR 1.1.3.6 för förflyttningen med dess fördelning samt restriktionerna för färden, som returneras som data, till exempel tunnelrestriktionskoden eller förekomsten av farligt gods med hög riskpotential.

Regelverk och transportformer som omfattas

ADR för väg, IMDG för sjö, IATA för flyg och 49 CFR. De tre huvudsakliga regelverken hanteras tillsammans och inte som separata moduler, så att en sändning som byter transportslag inte behöver förberedas på nytt.

Samemballering, overpack, tankar, transport i bulk, tömda, ej rengjorda förpackningar, avfall, explosiva ämnen och föremål i klass 1 – med nettovikt explosivt ämne per kolli – och radioaktiva ämnen i klass 7 stöds, med de uppgifter som vart och ett av dem kräver. Dokumentens texter utfärdas på nitton språk.

Tillgänglighet

Tjänsten publiceras i tre regioner — Europa, Amerika och Asien–Stillahavsområdet — var och en med sin egen adress, så att integrationen arbetar mot den region där kontot finns. Infrastrukturen är redundant och övervakas dygnet runt.

Så kommer du i gång

Begär en kostnadsfri provperiod på två veckor och därmed inloggningsuppgifterna till tjänsten. Autentiseringen sker med OAuth 2.0 och flödet client credentials: ditt system hämtar en åtkomsttoken och skickar den med i varje anrop.

Den fullständiga specifikationen publiceras i OpenAPI-format och kan läsas, utforskas och användas för att generera en klient i ditt eget programmeringsspråk innan du skriver en enda rad integrationskod.