Documents
Émission, rectification et accès à vos documents récents.
Créer un document
Envoyez toutes les données du transport. La réponse est renvoyée après génération et stockage du PDF chiffré.
Une référence non nulle est unique par organisation et environnement. Répéter la référence avec les mêmes données normalisées et metadata renvoie le résultat original dans les 24 heures (200), sans émettre un autre PDF. Une nouvelle création renvoie 201. Des données différentes ou une référence d'un autre identifiant produisent 409 sans divulguer de documents. Sans référence, la déduplication n'est pas garantie.
Une référence dont le résultat a expiré renvoie 409 DOCUMENT_WINDOW_EXPIRED. Si le document est supprimé, son contenu n'est pas renvoyé et sa référence n'est pas réutilisable ; la nouvelle tentative renvoie 404. Utilisez les endpoints PUT pour rectifier.
Vous pouvez demander un jeton sk_demo_ sans compte ni organisation enregistrée. Il dure 24 heures à partir de son émission et fonctionne uniquement depuis l’IP publique qui l’a demandé. Un changement de réseau ou d’IP nécessite un autre jeton. La démo ajoute demo: true, expires_at, qr_url (alias de url) et pdf_url (alias de pdf_download_url). document_locale est la langue choisie lors de la demande du jeton (es par défaut). Les données et PDF temporaires sont distincts de l’archive réelle et ne sont pas chiffrés comme les documents réels.
Créer un document › Corps de la requête
transport_dateDate réelle du transport au format YYYY-MM-DD ; ce n'est pas l'instant de création du PDF.
Chargeur contractuel ; peut différer de l'entrepôt de départ et du client DeCA.
Transporteur effectuant réellement le transport, y compris le sous-traitant.
Nature et poids de la marchandise, ou grandeur alternative si nécessaire. Envoyez exactement une mesure.
Véhicule effectif ; si une remorque ou semi-remorque est présente, renseignez ses deux champs ensemble.
reference^[A-Za-z0-9-]+(?![\s…Référence personnelle facultative, unique par organisation et environnement et imprimée sur le PDF. Identifie les nouvelles tentatives et permet la consultation par référence. N'est pas libérée lors de la suppression du document.
Autorisation spéciale de circulation si nécessaire. Omettez-la ou envoyez null si elle ne s'applique pas.
observationsObservations que les intervenants demandent de faire figurer dans le document.
Objet JSON facultatif, conservé et renvoyé sans modification sémantique. Non imprimé sur le PDF. Maximum 16 KiB après sérialisation et 8 niveaux de profondeur.
Créer un document › Réponses
Nouvelle tentative idempotente ; renvoie le résultat original sans générer un autre PDF.
Table des alternatives
| Alternative | Critères de sélection |
|---|---|
| type = object · Champs obligatoires: uuid, reference, created_at +7 de plus | |
| type = object · Champs obligatoires: uuid, reference, created_at +11 de plus |
uuidUUID du document émis.
reference^[A-Za-z0-9-]+(?![\s… · obligatoireRéférence du client ou null.
created_atInstant original de création, en UTC.
urlURL HTTPS complète de téléchargement par QR, avec son secret. Ne pas enregistrer ni publier.
pdf_download_urlURL de téléchargement authentifié ; exige le Bearer de l'identifiant propriétaire dans les 24 heures.
rectifies_uuidUUID rectifié ou null lors d'une émission initiale.
La même metadata que dans la requête ; null si elle n'a pas été fournie.
document_localeLangue du PDF choisie à l'émission selon l'organisation. Conservée dans le résultat ; changer la langue de l'organisation ne modifie pas les documents existants. Ne change ni les champs JSON ni les messages d'erreur de l'API.
Rectifier un document
Identifiez le document précédent par UUID et envoyez toutes les données corrigées, sans modifications partielles. Seule la dernière version du même identifiant peut être rectifiée. Un document de plus de 24 heures peut être rectifié sans renvoyer son contenu précédent. Un document supprimé renvoie 404 et ne peut pas être rectifié.
Un document rectificatif est généré avec de nouveaux UUID, PDF et QR ; l'original et son QR sont conservés. Remettez le nouveau PDF au conducteur. Le champ reference du corps correspond à la nouvelle version, pas au document de l'URL.
Répéter le même PUT avec les mêmes données normalisées et metadata renvoie la rectification déjà émise pendant les 24 heures suivant sa création, sans générer une autre version. Cette vérification précède le rejet d'un document déjà rectifié et fonctionne aussi si la nouvelle tentative identifie le même document par référence. Modifier les données d'un document déjà rectifié renvoie 409. Un résultat expiré renvoie 409 DOCUMENT_WINDOW_EXPIRED. Si la rectification renvoyée est supprimée, la nouvelle tentative renvoie 404. Pour une autre rectification, utilisez l'UUID ou la référence de la dernière version.
Paramètres de chemin
uuidUUID public du document. Vous pouvez aussi utiliser /api/v1/documents/ref/{reference} avec la même méthode. Exemple : /api/v1/documents/ref/EXP-2026-004587.
Rectifier un document › Corps de la requête
transport_dateDate réelle du transport au format YYYY-MM-DD ; ce n'est pas l'instant de création du PDF.
Chargeur contractuel ; peut différer de l'entrepôt de départ et du client DeCA.
Transporteur effectuant réellement le transport, y compris le sous-traitant.
Nature et poids de la marchandise, ou grandeur alternative si nécessaire. Envoyez exactement une mesure.
Véhicule effectif ; si une remorque ou semi-remorque est présente, renseignez ses deux champs ensemble.
reference^[A-Za-z0-9-]+(?![\s…Nouvelle référence du document rectificatif, facultative et unique par organisation et environnement. Ne réutilisez pas la référence du document identifié dans l'URL.
Autorisation spéciale de circulation si nécessaire. Omettez-la ou envoyez null si elle ne s'applique pas.
observationsObservations que les intervenants demandent de faire figurer dans le document.
Objet JSON facultatif, conservé et renvoyé sans modification sémantique. Non imprimé sur le PDF. Maximum 16 KiB après sérialisation et 8 niveaux de profondeur.
Rectifier un document › Réponses
Document rectificatif émis, ou résultat d'une nouvelle tentative identique sans créer une autre version.
Table des alternatives
| Alternative | Critères de sélection |
|---|---|
| type = object · Champs obligatoires: uuid, reference, created_at +7 de plus | |
| type = object · Champs obligatoires: uuid, reference, created_at +11 de plus |
uuidUUID du document émis.
reference^[A-Za-z0-9-]+(?![\s… · obligatoireRéférence du client ou null.
created_atInstant original de création, en UTC.
urlURL HTTPS complète de téléchargement par QR, avec son secret. Ne pas enregistrer ni publier.
pdf_download_urlURL de téléchargement authentifié ; exige le Bearer de l'identifiant propriétaire dans les 24 heures.
rectifies_uuidUUID rectifié ou null lors d'une émission initiale.
La même metadata que dans la requête ; null si elle n'a pas été fournie.
document_localeLangue du PDF choisie à l'émission selon l'organisation. Conservée dans le résultat ; changer la langue de l'organisation ne modifie pas les documents existants. Ne change ni les champs JSON ni les messages d'erreur de l'API.
Supprimer un document
Suppression logique pour corriger des erreurs détectées lors de la génération d'un document, exclusivement avant sa remise au transporteur ou au conducteur et avant son utilisation pour un transport. L'intégration doit confirmer les deux conditions ; respecter le délai ne suffit pas. Si le document a déjà été remis ou utilisé, il doit être rectifié par PUT.
Autorisée uniquement tant que l'heure du serveur est antérieure à created_at + 2 heures ; à exactement 2 heures, elle n'est plus autorisée. Ni une consultation ni une nouvelle tentative ne redémarrent le délai. Chaque version utilise sa propre date de création. Seule la dernière version de l'identifiant authentifié peut être supprimée.
Le PDF, les données et la traçabilité sont conservés, mais le document disparaît de la liste. Les consultations par UUID ou référence, le téléchargement authentifié, le QR et les nouvelles tentatives qui renverraient le contenu répondent 404. La consultation d'état répond uniquement avec status: deleted pendant la fenêtre de consultation de 24 heures. La référence reste réservée. Aucun endpoint de réactivation n'existe ; la suppression conserve le fichier pour permettre une récupération future.
Répéter DELETE dans les mêmes 2 heures renvoie 204 sans modifier la date de suppression. Au-delà, la réponse est 409.
Le premier accès réussi au lien QR bloque aussi la suppression avec 409 DOCUMENT_ALREADY_ACCESSED. Cet accès ne prouve pas, à lui seul, que le transport a eu lieu.
Paramètres de chemin
uuidUUID public du document. Vous pouvez aussi utiliser /api/v1/documents/ref/{reference} avec la même méthode. Exemple : /api/v1/documents/ref/EXP-2026-004587.
Supprimer un document › Corps de la requête
reasonMotif de l'erreur détectée lors de la génération du document.
confirm_not_deliveredDoit être true pour supprimer : confirme l'absence de remise au transporteur ou au conducteur. false renvoie 409 DOCUMENT_ALREADY_DELIVERED.
confirm_not_usedDoit être true pour supprimer : confirme l'absence d'utilisation pour un transport. false renvoie 409 DOCUMENT_ALREADY_USED.
Supprimer un document › Réponses
Document marqué comme supprimé. Aucun corps de réponse.
Lister les documents récents
Renvoie des résumés sans PDF, secret QR ni metadata. Le serveur applique toujours la fenêtre de 24 heures et l'isolation des identifiants. Tri décroissant par date de création, avec UUID pour départager, pagination par page et filtres inclusifs de date de transport. La fenêtre est évaluée à chaque requête ; elle ne constitue pas un instantané stable entre les pages. L'historique n'est pas accessible.
Les documents supprimés ne figurent pas dans la liste.
Paramètres de requête
pagePage demandée, à partir de 1.
limitDocuments par page, de 1 à 100.
fromDate minimale de transport, incluse. N'étend pas la fenêtre de lecture.
toDate maximale de transport, incluse ; égale ou postérieure à from.
Lister les documents récents › Réponses
Page de documents récents. Une page sans résultats contient un tableau data vide.
Consulter un document
Récupère le résultat original dans les 24 heures, uniquement pour l'identifiant ayant émis le document. Inclut tous les champs acceptés et normalisés et la metadata sans modification sémantique.
Un UUID ou une référence inexistant, appartenant à un autre identifiant ou hors fenêtre renvoie le même 404, sans confirmer l'existence ni le propriétaire. Chaque référence identifie sa propre version et ne redirige pas vers une rectification ultérieure.
Un document supprimé renvoie 404. Utilisez la consultation d'état pour savoir s'il est supprimé.
Paramètres de chemin
uuidUUID public du document. Vous pouvez aussi utiliser /api/v1/documents/ref/{reference} avec la même méthode. Exemple : /api/v1/documents/ref/EXP-2026-004587.
Consulter un document › Réponses
Résultat original du document.
Table des alternatives
| Alternative | Critères de sélection |
|---|---|
| type = object · Champs obligatoires: uuid, reference, created_at +7 de plus | |
| type = object · Champs obligatoires: uuid, reference, created_at +11 de plus |
uuidUUID du document émis.
reference^[A-Za-z0-9-]+(?![\s… · obligatoireRéférence du client ou null.
created_atInstant original de création, en UTC.
urlURL HTTPS complète de téléchargement par QR, avec son secret. Ne pas enregistrer ni publier.
pdf_download_urlURL de téléchargement authentifié ; exige le Bearer de l'identifiant propriétaire dans les 24 heures.
rectifies_uuidUUID rectifié ou null lors d'une émission initiale.
La même metadata que dans la requête ; null si elle n'a pas été fournie.
document_localeLangue du PDF choisie à l'émission selon l'organisation. Conservée dans le résultat ; changer la langue de l'organisation ne modifie pas les documents existants. Ne change ni les champs JSON ni les messages d'erreur de l'API.
Consulter l'état
Renvoie uniquement l'état d'un document de l'identifiant authentifié pendant les 24 heures suivant sa création. Un document supprimé répond 200 avec {"status":"deleted"} ; aucune donnée de transport, PDF, lien QR ni metadata n'est renvoyé. Un document actif répond avec {"status":"active"}.
Un UUID inexistant, d'un autre identifiant ou hors des 24 heures renvoie le même 404. La suppression n'étend pas cette fenêtre.
Paramètres de chemin
uuidUUID public du document. Vous pouvez aussi utiliser GET /api/v1/documents/ref/{reference}/status. Exemple : /api/v1/documents/ref/EXP-2026-004587/status.
Consulter l'état › Réponses
État du document sans données de contenu.
statusÉtat du document. N'inclut ni données de transport, PDF, QR, metadata ni dates.
Télécharger le PDF
Renvoie les octets exacts du PDF stocké, sans le régénérer. Exige l'identifiant propriétaire et un document de moins de 24 heures. Cette limite ne modifie ni la conservation légale ni la validité du QR.
Un document supprimé renvoie 404 sans livrer le PDF.
Paramètres de chemin
uuidUUID public du document. Vous pouvez aussi utiliser GET /api/v1/documents/ref/{reference}/pdf. Exemple : /api/v1/documents/ref/EXP-2026-004587/pdf.
Télécharger le PDF › Réponses
PDF original natif, jusqu'à 5 MB. Téléchargement direct sans régénération.