REST API pre nebezpečné veci

Čo API robí

Zásielky tovaru. JSON REST API DGAssistant vytvára zásielku nebezpečných vecí z vášho vlastného podnikového alebo logistického systému a vracia vyhlásenie odosielateľa, kontrolný zoznam a označenie kusov, už overené podľa príslušného predpisu. Váš systém uchováva obchodné údaje; DGAssistant dodáva znalosť predpisov a doklady.

Konsolidácia. API pokrýva aj zoskupovanie zásielok viacerých odosielateľov, a to v oboch jeho rovinách. Zmluvnou rovinou je hlavná zásielka — rezervácia, námorná alebo letecká konsolidácia, cestná zberná preprava — s jej účastníkmi, referenciami, pripojenými zásielkami, zmenami stavu a históriou. Fyzickou rovinou je prepravné zariadenie (kontajner, vozidlo, prípojné vozidlo alebo jednotkové nákladové zariadenie) a preprava (námorná cesta, let alebo jazda) s jej zastávkami spolu s plavidlami, vozidlami a miestami účtu. Tejto časti je venovaná viac ako polovica služby.

Otvoriť špecifikáciu API pre nebezpečné veci

Dva spôsoby práce: dávkový a interaktívny

Dávkový režim. Jediné volanie obsahuje úplnú špecifikáciu zásielky so všetkými jej vecami. Tento spôsob je určený pre podnikové a logistické systémy, ktoré odosielajú celé, už zostavené zásielky.

Interaktívny režim. Najprv sa otvorí zásielka a veci sa pridávajú jedna po druhej. Každá odpoveď obsahuje overovacie hlásenia k tomu, čo sa práve pridalo, aby ich vaša vlastná aplikácia mohla zobraziť používateľovi ešte počas prípravy zásielky.

Preddefinované údaje alebo údaje zadávané priebežne

Preddefinované údaje. Výrobky a účastníci — odosielatelia, dopravcovia, príjemcovia, nakladajúce organizácie a vodiči — sa vytvoria vopred a API používa ich kódy. Je to najjednoduchší spôsob práce a ten, ktorý odporúčame, pretože klasifikácia podľa predpisov sa určí raz a znova sa použije v každej zásielke.

Údaje zadávané priebežne. Výrobky a účastníci sa definujú v tom istom volaní, ktorým sa vytvára zásielka. Hodí sa pre systémy, ktoré nevedú vlastný katalóg alebo ktoré odosielajú veci len príležitostne.

Dokumenty, ktoré API vracia

API vracia tie isté dokumenty, ktoré vytvára aplikácia. Dokumenty zásielky a konsolidácie sa získavajú vo formáte PDF, XLSX alebo DOCX a dokumenty zásielky možno odoslať aj e-mailom priamo zo služby; dokumenty nákladného listu sa získavajú vo formáte PDF.

• Pre každú zásielku: prepravný doklad podľa príslušného predpisu – prepravný doklad ADR, vyhlásenie IMO o nebezpečných veciach alebo multimodálne tlačivo IMDG a vyhlásenie odosielateľa IATA –, kontrolný zoznam, označenie kusov v plnej veľkosti alebo v malom vlastnom formáte a pri leteckej preprave dátový list pre letecký nákladný list.
• Pre hlavnú zásielku: konsolidačný manifest, zoznam kontajnerov, baliaci list každej jednotky, nakladací list podľa odosielateľov a dátový list hlavného dokladu.
• Pre dopravnú jednotku: osvedčenie o ložení kontajnera alebo vozidla, multimodálne tlačivo pre nebezpečné veci, správa o oddeľovaní v jednotke, kontrolný zoznam pred podpisom osvedčenia a štítok konsolidácie.
• Pre prepravu: manifest nebezpečných vecí, správa o oddeľovaní medzi jednotkami na palube, správa o prahu výnimky podľa 1.1.3.6 ADR, list obmedzení jazdy, nakladací list, oznámenie veliteľovi lietadla (NOTOC) a súhrnný prepravný doklad vozidla.
• Pre nákladný list: návrh, podpísaná kópia, pripojený prepravný doklad ADR a dôkazný protokol.

Čo API overuje

V zásielke. Oddeľovanie vecí prepravovaných spoločne, množstevné limity uplatniteľnej obalovej inštrukcie a režimov obmedzených a vyňatých množstiev, prípustnosť vecí pre daný druh prepravy, súlad obalu s predpismi a úplnosť vyhlásenia. Ak niečo nevyhovuje, odpoveď uvedie, ktoré pravidlo nie je splnené a pri akých hodnotách, aby sa hlásenie mohlo zobraziť vo vašej vlastnej aplikácii.

V konsolidácii. Oddeľovanie v rámci dopravnej jednotky, oddeľovanie medzi jednotkami naloženými v tej istej preprave, výpočet prahu podľa 1.1.3.6 ADR pre prepravu s jeho rozpisom a obmedzenia jazdy vrátené ako údaje, napríklad kód obmedzenia pre tunely alebo prítomnosť nebezpečných vecí s mimoriadnymi dôsledkami.

Pokryté predpisy a druhy prepravy

ADR pre cestnú, IMDG pre námornú a IATA pre leteckú prepravu a tiež 49 CFR. Tri hlavné predpisy sa spravujú spoločne, nie ako samostatné moduly, takže zásielku, ktorá zmení druh prepravy, nie je potrebné pripravovať znova.

Podporované sú zmiešané balenie, obalové súbory, cisterny, preprava vo voľne loženom stave, vyprázdnené nevyčistené obaly, odpady, výbušniny triedy 1 – s čistou hmotnosťou výbušniny na kus – a rádioaktívny materiál triedy 7, vždy s údajmi, ktoré každý z nich vyžaduje. Texty dokladov sa vystavujú v devätnástich jazykoch.

Dostupnosť

Služba je publikovaná v troch regiónoch — Európa, Amerika a ázijsko-tichomorská oblasť — a každý z nich má vlastnú adresu, takže integrácia pracuje s regiónom, v ktorom je vedený účet. Infraštruktúra je redundantná a nepretržite monitorovaná.

Ako začať

Požiadajte o bezplatnú dvojtýždňovú skúšobnú verziu a spolu s ňou aj o prístupové údaje k službe. Autentifikácia využíva OAuth 2.0 s udelením oprávnenia typu client credentials: váš systém získa prístupový token a posiela ho v každej požiadavke.

Úplná špecifikácia je zverejnená vo formáte OpenAPI a ešte pred napísaním prvého riadka integračného kódu si ju môžete prečítať, preskúmať a vygenerovať z nej klienta vo svojom programovacom jazyku.