URL de base
Authentification
Contactez ABBYY pour demander la création d’un tenant dans ABBYY Vantage. Une fois que vous disposez d’un compte de tenant, vous pouvez créer des comptes utilisateur et des clients d’API pour l’authentification.
API de traitement
/api/publicapi/v1/) vous permet de :
- Créer des transactions — Soumettre des documents pour traitement avec un Skill spécifique
- Gérer les fichiers — Téléverser, modifier et organiser des images de documents
- Suivre l’état — Surveiller l’avancement des transactions et gérer les erreurs
- Récupérer les résultats — Télécharger les données extraites au format JSON ou XML
- Gérer les catalogues — Utiliser des catalogues de données et des tables de recherche
Workflows courants
- Traitement des documents avec un seul appel API — Traitez des documents en une seule requête qui gère automatiquement le téléversement, le traitement et la récupération des résultats.
- Traitement des documents avec des appels API distincts — Utilisez des appels API distincts pour contrôler finement le téléversement des documents, le traitement et la récupération des résultats.
- Intégration de la relecture manuelle — Intégrez la relecture manuelle à votre workflow pour les documents nécessitant une vérification humaine.
API de reporting
/api/reporting/v2/) permet d’accéder à :
- Indicateurs métier — Volumes de transactions, temps de traitement et débit
- Analyses de qualité — Précision d’extraction et scores de confiance
- Données détaillées par champ — Résultats d’extraction détaillés pour l’analyse
Formats de sortie
- Sortie JSON — Données hiérarchiques avec l’ensemble des détails d’extraction et les scores de confiance
- Sortie XML — Balisage structuré pour les systèmes qui requièrent une intégration XML
Ressources pour les développeurs
- Premiers pas avec l’API Vantage — Commencez ici — effectuez votre premier appel, authentifiez-vous et choisissez un scénario de traitement
- Collection Postman — Collection d’API prête à l’emploi pour les tests et l’exploration
Limitations de débit et bonnes pratiques
- Opérations par lot — Utilisez les endpoints de traitement par lot lors du traitement de plusieurs enregistrements (jusqu’à 5 000 enregistrements de catalogue par requête)
- Polling — Lors de la vérification de l’état d’une transaction, utilisez des intervalles raisonnables (5 à 10 secondes)
- Gestion des erreurs — Mettez en œuvre une logique de nouvelle tentative avec temporisation exponentielle (exponential backoff) pour les erreurs transitoires
Prochaines étapes
1
Configurer l’authentification
Configurez OAuth 2.0 pour votre application
2
Traiter votre premier document
Suivez le guide de traitement pour soumettre un document
3
Explorer les API
Parcourez la documentation de référence complète de l’API Processing et de l’API Reporting