Aller au contenu

API REST de marchandises dangereuses

Ce que fait l'API

Connexion entre DGAssistant et un système de gestion

Envois. L'API REST JSON de DGAssistant crée l'envoi de marchandises dangereuses depuis votre propre système de gestion ou de logistique et renvoie la déclaration de l'expéditeur, la liste de contrôle et le marquage des colis, déjà vérifiés au regard de la réglementation applicable. Votre système conserve les données commerciales ; DGAssistant apporte la connaissance réglementaire et les documents.

Groupage. L'API couvre également le regroupement d'envois de plusieurs expéditeurs, selon ses deux axes. L'axe contractuel est l'envoi principal — une réservation, un groupage maritime ou aérien, un groupage routier — avec ses intervenants, ses références, les envois qui y sont rattachés, ses changements d'état et son historique. L'axe physique est l'engin de transport (conteneur, véhicule, remorque ou unité de chargement) et l'opération de transport (voyage, vol ou trajet) avec ses escales, ainsi que les navires, les véhicules et les lieux du compte. Plus de la moitié du service est consacrée à cette partie.

Ouvrir la spécification de l'API de marchandises dangereuses

Deux manières de travailler : par lots et interactive

Par lots. Un seul appel porte la spécification complète de l'envoi avec toutes ses marchandises. C'est la voie destinée aux systèmes de gestion et de logistique qui transmettent des envois déjà constitués.

Interactive. L'envoi est d'abord ouvert, puis les marchandises sont ajoutées une à une. Chaque réponse porte les messages de validation de ce qui vient d'être ajouté, afin que votre propre application puisse les montrer à l'utilisateur pendant la préparation.

Données prédéfinies ou données au fil de l'appel

Données prédéfinies. Les produits et les intervenants — expéditeurs, transporteurs, destinataires, chargeurs et conducteurs — sont créés au préalable et l'API utilise leurs codes. C'est la manière la plus simple de travailler et celle que nous recommandons, car la classification réglementaire est réglée une fois puis réutilisée à chaque envoi.

Données au fil de l'appel. Les produits et les intervenants sont définis dans l'appel même qui crée l'envoi. Cela convient aux systèmes qui ne tiennent pas de catalogue propre ou qui expédient des marchandises occasionnelles.

Les documents qu'elle renvoie

L'API renvoie les mêmes documents que ceux que produit l'application. Ceux de l'envoi et du groupage sont récupérés en PDF, XLSX ou DOCX, ceux de l'envoi peuvent en outre être envoyés par courrier électronique depuis le service lui-même ; ceux de la lettre de voiture, en PDF.

  • Pour chaque envoi : le document de transport de la réglementation applicable —le document de transport ADR, la déclaration de marchandises dangereuses OMI ou le formulaire multimodal IMDG, et la déclaration de l'expéditeur IATA—, la liste de contrôle, le marquage des colis en taille réelle ou en petite taille personnalisée et, par air, la fiche de données de la lettre de transport aérien.
  • Pour l'envoi principal : le manifeste de groupage, la liste des conteneurs, la liste de colisage de chaque unité, la feuille de chargement par expéditeur et la fiche de données du document principal.
  • Pour l'unité de transport : le certificat d'empotage du conteneur ou du véhicule, le formulaire multimodal pour le transport de marchandises dangereuses, le rapport de ségrégation de l'unité, la liste de vérification préalable à la signature du certificat et l'étiquette de groupage.
  • Pour le voyage : le manifeste de marchandises dangereuses, le rapport de ségrégation entre unités à bord, le rapport du seuil d'exemption de l'ADR 1.1.3.6, la fiche de restrictions du voyage, la feuille de chargement, la notification au commandant de bord (NOTOC) et le document de transport consolidé du véhicule.
  • Pour la lettre de voiture : le brouillon, la copie signée, le document de transport ADR joint et le rapport de preuve.

Ce que l'API vérifie

Dans l'envoi. La ségrégation entre les marchandises transportées ensemble, les limites de quantité de l'instruction d'emballage applicable et des régimes de quantité limitée et exceptée, l'admissibilité des marchandises pour le mode de transport, la conformité de l'emballage et l'exhaustivité de la déclaration. Lorsqu'un point n'est pas respecté, la réponse indique quelle règle n'est pas satisfaite et avec quelles valeurs, afin que le message puisse être affiché dans votre propre application.

Dans le groupage. La ségrégation à l'intérieur de l'engin de transport, la ségrégation entre les engins chargés dans la même opération, le calcul du seuil 1.1.3.6 de l'ADR pour l'opération avec son détail, et les restrictions du trajet renvoyées sous forme de données, tels le code de restriction en tunnels ou la présence de marchandises dangereuses à haut risque.

Réglementations et types de transport couverts

ADR pour la route, IMDG pour la mer, IATA pour l'air et 49 CFR. Les trois réglementations principales sont gérées ensemble et non comme des modules séparés, de sorte qu'un envoi qui change de mode de transport n'a pas à être préparé de nouveau.

L'emballage en commun, les suremballages, les citernes, le transport en vrac, les emballages vides non nettoyés, les déchets, les explosifs de la classe 1 —avec leur masse nette de matière explosible par colis— et les matières radioactives de la classe 7 sont pris en charge, avec les données que chacun requiert. Les textes des documents sont édités en dix-neuf langues.

Disponibilité

Le service est publié dans trois régions — Europe, Amériques et Asie-Pacifique —, chacune avec son adresse propre, afin que l'intégration travaille avec la région où le compte est tenu. L'infrastructure est redondante et surveillée en permanence.

Comment commencer

Demandez un essai gratuit de deux semaines, et avec lui les identifiants du service. L'authentification emploie OAuth 2.0 avec le mode « client credentials » : votre système obtient un jeton d'accès et l'envoie dans chaque requête.

La spécification complète est publiée au format OpenAPI et peut être lue, explorée et utilisée pour engendrer un client dans votre propre langage avant d'écrire la moindre ligne de code d'intégration.

Sections de la spécification de l'API

Section
Vue d'ensemblePrésentation de l'API et de ses limites d'utilisation, avec les fichiers OpenAPI 3.0 et 2.0 de la spécification et l'index de toutes ses sections.Ouvrir
AuthentificationJetons d'accès OAuth2 délivrés selon le mode « client credentials », en alternative à l'authentification HTTP Basic pour toutes les opérations authentifiées.Ouvrir
Contrôles de connexionVérification de la disponibilité de l'API, des identifiants de l'utilisateur de l'API et des requêtes avec et sans authentification.Ouvrir
Données de référenceMarchandises dangereuses et radionucléides, emballages et instructions d'emballage, codes, pays et lieux auxquels renvoient les envois, les produits et le groupage.Ouvrir
ProduitsProduits simples et en emballage en commun du catalogue, y compris la création interactive d'un produit en emballage en commun pour un envoi.Ouvrir
IntervenantsIntervenants prédéfinis : expéditeurs, destinataires, chargeurs, transporteurs, fournisseurs et conducteurs.Ouvrir
Véhicules, remorques et naviresVéhicules, remorques et navires des comptes, avec leur immatriculation, leur désignation ADR et leur document de conformité.Ouvrir
Lieux et restrictionsPorts, aéroports et terminaux des comptes, et restrictions qui s'appliquent lorsqu'un engin de transport y est planifié ou chargé.Ouvrir
EnvoisCréation d'un envoi avec tout son contenu (par lots) ou avec son premier contenu (interactif), consultation et suppression des envois.Ouvrir
Contenu de l'envoiProduits, emballages en commun et suremballages ajoutés à un envoi traité de manière interactive ou retirés de celui-ci.Ouvrir
Documents de l'envoiDocuments d'un envoi (document de transport, liste de contrôle, marquage des colis et autres), leur envoi par courrier électronique et documents figés.Ouvrir
Lettres de voitureLettres de voiture CMR, électroniques (e-CMR) et nationales, de la vérification de la couverture de l'itinéraire par le protocole e-CMR jusqu'à l'émission, la livraison et l'annulation.Ouvrir
Demandes de groupageDemandes de groupage des comptes clients, ou de leur conseiller à la sécurité en leur nom, et décisions du groupeur.Ouvrir
Envois principauxEnvois principaux avec leurs envois et leur circuit d'approbation.Ouvrir
Engins de transportEngins de transport, leur contenu, leurs contrôles de ségrégation et l'historique de leurs mouvements.Ouvrir
Voyages et escalesVoyages maritimes, vols et trajets routiers avec leurs escales et leurs engins de transport, contrôles de ségrégation, calcul du seuil de chargement (ADR 1.1.3.6) et restrictions.Ouvrir
Documents de groupageDocuments des envois principaux, des engins de transport et des voyages.Ouvrir
WebhooksAbonnements webhook du compte, leur test et leurs livraisons récentes.Ouvrir

Pour voir à quel point l'intégration est rapide et simple, profitez d'un essai de deux semaines sans engagement