API et webhooks
Le téléchargement et la lecture de documents sont disponibles via l'API REST. La gestion du compte, des dossiers, des étiquettes et des connexions se fait dans l'application.
Clé
Elle se crée dans Paramètres → Pour les développeurs. La clé ne s'affiche qu'une seule fois, lors de sa création — ensuite, seul son empreinte est enregistrée. Une clé perdue n'est pas récupérable, il faut en créer une nouvelle et l'ancienne sera supprimée. On peut avoir cinq clés, chacune avec une durée de validité optionnelle de deux ans.
Un e-mail est envoyé au propriétaire du compte pour chaque nouvelle clé, ainsi que deux semaines avant l'expiration de la clé. Voir Notification par e-mail.
La clé est envoyée dans l'en-tête X-API-Key.
Ce que l'API peut faire
| Opération | Description |
|---|---|
POST /api/upload | Téléchargement d'un fichier avec options : format, direction, type, devise, schéma, dossier, webhook |
POST /api/upload/url | Pareil depuis une adresse publique ; nous téléchargerons le fichier nous-mêmes |
GET /api/jobs | Liste des documents avec filtres et pagination |
GET /api/jobs/{id} | État, données lues, résultats et sortie au format cible |
GET /api/jobs/{id}/original | Fichier téléchargé |
DELETE /api/jobs/{id} | Suppression dans la corbeille |
Excel et PDF sont renvoyés sous forme de Base64. Ceux qui n'ont pas besoin du résultat peuvent envoyer includeResult=false, ce qui leur fait économiser la conversion sur le serveur.
La description de l'interface au format OpenAPI se trouve à l'adresse /api/docs ; le lien est dans les paramètres au niveau des clés. La description est générée à partir du code en cours d'exécution, donc elle correspond à ce que fait l'API.
Contrôle des documents via l'API
Le contrôle avant envoi s'applique par défaut aussi aux documents téléchargés via clé : le document attend une confirmation dans l'application et le webhook part seulement après cela. Ceux qui construisent une intégration où personne ne reste devant l'écran peuvent retirer le canal API dans Paramètres → Contrôle avant envoi ou désactiver le contrôle.
MCP
Pour les agents IA, à l'adresse /api/mcp, un serveur MCP utilise la même clé. Il peut lire et rechercher des documents, mais pas les télécharger ; le téléchargement renvoie une commande terminée que l'agent exécute lui-même.
Webhooks
Au lieu de demander l'état, laissez-vous envoyer le résultat lorsque c'est prêt. L'adresse est configurée pour tout le compte dans Paramètres → Pour les développeurs, ou pour chaque téléchargement individuel via le paramètre targetWebhookUrl. Un bouton dans les paramètres envoie un message de test.
Un POST avec JSON est envoyé : identifiant du document, nom du fichier, format et résultat au format cible. Lorsque le document passe le contrôle ou est traité à nouveau, le webhook est envoyé une seconde fois avec le drapeau de correction (IsCorrection).
Le message n'est pas signé. Vérifiez l'expéditeur en ajoutant votre propre jeton secret à l'adresse. Les adresses sur des réseaux privés sont refusées.
Si le webhook n'arrive pas après tous les essais, environ quatre heures et demie plus tard, un e-mail est envoyé. Au cours d'une seule panne, cela n'arrive qu'une fois, d'autres échecs sont répertoriés dans l'activité. Un e-mail est également envoyé après chaque changement d'adresse du webhook, si quelqu'un d'autre que vous l'a modifiée.
Les échecs de livraison sont répétés avec un délai croissant, avec onze tentatives en environ quatre heures et demie. Chaque tentative est enregistrée dans l'activité avec la réponse de votre côté ; au document dans la liste, une icône montre le résultat de la livraison.
Limites
L'API n'a pas de limite propre au nombre d'appels par minute ; le téléchargement est limité par les crédits, la taille du fichier selon le tarif et vingt pages par document. Un refus sera renvoyé sous forme d'erreur 400 avec un code qui explique pourquoi. Le serveur MCP est limité à dix requêtes par seconde.