MAXScanner API v1
Baue Dokument-Workflows, keine Verarbeitungsinfrastruktur.
Asynchrone APIs für Dokumente, Dateien, OCR, Konvertierung, PDF, Komprimierung und Webhooks. Ein Authentifizierungsmodell, ein Job-Lebenszyklus und ein Ergebnisvertrag.
Authentifizierung
Eingeschränkte API-Schlüssel
Verarbeitung
Asynchrone Jobs
Ereignisse
Signierte Webhooks
Referenz
Alle API-Operationen
/api/v1/jobsVerarbeitungs-Job erstellen
Sende einen asynchronen Verarbeitungsvorgang und erhalte eine stabile Job-ID.
/api/v1/jobs/{jobId}Job-Status abrufen
Lies den aktuellen Lebenszyklusstatus und die Ergebnisinformationen eines Verarbeitungs-Jobs.
/api/v1/documentsDokumente auflisten
Listet die für das authentifizierte Konto verfügbaren Dokumente auf.
/api/v1/documents/{documentId}/processDokument verarbeiten
Erstelle einen asynchronen Verarbeitungs-Job für eine Dokumentversion aus dem Konto.
/api/v1/files/uploadDatei-Upload autorisieren
Erstelle einen begrenzten Upload-Ablauf für eine private Quelldatei.
/api/v1/convertDatei konvertieren
Leite eine unterstützte Dokumentkonvertierung über die verwaltete Prozessorflotte.
/api/v1/ocrOCR ausführen
Durchsuchbaren Text aus einem unterstützten Bild oder Dokument extrahieren.
/api/v1/pdfPDF-Operation ausführen
Sende eine unterstützte PDF-Operation wie Zusammenführen, Teilen oder Optimieren.
/api/v1/compressBild komprimieren
Sende einen Bildoptimierungs-Job mit Vorgaben für Format und Qualität.
/api/v1/webhooksWebhook erstellen
Registriere ein signiertes Callback-Ziel für Job- und Dokumentereignisse.
Error referenceFehlerreferenz
Authentifizierungs-, Validierungs-, Kontingent-, Konflikt- und Serverfehler verstehen.
Limits & formatsLimits und Formate
Referenz zu unterstützten Formaten, Kontingenten und Anfragebeschränkungen.