Entwickler und API

Acriva hat eine REST-API, die JSON über HTTPS spricht. Die App selbst nutzt dieselbe API. Alles, was Sie in der App tun, wird deshalb auch aus Ihren eigenen Systemen möglich sein.

API-Referenz

Die API-Referenz listet jeden Endpunkt mit seinen Parametern, Anfragen und Antworten. Sie entsteht aus dem OpenAPI-Dokument der aktuellen Version und passt deshalb immer zu dem, was Acriva ausführt. Die Referenz ist auf Englisch.

Jeder Endpunkt eines Arbeitsbereichs beginnt mit /api/v1/t/{tenant}/, wobei {tenant} die Adresse des Arbeitsbereichs ist. Fehler kommen als Problem Details (RFC 9457) mit einem title in der Sprache der Anfrage zurück.

Ihre Systeme anbinden

• API-Schlüssel: von einem Server ohne Benutzer anmelden.
• Upload-API: Dokumente an Acriva senden.
• Webhooks: reagieren, wenn in einem Arbeitsbereich etwas geschieht.
• E-Mail-Eingang: Dokumente per E-Mail senden.

Änderungen an der API

Die API ist in ihrem Pfad versioniert (/api/v1/). Was sich mit jeder Version ändert, steht in den Neuerungen.