Endpoints & formats

L’API 2D-Doc Reader est une API REST / JSON exposée via HTTPS, conçue pour une intégration simple dans vos systèmes et vos workflows d’automatisation.

Toutes les requêtes et réponses sont disponibles sous le format JSON et sont sécurisées par clé API.

Types d’opérations supportées

L’API couvre deux grands cas d’usage avec un format de réponse identique quel que soit le mode utilisé.

1. Décodage d’un 2D-Doc brut

Décodage d’une chaîne 2D-Doc brute (issue d’un scan DataMatrix / QR code).

Cas typiques : borne, application mobile, récupération depuis un flux externe.

2. Analyse d’un document (PDF / image)

Décodage d’un 2D-Doc directement depuis un fichier.

Deux méthodes :

  • via URL (document accessible publiquement)
  • via upload direct (fichier envoyé dans la requête)

Formats supportés : JPG, PNG, PDF (seule la première page est analysée)

Dans les deux cas, le résultat contient :

  • les métadonnées du document,
  • les champs décodés,
  • le statut de signature cryptographique.

Performance & latence

L’API 2D-Doc Reader est conçue pour des usages temps réel.

  • Le décodage d’un 2D-Doc à partir d’une chaîne brute est traité de manière quasi instantanée.
  • L’analyse d’un document (PDF ou image) nécessite un traitement plus lourd et s’effectue généralement en quelques secondes, selon la taille et la qualité du document fourni.

Ces performances permettent une intégration aussi bien dans des parcours synchrones (guichet, onboarding) que dans des workflows automatisés.

Structure des réponses

Quel que soit le mode d’appel, l’API renvoie un objet JSON structuré en quatre blocs principaux :

  • source : données sources analysées (y compris le 2D-Doc brut et sa version textuelle)
  • header : métadonnées du document
  • message : données métier extraites
  • signature : informations de vérification cryptographique

La signature est validée via les clés publiques officielles, ce qui permet une vérification cryptographique complète de l’authenticité.

Principes techniques

  • API stateless
  • Appels synchrones (temps réel)
  • Aucun stockage des documents traités
  • Validation cryptographique

Collection Postman (sur demande)

Pour faciliter l’intégration, une collection Postman complète est disponible.

Elle contient :

  • tous les endpoints,
  • les headers prêts à l’emploi,
  • des exemples de requêtes,
  • des réponses types,
  • un environnement configuré avec vos variables.

Besoin d’un accès à la documentation complète ou d’un accompagnement technique pour votre intégration ?
Contactez-nous