Entwickler (API): Eigene Integrationen und automatisierte Workflows

Access Tokens, OAuth-Apps und Webhooks für eigene Integrationen verwalten

Geschrieben von Philip Günther

Im Bereich „Entwickler (API)“ verwalten Sie die technischen Zugänge zu einfachArchiv. Dazu gehören Access Tokens, OAuth-Apps und Webhooks. So können Sie eigene Anwendungen anbinden oder Ereignisse aus dem Dokumentenworkflow automatisch an externe Systeme weitergeben.

Screenshot der Entwickler-API-Übersichtsseite in einfachArchiv

1. Bereich „Entwickler (API)“ öffnen

  1. Klicken Sie oben rechts auf Ihr Profil.

  2. Wählen Sie „Entwickler (API)“.

  3. Auf der Seite finden Sie typischerweise:

    • Autorisierte Apps

    • OAuth Apps

    • Access Tokens

    • Webhooks

  4. Zusätzlich gibt es dort den Link „API Dokumentation“.

2. Access Tokens verwenden

  1. Wofür Access Tokens gedacht sind: Access Tokens eignen sich für serverseitige Integrationen, Skripte oder Automatisierungen ohne interaktive Benutzeranmeldung.
  2. Token erstellen: Klicken Sie auf „Access Token erstellen“, vergeben Sie einen Namen und speichern Sie den Token sicher.
  3. Sicher aufbewahren: Der Token sollte nur an den Diensten hinterlegt werden, die ihn wirklich benötigen.
  4. Token entfernen: Nicht mehr benötigte oder kompromittierte Tokens können Sie jederzeit löschen.

3. OAuth-Apps verwalten

  1. Eigene OAuth-App anlegen: Über „OAuth App erstellen“ erzeugen Sie eine Anwendung mit Client-ID und Client-Secret.
  2. Einsatzgebiet: OAuth ist sinnvoll, wenn externe Anwendungen im Namen eines Benutzers auf einfachArchiv zugreifen sollen.
  3. Autorisierte Apps prüfen: Im Bereich „Autorisierte Apps“ sehen Sie bereits freigegebene Anwendungen und können deren Zugriff widerrufen.

4. Webhooks einrichten

  1. Webhook erstellen: Klicken Sie auf „Webhook erstellen“.
  2. Team auswählen: Wählen Sie das Team, für das der Webhook gelten soll.

  3. Ereignis festlegen: Verfügbare Ereignisse sind u. a.:

    • Dokument eingegangen

    • Dokument analysiert

    • Dokument archiviert

  4. Ziel-URL eintragen: Geben Sie die URL des externen Systems an, das den Aufruf empfangen soll.
  5. Optionales Secret: Auf Wunsch hinterlegen Sie ein Secret für die Signierung des Aufrufs.
  6. Aktiv oder inaktiv: Sie können Webhooks aktiv oder inaktiv speichern und später bearbeiten oder löschen.

5. Typische Anwendungsfälle

  1. Dokumente automatisch weiterverarbeiten: Lassen Sie externe Systeme reagieren, sobald ein Dokument eingeht oder archiviert wurde.
  2. Eigene Portale anbinden: Nutzen Sie Access Tokens oder OAuth-Apps für eigene Upload- oder Auswertungsprozesse.
  3. Prozessketten auslösen: Starten Sie Folgeprozesse in anderen Systemen, sobald Analyse oder Archivierung abgeschlossen sind.

6. Sicherheitshinweise

  1. Tokens und Secrets niemals offen teilen: Behandeln Sie diese Daten wie Zugangsdaten.
  2. Nur notwendige Zugänge aktiv halten: Löschen Sie ungenutzte Tokens, Apps und Webhooks.
  3. Pro Integration getrennte Zugänge verwenden: So können Sie einzelne Verbindungen gezielt deaktivieren.

7. Häufige Fragen

Wofür nutze ich Access Tokens statt OAuth?

Access Tokens eignen sich besonders für technische Server-zu-Server-Integrationen ohne Benutzerdialog.

Kann ich Webhooks einem bestimmten Team zuordnen?

Ja. Beim Anlegen wählen Sie explizit das zugehörige Team.

Welche Ereignisse kann ich per Webhook versenden?

Mindestens die folgenden Ereignisse:

  • Dokument eingegangen

  • Dokument analysiert

  • Dokument archiviert

Wo finde ich die genaue API-Beschreibung?

Über den Link „API Dokumentation“ im Entwicklerbereich.

Mit „Entwickler (API)“ stellt einfachArchiv die wichtigsten Bausteine für technische Integrationen bereit. Besonders nützlich ist die Kombination aus Tokens für den Zugriff und Webhooks für automatische Reaktionen auf Dokumentereignisse.