Hopp til innhold

REST-API for farlig gods

Hva API-et gjør

Connection between DGAssistant and a management system

Forsendelser. DGAssistants JSON-baserte REST-API oppretter forsendelsen med farlig gods fra ditt eget forretnings- eller logistikksystem og returnerer avsenderdeklarasjonen, sjekklisten og kollimerkingen, allerede kontrollert mot det regelverket som gjelder. Ditt system beholder de kommersielle dataene; DGAssistant bidrar med regelverkskunnskapen og dokumentene.

Konsolidering. API-et dekker også grupperingen av forsendelser fra flere avsendere, langs begge aksene. Den kontraktsmessige aksen er hovedforsendelsen — en booking, en konsolidering til sjøs eller med fly, en veikonsolidering — med parter, referanser, tilknyttede forsendelser, statusendringer og historikk. Den fysiske aksen er transportutstyret (container, kjøretøy, tilhenger eller enhetslastanordning) og selve transporten (sjøreise, flyvning eller veitransport) med anløp, sammen med kontoens fartøy, kjøretøy og steder. Mer enn halvparten av tjenesten er viet denne delen.

Åpne API-spesifikasjonen for farlig gods

To arbeidsmåter: satsvis og interaktiv

Satsvis. Ett enkelt kall inneholder den fullstendige spesifikasjonen av forsendelsen med alt godset. Denne arbeidsmåten er beregnet på forretnings- og logistikksystemer som sender ferdig sammensatte forsendelser.

Interaktiv. Forsendelsen åpnes først, og godset legges til post for post. Hvert svar inneholder valideringsmeldingene for det som nettopp er lagt til, slik at din egen applikasjon kan vise dem til brukeren mens forsendelsen klargjøres.

Forhåndsdefinerte data eller data i kallet

Forhåndsdefinerte data. Produktene og deltakerne — avsendere, transportører, mottakere, lastere og førere — opprettes på forhånd, og API-et bruker kodene deres. Dette er den enkleste arbeidsmåten og den vi anbefaler, fordi klassifiseringen etter regelverket fastsettes én gang og gjenbrukes i hver forsendelse.

Data i kallet. Produktene og deltakerne defineres i det samme kallet som oppretter forsendelsen. Dette passer for systemer som ikke har en egen katalog, eller som bare sender gods av og til.

Dokumentene API-et returnerer

API-et returnerer de samme dokumentene som applikasjonen utarbeider. Dokumentene for forsendelsen og for konsolideringen hentes i PDF, XLSX eller DOCX, og dokumentene for forsendelsen kan også sendes med e-post direkte fra tjenesten; dokumentene for fraktbrevet hentes i PDF.

  • For hver forsendelse: transportdokumentet etter det aktuelle regelverket (ADR-transportdokumentet, IMO-erklæringen for farlig gods eller det multimodale IMDG-skjemaet, og IATA-avsenderdeklarasjonen), sjekklisten, kollimerkingen i full størrelse eller i lite tilpasset format og, ved lufttransport, databladet for flyfraktbrevet.
  • For hovedforsendelsen: konsolideringsmanifestet, containerlisten, pakklisten for hver enhet, lastelisten per avsender og databladet for hoveddokumentet.
  • For transportenheten: stuingssertifikatet for container eller kjøretøy, det multimodale skjemaet for farlig gods, atskillelsesrapporten for enheten, sjekklisten før sertifikatet signeres og konsolideringsetiketten.
  • For reisen: manifestet for farlig gods, atskillelsesrapporten mellom enhetene om bord, rapporten om unntaksgrensen etter ADR 1.1.3.6, arket med restriksjoner for reisen, lastelisten, meldingen til luftfartøysjefen (NOTOC) og det konsoliderte transportdokumentet for kjøretøyet.
  • For fraktbrevet: utkastet, det signerte eksemplaret, det vedlagte ADR-transportdokumentet og bevisrapporten.

Hva API-et kontrollerer

I forsendelsen. Atskillelse mellom gods som transporteres sammen, mengdegrensene i den aktuelle emballeringsinstruksjonen og i ordningene for begrensede og unntatte mengder, om godset er tillatt for transportmåten, om emballasjen er tillatt, og om deklarasjonen er fullstendig. Når noe ikke er i samsvar med kravene, oppgir svaret hvilken regel som ikke er oppfylt og med hvilke verdier, slik at meldingen kan vises i din egen applikasjon.

I konsolideringen. Atskillelse i transportenheten, atskillelse mellom enhetene som er lastet i samme transport, beregning av grensen i ADR 1.1.3.6 for transporten med fordeling, og restriksjonene for reisen, returnert som data, for eksempel tunnelrestriksjonskoden eller om det finnes farlig gods med høyt farepotensial.

Regelverk og transportformer som dekkes

ADR for vei, IMDG for sjø, IATA for fly og 49 CFR. De tre hovedregelverkene håndteres samlet og ikke som separate moduler, slik at en forsendelse som bytter transportmåte, ikke trenger å klargjøres på nytt.

Samemballering, overpakninger, tanker, transport i bulk, tomme, ikke rengjorte emballasjer, avfall, eksplosiver i klasse 1 – med netto eksplosivmasse per kolli – og radioaktivt materiale i klasse 7 støttes, med de dataene hver av dem krever. Tekstene i dokumentene utstedes på nitten språk.

Tilgjengelighet

Tjenesten er publisert i tre regioner — Europa, Amerika og Asia-Stillehavsregionen — hver med sin egen adresse, slik at integrasjonen arbeider mot regionen der kontoen ligger. Infrastrukturen er redundant og overvåkes døgnet rundt.

Slik kommer du i gang

Be om en gratis prøveperiode på to uker, og med den påloggingsopplysningene for tjenesten. Autentiseringen bruker OAuth 2.0 med tildelingstypen «client credentials»: systemet ditt henter et tilgangstoken og sender det med i hver forespørsel.

Den fullstendige spesifikasjonen er publisert i OpenAPI-format og kan leses, utforskes og brukes til å generere en klient i ditt eget programmeringsspråk før du skriver en eneste linje med integrasjonskode.

For å se hvor raskt og enkelt integrasjonen er, kan du få en uforpliktende prøveperiode på to uker