Processing API
Dokumente übermitteln, Vorgänge verwalten und extrahierte Daten abrufen
Reporting API
Auf Analyse- und Reportingdaten für das Unternehmen zugreifen
Basis-URL
Authentifizierung
| Flow | Am besten geeignet für |
|---|---|
| Resource Owner Password Credentials | Server-zu-Server-Integrationen |
| Authorization Code Flow | Endbenutzeranwendungen |
| Client Credentials | Machine-to-Machine-Kommunikation |
Kontaktieren Sie ABBYY, um einen Mandanten in ABBYY Vantage zu beantragen. Sobald Ihr Mandantenkonto eingerichtet ist, können Sie Benutzerkonten und API-Clients für die Authentifizierung erstellen.
Processing API
/api/publicapi/v1/) bietet Ihnen folgende Möglichkeiten:
- Vorgänge erstellen — Dokumente mit einem bestimmten Skill zur Verarbeitung übergeben
- Dateien verwalten — Dokumentbilder hochladen, bearbeiten und organisieren
- Status nachverfolgen — Fortschritt von Vorgängen überwachen und Fehler behandeln
- Ergebnisse abrufen — extrahierte Daten im JSON- oder XML-Format herunterladen
- Kataloge verwalten — mit Datenkatalogen und Nachschlagetabellen arbeiten
Häufige Workflows
Verarbeitung mit einem einzelnen API-Aufruf
Verarbeitung mit einem einzelnen API-Aufruf
Verarbeiten Sie Dokumente mit einer einzelnen Anfrage, die Upload, Verarbeitung und Abruf der Ergebnisse automatisch übernimmt.Mehr erfahren →
Mehrstufige Verarbeitung
Mehrstufige Verarbeitung
Verwenden Sie separate API-Aufrufe für eine feingranulare Kontrolle von Dokument-Upload, Verarbeitung und Ergebnisabruf.Mehr erfahren →
Human-in-the-Loop
Human-in-the-Loop
Integrieren Sie die manuelle Überprüfung in Ihren Workflow für Dokumente, die eine menschliche Verifizierung erfordern.Mehr erfahren →
Reporting-API
/api/reporting/v2/) bietet Zugriff auf:
- Geschäftskennzahlen — Vorgangsvolumen, Verarbeitungszeiten und Durchsatz
- Qualitätsanalysen — Extraktionsgenauigkeit und Konfidenzwerte
- Daten auf Feldebene — Detaillierte Extraktionsergebnisse zur Analyse
Ausgabeformate
JSON-Ausgabe
Hierarchische Daten mit vollständigen Extraktionsdetails und Konfidenzwerten
XML-Ausgabe
Strukturiertes Markup für Systeme, die eine XML-Integration erfordern
Entwicklerressourcen
Entwicklerhandbuch
Vollständige Anleitung zur Integration der Vantage-API
Postman-Collection
Einsatzbereite API-Collection zum Testen und Erkunden
Rate Limits & Best Practices
- Batchvorgänge — Verwenden Sie Batch-Endpunkte, wenn Sie mehrere Datensätze verarbeiten (bis zu 5.000 Katalogdatensätze pro Anfrage)
- Polling — Verwenden Sie beim Prüfen des Vorgangsstatus angemessene Intervalle (5–10 Sekunden)
- Fehlerbehandlung — Implementieren Sie Retry-Logik mit exponentiellem Backoff für temporäre Fehler
Nächste Schritte
1
Authentifizierung einrichten
Richten Sie OAuth 2.0 für Ihre Anwendung ein
2
Ihr erstes Dokument verarbeiten
Befolgen Sie die Anleitung zur Verarbeitung, um ein Dokument einzureichen
3
Die API erkunden
Durchstöbern Sie die vollständige Referenzdokumentation der Processing API und der Reporting API