Basis-URL
Authentifizierung
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
Gängige Workflows
- Dokumente mit einem einzigen API-Aufruf verarbeiten — Verarbeiten Sie Dokumente mit einer einzigen Anfrage, die Upload, Verarbeitung und Abruf der Ergebnisse automatisch übernimmt.
- Dokumente mit separaten API-Aufrufen verarbeiten — Verwenden Sie separate API-Aufrufe für eine feingranulare Steuerung von Dokument-Upload, Verarbeitung und Abruf der Ergebnisse.
- Manuelle Überprüfung integrieren — Integrieren Sie die Manuelle Überprüfung in Ihren Workflow für Dokumente, die von einem Benutzer verifiziert werden müssen.
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
- Erste Schritte mit der Vantage-API — Beginnen Sie hier — führen Sie Ihren ersten Aufruf aus, authentifizieren Sie sich und wählen Sie ein Verarbeitungsszenario
- 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