BizCortex Dokumentation

API Schlüssel

Schlüssel, mit denen andere Programme über die REST API auf Ihre Firmendaten zugreifen.

API Schlüssel geben Integrationen Zugriff auf diese Firma. Behandeln Sie sie wie Passwörter. Öffnen Sie "Einstellungen" und den Reiter "API Schlüssel". Die Tabelle zeigt Name, Präfix (die ersten Zeichen des Schlüssels), Rolle, Erstellungsdatum, "Zuletzt genutzt", "Läuft ab" und den Status Aktiv oder Widerrufen.

API Schlüssel
Bildschirmfoto dieser Ansicht

Wer kann das nutzen

  • Inhaber
  • Administrator

Schritte

  1. 1. Einen Schlüssel erstellen

    Klicken Sie auf "Schlüssel erstellen". Geben Sie einen Namen ein, zum Beispiel "DATEV Export", wählen Sie die Rolle und optional ein Ablaufdatum. Klicken Sie auf Speichern.

  2. 2. Den Schlüssel kopieren

    Der Dialog "API Schlüssel erstellt" zeigt den Schlüssel ein einziges Mal. Klicken Sie auf die Kopierschaltfläche und bewahren Sie den Schlüssel an einem sicheren Ort auf. Er wird nicht noch einmal angezeigt.

  3. 3. Einen Schlüssel widerrufen

    Öffnen Sie das Zeilenmenü und wählen Sie "Widerrufen". Bestätigen Sie "Schlüssel widerrufen?". Der Schlüssel funktioniert sofort nicht mehr.

Felder und Optionen

Name

Pflichtfeld. Hilft Ihnen, die Integration wiederzuerkennen.

Rolle

Die Rechte des Schlüssels, höchstens Ihre eigene Rolle. Inhaber ist nicht wählbar. Voreingestellt ist Nur Lesen.

Läuft ab

Optionales Datum, ab dem der Schlüssel nicht mehr funktioniert.

Tipps

  • Erstellen Sie je Integration einen eigenen Schlüssel, damit Sie ihn widerrufen können, ohne andere zu beeinträchtigen.
  • Geben Sie einem Schlüssel die kleinste Rolle, die er braucht. Ein Berichtswerkzeug braucht meist nur Nur Lesen.
  • Ein Identitätsanbieter kann ausscheidende Benutzer über die SCIM Schnittstelle automatisch deaktivieren. Dafür braucht er einen Schlüssel mit der Rolle Administrator.

Gut zu wissen

  • Gespeichert wird nur ein Fingerabdruck des Schlüssels. Haben Sie den Schlüssel verloren, widerrufen Sie ihn und erstellen Sie einen neuen.
  • Wird ein Benutzer ausgegliedert (Offboarding), werden auch die API Schlüssel widerrufen, die er erstellt hat.
  • Das Erstellen und Widerrufen von Schlüsseln wird im Prüfprotokoll festgehalten.

Verwandte Seiten