API et intégration avec l'ERP
Comment DGAssistant s'insère dans votre ERP, votre système de gestion d'entrepôt ou votre plateforme d'expédition.
Ai-je besoin d'un module particulier pour utiliser l'API ?
Oui, l'API est un module licencié séparément, qui s'ajoute à vos licences standard. Vous l'ajoutez à votre abonnement au moment où vous décidez d'intégrer.
Comment l'usage de l'API est-il mesuré et facturé ?
L'API est comptée par licence : chacune couvre 1 500 envois et 7 500 appels de service par an, et autorise la base de données à contenir jusqu'à 5 000 objets autres que des envois, tels que les marchandises et les intervenants (destinataires, fournisseurs, conducteurs et les autres). Si vous prévoyez un volume supérieur, il suffit d'ajouter des licences. Le prix unitaire exact du module API figure aux côtés du reste du catalogue dans notre boutique et peut être inclus dans tout devis personnalisé.
Quelles sont les deux façons d'utiliser l'API : par lot ou interactive ?
Le mode par lot reçoit la description complète de l'envoi en un seul appel de service — idéal lorsque l'ERP connaît déjà les marchandises, les intervenants et les quantités. Le mode interactif permet de construire l'envoi étape par étape en validant chaque marchandise au fur et à mesure ; il se rapproche du fonctionnement de l'application web et convient lorsque vous devez bâtir des parcours guidés par l'utilisateur au-dessus de l'API.
Dois-je créer les marchandises et les intervenants à l'avance ou les transmettre à la volée ?
Les deux sont possibles. L'approche recommandée est celle des « données prédéfinies » : créez vos marchandises et vos intervenants une fois dans l'application web (ou importez-les) et référencez-les par leur code dans vos appels. L'approche à la volée permet de tout transmettre à chaque appel, ce qui est commode lorsque votre ERP est le référentiel de ces données et que vous ne souhaitez pas les précharger.
Comment récupérer les PDF produits au moyen de l'API ?
Deux possibilités existent. Vous pouvez recevoir les documents dans la réponse de l'API sous forme de PDF encodés en base64 (document de transport, déclaration de l'expéditeur, liste de vérification, marquage des colis, etc.), ou faire en sorte que la plateforme les envoie d'elle-même par courrier électronique à une adresse configurée.
Puis-je imprimer automatiquement les documents produits par l'API ?
Oui. Deux schémas fonctionnent bien : (a) votre ERP télécharge le PDF depuis l'API et l'envoie à sa propre file d'impression ; (b) DGAssistant envoie les documents à une boîte aux lettres dédiée et un petit utilitaire d'impression automatique, de votre côté, les imprime sur la bonne imprimante. De nombreux clients retiennent la voie du courrier électronique, car elle n'exige aucun code supplémentaire côté ERP.
Où se trouve la spécification de l'API ?
La spécification OpenAPI complète, avec des exemples interactifs, est publiée dans la documentation de l'API de marchandises dangereuses. Nous fournissons en outre un projet SoapUI avec des appels de test réalistes afin que vos développeurs puissent l'explorer en quelques minutes.
Qu'est-ce que le requestGuid et pourquoi est-il exigé ?
Chaque appel de l'API doit comporter un requestGuid unique qui identifie la demande dans nos journaux et permet à notre support de retrouver la transaction exacte lorsque vous signalez un incident. Toute valeur alphanumérique unique est acceptée ; nous recommandons de produire un UUID/GUID standard côté client.
Quelle est la cause la plus fréquente d'échec d'un premier appel à l'API ?
Des identifiants que le service n'accepte pas : soit un en-tête HTTP Basic Authorization absent ou erroné, soit, lorsque l'appel est authentifié par OAuth2, un jeton d'accès jamais demandé, appartenant à un autre environnement ou déjà expiré. Une adresse de support dédiée permet de confirmer que l'API répond et que vos identifiants sont valables. Si vous restez bloqué, envoyez-nous la requête et la réponse HTTP complètes (avec le requestGuid) ainsi qu'une description du comportement attendu — c'est ce qui débloque le plus vite la situation.