REST API pro nebezpečné věci

Co API umí

Zásilky. REST API DGAssistant ve formátu JSON vytvoří zásilku nebezpečných věcí z vašeho vlastního podnikového nebo logistického systému a vrátí deklaraci odesilatele, kontrolní seznam a označení kusů, již ověřené podle příslušného předpisu. Váš systém uchovává obchodní údaje; DGAssistant dodává znalost předpisů a dokumenty.

Konsolidace. API pokrývá také seskupování zásilek od více odesilatelů, a to v obou jeho osách. Smluvní osou je hlavní zásilka — rezervace, námořní nebo letecká konsolidace, silniční sběrná přeprava — s jejími účastníky, referencemi, připojenými zásilkami, přechody mezi stavy a historií. Fyzickou osou je přepravní zařízení (kontejner, vozidlo, přípojné vozidlo nebo jednotkové nákladové zařízení ULD) a přeprava (námořní cesta, let nebo jízda) s jejími zastávkami, spolu s plavidly, vozidly a místy vedenými v účtu. Této části je věnována více než polovina služby.

Otevřít specifikaci API pro nebezpečné věci

Dva způsoby práce: dávkový a interaktivní

Dávkový režim. Jediné volání obsahuje úplnou specifikaci zásilky se všemi jejími věcmi. Tento způsob je určen pro podnikové a logistické systémy, které odesílají celé zásilky již sestavené.

Interaktivní režim. Nejprve se otevře zásilka a věci se přidávají jedna po druhé. Každá odpověď obsahuje validační zprávy k tomu, co bylo právě přidáno, takže je vaše vlastní aplikace může zobrazit uživateli již během přípravy zásilky.

Předdefinovaná data nebo data zadaná za běhu

Předdefinovaná data. Produkty a účastníci — odesilatelé, dopravci, příjemci, nakládci a řidiči — se vytvoří předem a API používá jejich kódy. Je to nejjednodušší způsob práce a ten, který doporučujeme, protože klasifikace podle předpisů se stanoví jednou a znovu se použije v každé zásilce.

Data zadaná za běhu. Produkty a účastníci se definují v témže volání, které vytváří zásilku. Tento způsob se hodí pro systémy, které nevedou vlastní katalog nebo které odesílají věci jen příležitostně.

Dokumenty, které API vrací

API vrací tytéž dokumenty, které vytváří aplikace. Dokumenty zásilky a konsolidace lze získat ve formátu PDF, XLSX nebo DOCX a dokumenty zásilky lze navíc odeslat e-mailem přímo ze služby; dokumenty nákladního listu jsou k dispozici ve formátu PDF.

• Pro každou zásilku: přepravní doklad podle příslušného předpisu – přepravní doklad ADR, prohlášení o nebezpečných věcech IMO nebo multimodální formulář IMDG a deklarace odesilatele IATA –, kontrolní seznam, označení kusů v plné velikosti nebo v malé uživatelské velikosti a u letecké přepravy datový list pro letecký nákladní list.
• Pro hlavní zásilku: konsolidační manifest, seznam kontejnerů, balicí list každé jednotky, nakládací list podle odesilatelů a datový list hlavního dokladu.
• Pro dopravní jednotku: osvědčení o naplnění kontejneru nebo vozidla, multimodální formulář pro nebezpečné věci, zpráva o oddělování v jednotce, kontrolní seznam před podpisem osvědčení a štítek konsolidace.
• Pro přepravu: manifest nebezpečných věcí, zpráva o oddělování mezi jednotkami na palubě, zpráva o mezní hodnotě výjimky podle ADR 1.1.3.6, list omezení jízdy, nakládací list, oznámení veliteli letadla (NOTOC) a souhrnný přepravní doklad vozidla.
• Pro nákladní list: návrh, podepsané vyhotovení, připojený přepravní doklad ADR a důkazní protokol.

Co API ověřuje

V zásilce. Oddělování mezi společně přepravovanými věcmi, množstevní limity příslušného pokynu pro balení i režimů omezených a vyňatých množství, přípustnost věcí pro daný druh dopravy, soulad obalu s předpisy a úplnost prohlášení. Pokud něco nevyhovuje, odpověď uvede, které pravidlo není splněno a s jakými hodnotami, takže zprávu lze zobrazit ve vaší vlastní aplikaci.

V konsolidaci. Oddělování uvnitř dopravní jednotky, oddělování mezi jednotkami naloženými v téže přepravě, výpočet mezní hodnoty podle 1.1.3.6 ADR pro danou přepravu včetně rozpisu a omezení jízdy vrácená jako data, například kód omezení pro tunely nebo přítomnost vysoce rizikových nebezpečných věcí.

Podporované předpisy a druhy přepravy

ADR pro silniční, IMDG pro námořní a IATA pro leteckou přepravu a 49 CFR. Tři hlavní předpisy se spravují společně, nikoli jako samostatné moduly, takže zásilku, která změní druh dopravy, není nutné připravovat znovu.

API podporuje společné balení, přepravní obalové soubory, cisterny, přepravu ve volně loženém stavu, prázdné nevyčištěné obaly, odpady, výbušné látky a předměty třídy 1 – s čistou hmotností výbušniny na kus – a radioaktivní látky třídy 7, vždy s údaji, které každý z těchto případů vyžaduje. Texty dokumentů se vystavují v devatenácti jazycích.

Dostupnost

Služba je provozována ve třech regionech — Evropa, Amerika a Asie a Tichomoří — a každý z nich má vlastní adresu, takže integrace pracuje s regionem, ve kterém je veden účet. Infrastruktura je redundantní a nepřetržitě monitorovaná.

Jak začít

Požádejte o bezplatnou dvoutýdenní zkušební verzi a s ní i o přístupové údaje ke službě. Autentizace využívá OAuth 2.0 s grantem client credentials: váš systém získá přístupový token a odesílá jej s každým požadavkem.

Úplná specifikace je zveřejněna ve formátu OpenAPI a lze ji číst, procházet a použít k vygenerování klienta ve vašem programovacím jazyce dříve, než napíšete jediný řádek integračního kódu.