API et webhooks
Le téléchargement et la lecture de documents sont disponibles via l'API REST. La gestion des comptes, des dossiers, des étiquettes et des connexions reste dans l'application.
Clé
La clé se crée dans Paramètres → Pour développeurs. La clé s'affiche une fois, lors de la création — ensuite, elle ne s'affiche plus, car seule son empreinte est enregistrée. Une clé perdue ne se restaure pas, une nouvelle est créée et l'ancienne est supprimée. Il est possible d'avoir cinq clés, chacune avec une durée de validité optionnelle allant jusqu'à deux ans.
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, monnaie, schéma, dossier, webhook |
POST /api/upload/url | Idem depuis une adresse publique ; le fichier est téléchargé par nos soins |
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 |
Les fichiers Excel et PDF sont retournés en tant que Base64. Ceux qui n'ont pas besoin du résultat peuvent envoyer includeResult=false pour économiser la conversion sur le serveur.
La description de l'interface au format OpenAPI est à l'adresse /api/docs ; le lien est dans les paramètres près des clés. La description est générée à partir du code en cours d'exécution, donc elle correspond à ce que l'API fait.
Vérification des documents de l'API
La vérification avant l'envoi s'applique par défaut également aux documents téléchargés avec la clé : le document attend une confirmation dans l'application et le webhook ne sera envoyé qu'après cela. Ceux qui construisent une intégration sans personne devant l'écran peuvent, dans Paramètres → Vérification avant envoi, retirer le canal API ou désactiver la vérification.
MCP
Pour les agents IA, le serveur MCP se trouve à l'adresse /api/mcp avec la même clé. Il peut lire et rechercher des documents, mais ne peut pas télécharger ; le téléchargement renvoie un ordre prêt que l'agent exécute lui-même.
Webhooks
Au lieu de demander l'état, laissez-vous envoyer le résultat une fois terminé. L'adresse se configure pour tout le compte dans Paramètres → Pour développeurs, ou pour chaque téléchargement individuel via le paramètre targetWebhookUrl. Le bouton dans les paramètres enverra un message de test.
Un POST avec JSON sera envoyé : identifiant du document, nom du fichier, format et résultat au format cible. Lorsque le document passe la vérification ou est retravaillé, le webhook arrive une deuxième 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 vers des réseaux privés sont refusées.
Les échecs de livraison sont renouvelés avec un délai croissant, pour un total de onze tentatives pendant environ quatre heures et demie. Chaque tentative est enregistrée dans l'activité avec la réponse de votre part ; un document dans le rapport a une icône avec le résultat de livraison.
Limites
L'API n'a pas de plafond propre sur le nombre d'appels par minute ; les téléchargements sont limités par des crédits, la taille des fichiers selon le tarif et vingt pages par document. Un refus se présente comme une erreur 400 avec un code expliquant pourquoi. Le serveur MCP est limité à dix requêtes par seconde.