REST-API for farligt gods
DGAssistants JSON REST-API opretter forsendelser af farligt gods fra dit eget forretnings- eller logistiksystem og returnerer afsendererklæringen, tjeklisten og kollimærkningen, kontrolleret i forhold til det gældende regelværk. Det er beregnet til virksomheder, der integrerer disse dokumenter i deres ERP-system, og det dækker også konsolidering.
Hvad API'et gør

Forsendelser. DGAssistants JSON REST-API opretter forsendelsen af farligt gods fra dit eget forretnings- eller logistiksystem og returnerer afsendererklæringen, tjeklisten og kollimærkningen, allerede kontrolleret i forhold til det gældende regelværk. Dit system bevarer de kommercielle data; DGAssistant leverer viden om regelværket og dokumenterne.
Konsolidering. API'et dækker også samlingen af forsendelser fra flere afsendere langs to akser. Den kontraktmæssige akse er hovedforsendelsen — en booking, en konsolidering til sø- eller lufttransport, en groupage ad vej — med dens parter, referencer, tilknyttede forsendelser, statusændringer og historik. Den fysiske akse er transportudstyret (container, køretøj, påhængskøretøj eller enhedslastanordning) og transportforløbet (sørejse, flyvning eller tur ad vej) med dets anløb samt kontoens fartøjer, køretøjer og lokationer. Mere end halvdelen af tjenesten vedrører denne del.
To arbejdsmåder: batch og interaktiv
Batch. Et enkelt kald indeholder den fuldstændige specifikation af forsendelsen med alt dens gods. Det er den arbejdsmåde, der er beregnet til forretnings- og logistiksystemer, som sender hele forsendelser, der allerede er sammensat.
Interaktiv. Forsendelsen oprettes først, og godset tilføjes derefter post for post. Hvert svar indeholder valideringsmeddelelserne for det, der netop er tilføjet, så din egen applikation kan vise dem for brugeren, mens forsendelsen forberedes.
Foruddefinerede data eller ad hoc-data
Foruddefinerede data. Produkterne og parterne — afsendere, transportører, modtagere, læssere og førere — oprettes på forhånd, og API'et anvender deres koder. Det er den enkleste arbejdsmåde og den, vi anbefaler, fordi klassificeringen efter regelværket fastlægges én gang og genbruges i alle forsendelser.
Ad hoc-data. Produkterne og parterne defineres i det samme kald, som opretter forsendelsen. Det passer til systemer, der ikke har et eget katalog, eller som afsender gods lejlighedsvis.
De dokumenter, API'et returnerer
API'et returnerer de samme dokumenter, som applikationen udarbejder. Dokumenterne for forsendelsen og konsolideringen hentes i PDF, XLSX eller DOCX, og forsendelsens dokumenter kan desuden sendes pr. e-mail direkte fra tjenesten; fragtbrevets dokumenter hentes i PDF.
- For hver forsendelse: transportdokumentet efter det gældende regelværk (ADR-transportdokumentet, IMO-erklæringen for farligt gods eller det multimodale IMDG-dokument for farligt gods og IATA-afsendererklæringen), tjeklisten, kollimærkningen i fuld størrelse eller i lille, brugerdefineret størrelse og, ved lufttransport, dataarket til luftfragtbrevet.
- For hovedforsendelsen: konsolideringsmanifestet, containerlisten, pakkelisten for hver enhed, ladelisten pr. afsender og dataarket for hoveddokumentet.
- For den transporterende enhed: container-/køretøjspakkeattesten, det multimodale dokument for farligt gods, oversigten over farligt gods i enheden, tjeklisten før attesten underskrives, og konsolideringsetiketten.
- For rejsen: manifestet for farligt gods, adskillelsesrapporten mellem enhederne om bord, rapporten over grænsen for undtagelsen i ADR 1.1.3.6, arket med restriktioner for rejsen, ladelisten, meddelelsen til luftfartøjschefen (NOTOC) og køretøjets samlede transportdokument.
- For fragtbrevet: udkastet, det underskrevne eksemplar, det vedhæftede ADR-transportdokument og bevisrapporten.
Hvad API'et kontrollerer
I forsendelsen. Adskillelsen mellem gods, der transporteres sammen, mængdegrænserne i den gældende emballeringsforskrift og i ordningerne for begrænsede og undtagne mængder, om godset er tilladt til transportformen, om emballagen er tilladt, og om erklæringen er fuldstændig. Når noget ikke er i overensstemmelse med reglerne, angiver svaret, hvilken regel der ikke er opfyldt, og med hvilke værdier, så meddelelsen kan vises i din egen applikation.
I konsolideringen. Adskillelsen i den transporterende enhed, adskillelsen mellem de enheder, der er læsset i samme transportforløb, beregningen af grænsen i ADR 1.1.3.6 for transportforløbet med opdeling samt rejsens restriktioner, der returneres som data, f.eks. tunnelrestriktionskoden eller tilstedeværelsen af højrisikogods.
Omfattede regelværker og transporttyper
ADR til vejtransport, IMDG til søtransport, IATA til lufttransport og 49 CFR. De tre vigtigste regelværker håndteres samlet og ikke som separate moduler, så en forsendelse, der skifter transportform, ikke skal forberedes igen.
Sammenpakning, ekstra ydre emballager, tanke, bulktransport, tomme, urensede emballager, affald, eksplosive stoffer og genstande i klasse 1 – med deres nettoeksplosivstofmængde pr. kolli – og radioaktivt materiale i klasse 7 understøttes alle med de data, som hver af dem kræver. Dokumenternes tekster udstedes på nitten sprog.
API'ets tilgængelighed
Tjenesten udbydes i tre regioner — Europa, Amerika og Asien-Stillehavsområdet — hver med sin egen adresse, så integrationen arbejder mod den region, hvor kontoen er oprettet. Infrastrukturen er redundant og overvåges døgnet rundt.
Sådan kommer du i gang med API'et
Anmod om en gratis prøveperiode på to uger og dermed om adgangsoplysningerne til tjenesten. Autentificeringen sker via OAuth 2.0 med client credentials-flowet: dit system henter et adgangstoken og sender det med hver anmodning.
Den komplette specifikation er offentliggjort i OpenAPI-format og kan læses, udforskes og bruges til at generere en klient i dit eget programmeringssprog, før du skriver en eneste linje integrationskode.
Afsnit i API-specifikationen
| Afsnit | |
|---|---|
| OversigtPræsentation af API'et og dets anvendelsesgrænser med specifikationens OpenAPI 3.0- og 2.0-filer og en liste over alle afsnit. | Åbn |
| AutentificeringOAuth2-adgangstokens, der udstedes med client credentials-flowet, som alternativ til HTTP Basic-autentificering ved alle autentificerede handlinger. | Åbn |
| ForbindelsestjekKontrol af API'ets tilgængelighed, af API-brugerens adgangsoplysninger og af anmodninger med og uden autentificering. | Åbn |
| StamdataFarligt gods og radionuklider, emballager og emballeringsforskrifter, koder, lande og lokationer, som forsendelser, produkter og konsolidering henviser til. | Åbn |
| ProdukterEnkle produkter og produkter med sammenpakning i kataloget, herunder interaktiv oprettelse af et produkt med sammenpakning til en forsendelse. | Åbn |
| ParterForuddefinerede parter: afsendere, modtagere, læssere, transportører, leverandører og førere. | Åbn |
| Køretøjer, påhængskøretøjer og fartøjerKontoernes køretøjer, påhængskøretøjer og fartøjer med registreringsnummer, ADR-køretøjsbetegnelse og overensstemmelsesdokument. | Åbn |
| Lokationer og restriktionerKontoernes havne, lufthavne og terminaler og de restriktioner, der gælder, når der planlægges eller læsses transportudstyr dér. | Åbn |
| ForsendelserOprettelse af en forsendelse med hele indholdet (batch) eller med det første indhold (interaktiv) samt hentning og sletning af forsendelser. | Åbn |
| Forsendelsens indholdProdukter, sammenpakninger og ekstra ydre emballager, der tilføjes til eller fjernes fra en forsendelse, som behandles interaktivt. | Åbn |
| Forsendelsens dokumenterEn forsendelses dokumenter (transportdokument, tjekliste, kollimærkning og andre), afsendelse af dem pr. e-mail og låste dokumenter. | Åbn |
| FragtbreveCMR-fragtbreve, elektroniske fragtbreve (e-CMR) og nationale fragtbreve, fra kontrollen af, om e-CMR-protokollen dækker ruten, til udstedelse, levering og annullering. | Åbn |
| Anmodninger om konsolideringAnmodninger om konsolidering fra kundekonti eller fra deres sikkerhedsrådgiver på deres vegne samt konsolidatorens beslutninger. | Åbn |
| HovedforsendelserHovedforsendelser med deres forsendelser og godkendelsesforløb. | Åbn |
| TransportudstyrTransportudstyr, dets indhold, dets adskillelsestjek og dets bevægelseshistorik. | Åbn |
| Transporter og anløbSørejser, flyvninger og ture ad vej med deres anløb og transportudstyr, adskillelsestjek, beregning af lastgrænsen (ADR 1.1.3.6) og restriktioner. | Åbn |
| KonsolideringsdokumenterDokumenter for hovedforsendelser, transportudstyr og transporter. | Åbn |
| WebhooksKontoens webhook-abonnementer, test af dem og de seneste leveringer. | Åbn |