Beschreibung:

API Keys können im OCC erstellt und verwaltet werden.

Mit einem API Key kann ein direkter Login für unsere Wall erstellt werden, aber auch direkt in das OCC selbst.


Des Weiteren können mit API Keys auch automatisch Daten von unseren API-Servern abgefragt werden, ohne dass ein Benutzername und ein Kennwort eingeben werden müssen.


→ Unsere öffentliche API-Dokumentation findest Du hier.

Im Folgenden wird beschrieben, wie Du die API Keys im OCC verwalten kannst.


INHALTSVERZEICHNIS


Voraussetzung:
Um Einblick in die API Keys zu haben, wird die Benutzerrolle "Leiter" benötigt.



API Key erstellen

  1. Wechsle über Dein Profilbild in die Systemhauseinstellungen:
  2. Wähle den Reiter "API Keys" aus:
  3. Hier kannst Du jetzt einen neuen API Key generieren:
  4. Wähle jetzt einen Namen für den API Key aus und gebe Dein OCC Benutzer Passwort ein:
  5. Danach wird Dir der generierte API Key einmalig angezeigt:
Beachte:
Ein API Key sollte immer wie ein Benutzername und ein Kennwort behandelt werden, dieser sollte nicht öffentlich zugänglich gemacht werden!



API Key Nutzung beschränken

Ein API Key kann auch von Dir in der Nutzung eingeschränkt werden.

Darunter gibt es folgende Möglichkeiten:

  • Gültigkeitsdatum
  • Maximale Anzahl an API-Calls



API Key löschen

Im Punkt "API Keys" in den Systemhauseinstellungen kannst Du Dir alle aktiven API Keys anzeigen lassen. Hier kannst Du über das Papierkorb-Symbol den gewünschten API Key final löschen.

Beachte:
Ein API Key wird außerdem ungültig, sobald der zugehörige Benutzer (Ersteller) aus dem OCC gelöscht wird.
Dies liegt daran, dass API Keys an spezifische Benutzerkonten gebunden sind. Wenn das Benutzerkonto entfernt wird, verliert der API Key seine Gültigkeit und kann nicht weiter verwendet werden.