Zum Inhalt springen

API und SDK

Die Server-API für externe Integration. OpenAPI-Spec verfügbar, SDK für TypeScript und Swift.

Funktionen im Überblick

  • OpenAPI-3.0-Spezifikation als Quelle der Wahrheit
  • Token-basierte Authentifizierung pro afid
  • Webhooks für Audit-Events
  • Rate-Limit pro Tarif

So ordnet sich diese Oberfläche ein

Die AnnexFlow-API ist die Server-Schnittstelle für externe Integration. Als Quelle der Wahrheit dient die OpenAPI-3.0-Spezifikation; wer AnnexFlow an eigene Systeme anbindet, findet dort die Endpunkte. Für TypeScript und Swift gibt es SDKs.

Die Authentifizierung erfolgt tokenbasiert je afid. Über Webhooks melden Sie Audit-Events an ein eigenes System weiter. Das Rate-Limit richtet sich nach dem gebuchten Tarif; welche Grenzen gelten, hängt also davon ab, welchen Tarif Ihr Betrieb nutzt.

Ein typischer Weg in die Integration: Sie lesen die OpenAPI-Spezifikation, verwenden ein Token und rufen die Endpunkte mit einem der SDKs auf. Änderungen im System, etwa Einträge im Audit-Trail, melden Webhooks an Ihre Anwendung zurück. Wer die Entscheidungen eines Agenten in ein eigenes Ticketing- oder Dokumentationssystem übernehmen möchte, ruft Replays über die API ab. Die API ergänzt damit die Oberflächen dieser Dokumentation für Integrationen, die ohne Bildschirm auskommen.

Mehr erfahren

Detaillierte Anleitungen, Setup-Guides und Best Practices finden Sie in der AnnexFlow-Dokumentation. Schreiben Sie uns an mail@annexflow.com, wenn Sie eine persönliche Einführung oder Schulung für Ihr Team buchen möchten.