API et intégration
Des PDF accessibles directement depuis vos systèmes
L’API REST de DokAudit intègre le contrôle et la correction à votre système de gestion de contenu, à votre GED ou à votre serveur de formulaires : transmettez un document, recevez le résultat par webhook, récupérez la version corrigée et la preuve. C’est la même bibliothèque de documents que dans l’espace documents : ce que l’API importe, vous le voyez aussi là.
- API REST + webhooks + MCP distant
- TYPO3 12.4/13.4 · Drupal 10.3/11
- Sur site avec Docker
Ouvrir la documentation de l’API · Essai gratuit (20 crédits)
Les principaux points d’accès
URL de base https://dokaudit.de/api/v1, authentification par l’en-tête Authorization: Bearer dka_live_…. La description complète et lisible par machine (OpenAPI) se trouve sous /api/v1/openapi.json.
Points d’accès de l’API DokAudit| Méthode et chemin | Usage |
|---|
| POST /documents | Importer un document (PDF ou Word) et lancer le traitement |
|---|
| GET /documents | Lister et filtrer les documents de la bibliothèque |
|---|
| GET /documents/{id} | Consulter le statut (uploaded, queued, processing, checked, fixed, waiting_credits, error) |
|---|
| GET /documents/{id}/report | Rapport de contrôle en JSON |
|---|
| GET /documents/{id}/files/{kind} | Télécharger l’original, la version corrigée (PDF/UA-1), la version PDF/UA-2 ou le rapport en PDF |
|---|
| POST /documents/{id}/process | Relancer le traitement |
|---|
| DELETE /documents/{id} | Supprimer un document |
|---|
| POST /webscans | Rechercher les PDF d’un site ou d’une liste d’URL et les contrôler rapidement, gratuitement |
|---|
| POST /webscans/{id}/import | Reprendre les PDF trouvés dans la bibliothèque et les corriger automatiquement |
|---|
| GET /monitors | Lister les surveillances de sites récurrentes |
|---|
| POST /monitors | Créer une surveillance quotidienne, hebdomadaire ou mensuelle |
|---|
| POST /monitors/{id}/run | Lancer immédiatement une surveillance |
|---|
| GET /account | Organisation et solde de crédits |
|---|
Exemple d’appel avec curl :
curl -H "Authorization: Bearer $DOKAUDIT_KEY" -F file=@rapport.pdf -F auto_mode=true https://dokaudit.de/api/v1/documents
DokAudit comme outil pour les agents d’IA.
MCP distant
Le point d’accès MCP met l’espace documents, l’analyse de site et Continuous Accessibility à disposition sous forme d’outils standardisés pour agents. Il utilise les mêmes clés API, organisations et droits que l’API REST – pas de second modèle d’autorisations.
- Serveur : https://dokaudit.de/mcp/
- Authentification : Bearer dka_live_…
- Transport : MCP Streamable HTTP
Exemples de tâches pour les agents
- « Montre-moi tous les documents qui demandent encore de l’attention. »
- « Analyse ce site à la recherche de PDF non accessibles. »
- « Mets en place une surveillance hebdomadaire. »
- « Qu’est-ce qui a changé depuis la dernière analyse ? »
Les outils MCP en écriture exigent une clé API avec droit d’écriture. La correction automatique reste une action explicite, car elle peut ensuite consommer des crédits.
Intégré en quatre étapes
- Créer une clé: Les administrateurs génèrent dans l’espace documents, sous « Intégrations », une clé API avec droit de lecture ou d’écriture. Elle n’est affichée qu’une fois ; seule une empreinte (hash) est enregistrée.
- Transmettre un document: Un POST avec le fichier suffit. Vous recevez immédiatement un identifiant de document ; le traitement se déroule en arrière-plan, entièrement automatique si vous le souhaitez.
- Être informé du résultat: Soit par webhook (document.completed), soit en consultant le statut. Pas besoin d’interroger en continu.
- Récupérer le résultat: Le PDF corrigé, en option la version PDF/UA-2, et le rapport de contrôle en JSON ou en PDF – comme preuve pour votre dossier.
Webhooks : votre système est informé immédiatement
DokAudit signale les événements par POST à votre adresse https – signés, renvoyés en cas d’erreur et identifiables de manière unique. Événements : document.completed (terminé, contrôlé ou corrigé), document.failed, document.waiting_credits et webscan.completed.
- Signature HMAC-SHA256 dans l’en-tête X-DokAudit-Signature (format t=…,v1=…), exemples de code Python et Node.js dans la documentation
- Jusqu’à 5 nouvelles tentatives automatiques à intervalles croissants (10 s, 1 min, 5 min, 30 min, 2 h)
- Identifiant d’événement unique dans l’en-tête X-DokAudit-Delivery, pour repérer de façon sûre les livraisons en double
- Journal des envois et appel de test dans l’espace documents ; les cibles situées dans un réseau privé sont refusées pour des raisons de sécurité
Scénarios d’usage typiques dans l’administration
- Système de gestion de contenu: Chaque PDF déposé par la rédaction est contrôlé et corrigé avant publication. Résultat et rapport reviennent par webhook.
- Gestion électronique de documents: Les documents nouvellement classés passent automatiquement par le contrôle ; les cas en échec apparaissent dans l’espace documents.
- Serveurs de formulaires et portails de démarches: Les nouveaux formulaires PDF sont contrôlés avant leur mise à disposition et, si possible, corrigés aussitôt.
- Systèmes d’information des conseils: Ordres du jour, délibérations et annexes sont traités au fil de l’eau au lieu d’être rattrapés péniblement une fois par an.
- Assainissement par analyse du site: L’API trouve tous les PDF d’un site, les contrôle gratuitement et importe les documents pertinents dans la bibliothèque.
- Continuous Accessibility: Les sites sont recontrôlés chaque jour, chaque semaine ou chaque mois. Les PDF nouveaux, modifiés et disparus apparaissent sous forme d’écarts ; en option, les nouveaux cas problématiques sont repris automatiquement dans l’espace documents.
- Traitements de nuit: Une tâche transmet des dossiers entiers ; les webhooks signalent chaque document terminé.
Extensions prêtes à l’emploi et installation sur site
Démos en ligne : TYPO3 · Drupal
- Extension TYPO3: Contrôle chaque PDF de la liste de fichiers et le remplace sur place – UID sys_file, liens et éléments de contenu inchangés, original sauvegardé.
- Module Drupal: Idem pour la médiathèque : fid, URI et références conservés, nouveaux imports mis en file automatiquement, synchronisation par cron ou Drush.
- Sur site: Un conteneur Docker sans dépendance externe obligatoire (IA optionnelle) pour centres de données et grandes organisations.
Facturation et exploitation
- Les mêmes crédits que dans l’interface: 1 crédit par tranche de 5 pages commencée et par document, IA et revérifications illimitées comprises. L’analyse de site et le contrôle rapide sont gratuits. Si le solde ne suffit pas, le document attend automatiquement des crédits.
- Des limites claires: 60 appels par minute et par clé (ensuite 429 avec Retry-After) ; les clés ne valent que dans votre propre organisation, droits de lecture et d’écriture séparés.
- Centre de données en Allemagne ou le vôtre: Exploitation en Allemagne ; sur demande en conteneur Docker dans votre infrastructure. Le fournisseur d’IA est au choix, notamment Mistral (UE).
Questions
- Quelles langues sont prises en charge ?
- Une grande partie de l’application web est déjà disponible en français (choix de la langue dans l’application) ; le hub documentaire, le contrôle et le rapport suivront prochainement. Les PDF corrigés, l’API et les extensions CMS fonctionnent pour des documents dans toutes les langues – le français, l’anglais, l’allemand, l’italien et l’espagnol sont détectés automatiquement.
- Les extensions sont-elles open source ?
- Oui, l’extension TYPO3 et le module Drupal sont sous licence GPL.