Vai al contenuto

API REST per merci pericolose

Che cosa fa l'API

Connessione fra DGAssistant e un sistema gestionale

Spedizioni. L'API REST JSON di DGAssistant crea la spedizione di merci pericolose dal Suo sistema gestionale o logistico e restituisce la dichiarazione dello speditore, la lista di controllo e la marcatura dei colli, già verificate rispetto alla regolamentazione applicabile. Il Suo sistema conserva i dati commerciali; DGAssistant fornisce la conoscenza normativa e i documenti.

Consolidamento. L'API copre anche il raggruppamento di spedizioni di più speditori, lungo i suoi due assi. L'asse contrattuale è la spedizione principale — una prenotazione, un consolidamento marittimo o aereo, un groupage stradale — con i suoi operatori, i suoi riferimenti, le spedizioni a essa collegate, i suoi passaggi di stato e la sua storia. L'asse fisico è l'unità di trasporto (container, veicolo, rimorchio o unità di carico) e il movimento di trasporto (viaggio, volo o tragitto) con i suoi scali, insieme a navi, veicoli e luoghi dell'account. Più della metà del servizio è dedicata a questa parte.

Aprire la specifica dell'API per merci pericolose

Due modi di lavorare: a lotti e interattivo

A lotti. Un'unica chiamata porta la specifica completa della spedizione con tutte le sue merci. È la via pensata per i sistemi gestionali e logistici che inviano spedizioni già composte.

Interattivo. Prima si apre la spedizione e poi si aggiungono le merci una a una. Ogni risposta riporta i messaggi di verifica di quanto appena aggiunto, affinché la Sua applicazione possa mostrarli all'utente mentre la spedizione viene preparata.

Dati predefiniti o dati nella chiamata

Dati predefiniti. I prodotti e gli operatori — speditori, vettori, destinatari, caricatori e conducenti — si creano in anticipo e l'API ne usa i codici. È il modo più semplice di lavorare e quello che consigliamo, perché la classificazione normativa si risolve una volta e si riusa in ogni spedizione.

Dati nella chiamata. I prodotti e gli operatori si definiscono nella stessa chiamata che crea la spedizione. Si adatta ai sistemi che non tengono un catalogo proprio o che spediscono merci occasionali.

I documenti che restituisce

L'API restituisce gli stessi documenti prodotti dall'applicazione. Quelli della spedizione e del consolidamento si recuperano in PDF, XLSX o DOCX, quelli della spedizione si possono inoltre inviare per posta elettronica dal servizio stesso; quelli della lettera di vettura, in PDF.

  • Per ogni spedizione: il documento di trasporto della regolamentazione applicabile —il documento di trasporto ADR, la dichiarazione di merci pericolose IMO o il modulo multimodale IMDG e la dichiarazione dello speditore IATA—, la lista di controllo, la marcatura dei colli a grandezza piena o in formato piccolo personalizzato e, per via aerea, la scheda dati per la lettera di trasporto aereo.
  • Per la spedizione principale: il manifesto di consolidamento, l'elenco dei container, la distinta dei colli di ciascuna unità, il foglio di carico per speditore e la scheda dati del documento principale.
  • Per l'unità di trasporto: il certificato di riempimento del container o del veicolo, il modulo multimodale per merci pericolose, il rapporto di segregazione dell'unità, la lista di controllo prima della firma del certificato e l'etichetta di consolidamento.
  • Per il viaggio: il manifesto delle merci pericolose, il rapporto di segregazione fra unità a bordo, il rapporto della soglia di esenzione dell'ADR 1.1.3.6, la scheda delle restrizioni del viaggio, il foglio di carico, la notifica al comandante (NOTOC) e il documento di trasporto consolidato del veicolo.
  • Per la lettera di vettura: la bozza, la copia firmata, il documento di trasporto ADR allegato e il rapporto probatorio.

Che cosa verifica l'API

Nella spedizione. La segregazione fra le merci trasportate insieme, i limiti di quantità dell'istruzione di imballaggio applicabile e dei regimi di quantità limitata ed esente, l'ammissibilità delle merci per il modo di trasporto, la legittimità dell'imballaggio e la completezza della dichiarazione. Quando qualcosa non è conforme, la risposta indica quale regola non è soddisfatta e con quali valori, affinché il messaggio possa essere mostrato nella Sua applicazione.

Nel consolidamento. La segregazione all'interno dell'unità di trasporto, la segregazione fra le unità caricate nello stesso movimento, il calcolo della soglia 1.1.3.6 dell'ADR per il movimento con il relativo dettaglio, e le restrizioni del tragitto restituite come dati, quali il codice di restrizione in galleria o la presenza di merci pericolose ad alto rischio.

Regolamentazioni e tipi di trasporto coperti

ADR per la strada, IMDG per il mare, IATA per l'aria e 49 CFR. Le tre regolamentazioni principali sono gestite insieme e non come moduli separati, cosicché una spedizione che cambia modo di trasporto non debba essere preparata di nuovo.

Imballaggio in comune, sovrimballaggi, cisterne, trasporto alla rinfusa, imballaggi vuoti non ripuliti, rifiuti, esplosivi della classe 1 —con la loro massa netta esplosiva per collo— e materie radioattive della classe 7 sono supportati, con i dati che ciascuno richiede. I testi dei documenti sono emessi in diciannove lingue.

Disponibilità

Il servizio è pubblicato in tre regioni — Europa, Americhe e Asia-Pacifico — ciascuna con il proprio indirizzo, affinché l'integrazione operi verso la regione in cui è tenuto l'account. L'infrastruttura è ridondante e sorvegliata senza interruzione.

Come iniziare

Richieda una prova gratuita di due settimane e, con essa, le credenziali del servizio. L'autenticazione usa OAuth 2.0 con il metodo «client credentials»: il Suo sistema ottiene un token di accesso e lo invia in ogni richiesta.

La specifica completa è pubblicata in formato OpenAPI e può essere letta, esplorata e usata per generare un client nel Suo linguaggio prima di scrivere una sola riga di codice di integrazione.

Sezioni della specifica dell'API

Sezione
PanoramicaPresentazione dell'API e dei suoi limiti di utilizzo, con i file OpenAPI 3.0 e 2.0 della specifica e l'indice di tutte le sue sezioni.Aprire
AutenticazioneToken di accesso OAuth2 rilasciati con il metodo «client credentials», in alternativa all'autenticazione HTTP Basic per tutte le operazioni autenticate.Aprire
Verifiche di connessioneVerifica della disponibilità dell'API, delle credenziali dell'utente dell'API e delle richieste con e senza autenticazione.Aprire
Dati di riferimentoMerci pericolose e radionuclidi, imballaggi e istruzioni di imballaggio, codici, paesi e luoghi a cui fanno riferimento le spedizioni, i prodotti e il consolidamento.Aprire
ProdottiProdotti semplici e in imballaggio in comune del catalogo, compresa la creazione interattiva di un prodotto in imballaggio in comune per una spedizione.Aprire
OperatoriOperatori predefiniti: speditori, destinatari, caricatori, trasportatori, fornitori e conducenti.Aprire
Veicoli, rimorchi e naviVeicoli, rimorchi e navi degli account, con la targa, la designazione ADR e il documento di conformità.Aprire
Luoghi e restrizioniPorti, aeroporti e terminal degli account e le restrizioni che si applicano quando vi si pianifica o vi si carica un'unità di trasporto.Aprire
SpedizioniCreazione di una spedizione con tutto il suo contenuto (a lotti) o con il suo primo contenuto (interattiva), consultazione ed eliminazione delle spedizioni.Aprire
Contenuto della spedizioneProdotti, imballaggi in comune e sovrimballaggi aggiunti a una spedizione trattata in modo interattivo o rimossi da essa.Aprire
Documenti della spedizioneDocumenti di una spedizione (documento di trasporto, lista di controllo, marcatura dei colli e altri), il loro invio per posta elettronica e i documenti congelati.Aprire
Lettere di vetturaLettere di vettura CMR, elettroniche (e-CMR) e nazionali, dalla verifica della copertura del percorso da parte del Protocollo e-CMR fino all'emissione, alla consegna e all'annullamento.Aprire
Richieste di consolidamentoRichieste di consolidamento degli account cliente, o del loro consulente per la sicurezza per loro conto, e decisioni del consolidatore.Aprire
Spedizioni principaliSpedizioni principali con le relative spedizioni e il flusso di approvazione.Aprire
Unità di trasportoUnità di trasporto, il loro contenuto, le verifiche di segregazione e lo storico dei movimenti.Aprire
Viaggi e scaliViaggi marittimi, voli e tragitti stradali con i relativi scali e unità di trasporto, verifiche di segregazione, calcolo della soglia di carico (ADR 1.1.3.6) e restrizioni.Aprire
Documenti di consolidamentoDocumenti delle spedizioni principali, delle unità di trasporto e dei viaggi.Aprire
WebhookSottoscrizioni webhook dell'account, il relativo test e le consegne recenti.Aprire

Per constatare quanto sia rapida e semplice l'integrazione, dispone di due settimane di prova senza alcun impegno