Entwickler (API): Eigene Integrationen und automatisierte Workflows

Eigene Anwendungen anbinden, Access Tokens erstellen und OAuth-Apps verwalten

Geschrieben von Philip Günther

einfachArchiv stellt eine Programmierschnittstelle (API) bereit, mit der Sie Dokumente, Metadaten und weitere Funktionen bequem in eigene Anwendungen oder automatisierte Abläufe integrieren können. In der Rubrik „Entwickler (API)“ verwalten Sie u. a. Access Tokens für Server-zu-Server-Kommunikation oder richten OAuth-Apps für externe Anwendungen ein. Dieser Artikel zeigt Ihnen, wie das funktioniert und wo Sie die offizielle Dokumentation finden.

1. Entwickler (API) aufrufen

  1. Menüpunkt „Entwickler (API)“

    • Klicken Sie oben rechts auf Ihren Namen (Profilbild).

    • Wählen Sie „Entwickler (API)“ im Dropdown-Menü.

  2. Übersicht

    • Es erscheinen mehrere Bereiche auf der Seite:

      • Autorisierte Apps

      • OAuth Apps

      • Access Tokens

  3. API Dokumentation

2. Autorisierte Apps und OAuth-Apps

  1. Autorisierte Apps

    • Hier erscheinen Dienste oder Anwendungen, die Sie (oder andere Berechtigte) für den Zugriff auf einfachArchiv freigeschaltet haben.

    • Sie können die jeweilige Freigabe widerrufen, wenn Sie einer App den Zugriff entziehen möchten.

  2. OAuth Apps

    • In diesem Bereich erstellen Sie eigene OAuth-Anwendungen, wenn externe User oder Dienste sich per OAuth in einfachArchiv einloggen oder Daten abrufen sollen.

    • Klicken Sie auf „OAuth App erstellen“, vergeben Sie einen Namen und erhalten Sie nach dem Speichern die Client-ID und das Client-Secret.

    • Bewahren Sie diese Daten sorgfältig auf, da sie zum Authentifizierungsablauf gehören.

3. Access Tokens

  1. Tokens im Überblick

    • Unter Access Tokens sehen Sie eine Liste angelegter Tokens (z. B. „General Access Token“, „einfachArchiv Rechnungen“).

    • Damit können automatisierte Skripte oder Server-zu-Server-Verbindungen hergestellt werden, ohne den OAuth-Flow zu nutzen.

  2. Access Token erstellen

    • Klicken Sie auf „Access Token erstellen“.

    • Vergeben Sie einen passenden Namen und speichern Sie.

    • Anschließend wird Ihnen der Token einmalig angezeigt, notieren Sie ihn sicher.

  3. Token löschen

    • Falls Sie ein Token nicht mehr benötigen oder es kompromittiert wurde, können Sie es löschen.

    • Entfernen Sie ungenutzte Tokens, um Ihre Sicherheit zu erhöhen.

4. API-Nutzung: Dokumentation und Beispiele

  1. API-Doku

  2. Mögliche Workflows

    • Automatisches Hochladen aus einem Script: Mit Ihrem Access Token und dem Upload-Endpunkt schieben Sie PDFs oder Bilder ins Archiv.

    • Datenabruf: Greifen Sie auf OCR-Daten zu oder lesen Sie archivierte Rechnungsbeträge aus, um sie weiterzuverarbeiten.

  3. Sicherheit

    • Behandeln Sie Tokens und Secrets vertraulich. Öffentlich gewordene Schlüssel sollten Sie umgehend löschen.

5. Tipps & Best Practices

  1. Pro Projekt ein Token

    • Legen Sie für jedes Ihrer Integrationsprojekte ein eigenes Token an. So entziehen Sie bei Bedarf nur diesem Projekt den Zugriff.

  2. Regelmäßiger Token-Audit

    • Schauen Sie gelegentlich in die Tokenliste und entfernen Sie Tokens, die nicht mehr im Einsatz sind.

  3. OAuth oder Access Token

    • OAuth ist geeignet, wenn andere (Dritt-)Nutzer oder Dienste in Ihrem Namen auf einfachArchiv zugreifen sollen.

    • Access Tokens sind ideal für eigene Skripte, Integrationen oder Cronjobs.

6. Häufige Fragen

Ist die API kostenpflichtig?
Nein. Die API-Nutzung ist in allen Tarifen von einfachArchiv enthalten.

Wie unterscheidet sich OAuth von einem Access Token?

  • OAuth: Autorisierter Flow für externe Apps, die im Namen eines Benutzers agieren.

  • Access Token: Direkte Zugriffsmethode (z. B. für Server-zu-Server), ohne Benutzerinteraktion.

Wie gehe ich vor, wenn ein Token kompromittiert wurde?
Löschen Sie das Token in Access Tokens und erstellen Sie bei Bedarf ein neues. So verhindern Sie unerlaubten Zugriff.

Mit dem Entwickler (API)-Bereich in einfachArchiv richten Sie eigene oder Drittanbieter-Anwendungen ein, die Dokumente und Metadaten automatisiert verarbeiten sollen. Ob Sie OAuth nutzen oder Access Tokens erstellen: Dank klarer Dokumentation und leichter Verwaltung starten Sie schnell in die Integration und automatisieren Ihre Archivabläufe effizient.