REST API dla towarów niebezpiecznych

Do czego służy API

Przesyłki. Interfejs JSON REST API DGAssistant tworzy przesyłkę towarów niebezpiecznych z poziomu Państwa własnego systemu zarządzania lub systemu logistycznego i zwraca deklarację nadawcy, listę kontrolną oraz oznakowanie sztuk przesyłek, już zweryfikowane pod kątem mających zastosowanie przepisów. Państwa system przechowuje dane handlowe, a DGAssistant zapewnia wiedzę o przepisach i dokumenty.

Konsolidacja. API obejmuje również grupowanie przesyłek wielu nadawców w dwóch wymiarach. Wymiar umowny to przesyłka główna — rezerwacja, konsolidacja morska lub lotnicza, drogowy przewóz drobnicowy — wraz z jej stronami, numerami referencyjnymi, dołączonymi do niej przesyłkami, zmianami statusu i historią. Wymiar fizyczny to sprzęt transportowy (kontener, pojazd, przyczepa lub jednostkowe urządzenie ładunkowe) i przewóz (podróż morska, lot lub przejazd) wraz z zawinięciami, a także statki, pojazdy i lokalizacje zdefiniowane w koncie. Tej części poświęcona jest ponad połowa usługi.

Otwórz specyfikację API dla towarów niebezpiecznych

Dwa tryby pracy: wsadowy i interaktywny

Tryb wsadowy. Jedno wywołanie zawiera pełną specyfikację przesyłki ze wszystkimi jej towarami. Ten tryb jest przeznaczony dla systemów zarządzania i systemów logistycznych, które przesyłają kompletne, już zestawione przesyłki.

Tryb interaktywny. Najpierw otwiera się przesyłkę, a następnie dodaje się towary jeden po drugim. Każda odpowiedź zawiera komunikaty walidacji dotyczące właśnie dodanej pozycji, dzięki czemu Państwa aplikacja może je wyświetlać użytkownikowi w trakcie przygotowywania przesyłki.

Dane predefiniowane lub dane podawane na bieżąco

Dane predefiniowane. Produkty i uczestników — nadawców, przewoźników, odbiorców, załadowców i kierowców — tworzy się wcześniej, a API posługuje się ich kodami. Jest to najprostszy i zalecany przez nas sposób pracy, ponieważ klasyfikację według przepisów ustala się raz i wykorzystuje ponownie w każdej przesyłce.

Dane podawane na bieżąco. Produkty i uczestników definiuje się w tym samym wywołaniu, które tworzy przesyłkę. To rozwiązanie jest odpowiednie dla systemów, które nie prowadzą własnego katalogu lub wysyłają towary okazjonalnie.

Zwracane dokumenty

API zwraca te same dokumenty, które generuje aplikacja. Dokumenty przesyłki i konsolidacji pobiera się w formacie PDF, XLSX lub DOCX, a dokumenty przesyłki można również wysłać pocztą elektroniczną bezpośrednio z usługi; dokumenty listu przewozowego są dostępne w formacie PDF.

• Dla każdej przesyłki: dokument przewozowy wymagany przez mające zastosowanie przepisy (dokument przewozowy ADR, deklaracja towarów niebezpiecznych IMO lub multimodalny dokument przewozowy IMDG oraz deklaracja nadawcy IATA), lista kontrolna, oznakowanie sztuk przesyłek w pełnym rozmiarze lub w małym rozmiarze niestandardowym oraz, w transporcie lotniczym, karta danych do lotniczego listu przewozowego.
• Dla przesyłki głównej: manifest konsolidacyjny, wykaz kontenerów, lista pakowa każdej jednostki, zestawienie ładunku według nadawców i karta danych dokumentu głównego.
• Dla jednostki transportowej: certyfikat pakowania kontenera lub pojazdu, multimodalny dokument przewozowy dla towarów niebezpiecznych, raport segregacji jednostki, lista kontrolna przed podpisaniem certyfikatu i etykieta konsolidacji.
• Dla przewozu: manifest towarów niebezpiecznych, raport segregacji między jednostkami na pokładzie, raport progu wyłączenia ADR 1.1.3.6, karta ograniczeń przejazdu, zestawienie ładunku, powiadomienie kapitana (NOTOC) i skonsolidowany dokument przewozowy pojazdu.
• Dla listu przewozowego: projekt, podpisana kopia, załączony dokument przewozowy ADR i raport dowodowy.

Co weryfikuje API

W przesyłce. Segregacja między towarami przewożonymi razem, limity ilościowe mającej zastosowanie instrukcji pakowania oraz przepisów dotyczących ilości ograniczonych i wyłączonych, dopuszczalność towarów w danym rodzaju transportu, zgodność opakowania z przepisami i kompletność deklaracji. Jeżeli coś jest niezgodne z przepisami, odpowiedź wskazuje, która reguła nie została spełniona i przy jakich wartościach, tak aby komunikat można było wyświetlić w Państwa aplikacji.

W konsolidacji. Segregacja wewnątrz jednostki transportowej, segregacja między jednostkami załadowanymi w ramach tego samego przewozu, obliczenie progu określonego w 1.1.3.6 ADR dla przewozu wraz ze szczegółowym podziałem oraz ograniczenia przejazdu zwracane w postaci danych, takie jak kod ograniczeń przewozu przez tunele lub obecność towarów niebezpiecznych dużego ryzyka.

Obsługiwane przepisy i rodzaje przewozu

ADR dla transportu drogowego, IMDG dla morskiego, IATA dla lotniczego oraz 49 CFR. Trzy główne zbiory przepisów są obsługiwane łącznie, a nie jako oddzielne moduły, dzięki czemu przesyłki, która zmienia rodzaj transportu, nie trzeba przygotowywać od nowa.

Obsługiwane są pakowanie razem, opakowania zbiorcze, cysterny, przewóz luzem, opakowania próżne nieoczyszczone, odpady, materiały wybuchowe klasy 1 – z masą netto materiału wybuchowego na sztukę przesyłki – oraz materiały promieniotwórcze klasy 7, wraz z danymi wymaganymi w każdym z tych przypadków. Teksty dokumentów są generowane w dziewiętnastu językach.

Dostępność

Usługa jest udostępniana w trzech regionach — Europa, obie Ameryki oraz Azja i Pacyfik — z których każdy ma własny adres, dzięki czemu integracja działa z regionem, w którym prowadzone jest konto. Infrastruktura jest redundantna i monitorowana przez całą dobę.

Jak zacząć

Wystarczy poprosić o bezpłatną dwutygodniową wersję próbną, a wraz z nią o dane uwierzytelniające do usługi. Uwierzytelnianie odbywa się w standardzie OAuth 2.0 z przepływem client credentials: Państwa system uzyskuje token dostępu i przesyła go w każdym żądaniu.

Pełna specyfikacja jest opublikowana w formacie OpenAPI; można ją przeczytać, przeanalizować i wykorzystać do wygenerowania klienta w używanym przez Państwa języku programowania, zanim powstanie choćby jeden wiersz kodu integracji.