Workspace External API
im Workspace verfügbarDokumente hochladen, Status lesen, Exportformate abrufen, Exporte anfordern und Monatsprozesse integrieren.
API-Integration
Rechnungsdaten kontrolliert in ERP-, DMS-, Buchhaltungs- und individuelle Finanzprozesse einbinden.
Workspace-Anmeldung erforderlichZugänge und Integrationswege
Dokumente hochladen, Status lesen, Exportformate abrufen, Exporte anfordern und Monatsprozesse integrieren.
Öffentlicher Ablauf für Upload, Extraktion, Review, Validierung, Artefakterzeugung und geschützte strukturierte Downloads.
Aus Convert erzeugte Prüf-Links und QR-Codes zeigen begrenzte Metadaten. Strukturierte Downloads bleiben geschützt.
Dokument-, Rechnungs-, Export- und Monatsprozess-Ereignisse an eigene Systeme zustellen.
Scopes, Rate Limits, Nutzung und Sandbox-/Live-Schlüssel im Workspace verwalten.
Implementierungsstatus
POST /api/v1/documents Dokument in den Workspace-Workflow hochladen im Workspace verfügbarGET /api/v1/documents/{document_id} Dokumentstatus und Metadaten lesen im Workspace verfügbarGET /api/v1/invoices/{invoice_id} Rechnungs- und Prüfstatus lesen im Workspace verfügbarGET /api/v1/export-formats Freigegebene Exportformate abrufen im Workspace verfügbarPOST /api/v1/invoices/{invoice_id}/exports Exportanforderung an die interne Pipeline übergeben im Workspace verfügbarPOST /api/convert/jobs Öffentlichen Convert-Vorgang erstellen öffentlicher Ablauf verfügbarPOST /api/convert/jobs/{job_id}/validate Daten gegen den gewählten Zielformat-Prüfer prüfen öffentlicher Ablauf verfügbarPOST /api/convert/jobs/{job_id}/generate Artefakt erzeugen; Download bleibt bis zur Freigabe geschützt öffentlicher Ablauf verfügbarPOST /api/v1/convert/extract Versionierter External-API-Zugang für Convert auf Anfrage / geplantPOST /api/v1/verify-links Versionierter External-API-Zugang für Verify/QR auf Anfrage / geplantZugriff und Verantwortung
API-Schlüssel werden im Workspace erzeugt und nur einmal vollständig angezeigt. Scopes, Limits, Nutzung, Webhooks sowie Sandbox-/Live-Trennung werden serverseitig ausgewertet. Schreibende Aufrufe sollten einen Idempotency-Key verwenden.
Die authentifizierte Workspace API deckt Dokumente, Rechnungsstatus, Exportformate, Exportpakete und Monatsprozesse ab. Der öffentliche Convert-Ablauf verwendet eigene /api/convert-Endpunkte. Versionierte /api/v1-Endpunkte für Convert und Verify werden erst dann als verfügbar ausgewiesen, wenn sie implementiert und freigegeben sind.