Wie kann ich einen API-Key für Lead-Integrationen erstellen?

Einstellungen >> Systemintegrationen

Mit Systemintegrationen kannst du Octiv über sichere API-Keys für die Kommunikation zwischen Systemen mit externen Systemen – z. B. einem CRM – verbinden. Ein API-Key funktioniert dabei ähnlich wie ein Passwort und ermöglicht es zwei Systemen, miteinander zu kommunizieren, ohne dass sich jedes Mal jemand manuell anmelden muss.

In dieser ersten Version werden API-Keys für Leads unterstützt. Der Zugriff auf Systemintegrationen wird über eine bestimmte Berechtigung gesteuert und ist standardmäßig für alle außer dem Owner deaktiviert. Bevor ein Admin oder Standort-Admin die Systemintegrationen nutzen kann, muss ein Owner ihnen den Zugriff gewähren – siehe unten. Octiv empfiehlt, diese Berechtigung nur Ownern, Admins oder Standort-Admins zu geben, nicht Trainern.

Zugriff auf Systemintegrationen gewähren

Systemintegrationen wird für einen Mitarbeiter erst unter Einstellungen angezeigt, wenn diese Berechtigung aktiviert wurde.

Gehe zu Mitarbeiter.
Klicke auf das Menü-Symbol neben dem Namen des Mitarbeiters und wähle Anzeigen/Bearbeiten.
Öffne den Tab Zugriff.
Aktiviere unter Octiv-Zugriff die Option Systemintegrationen („Berechtigung zur Nutzung von oAuth Personal Access Tokens für die Kommunikation zwischen Systemen“).
Klicke auf Absenden.

Weitere Informationen zur Verwaltung von Mitarbeiterzugriffen findest du unter „Mitarbeiterdetails bearbeiten“.

API-Key erstellen

Gehe zu Einstellungen >> Systemintegrationen.
Klicke im Bereich API-Keys auf API-Key erstellen.
Gib unter Key-Name einen Namen ein, anhand dessen du das System erkennen kannst, für das der Key verwendet wird, z. B. „Landing Page Connector“.
Wähle unter Berechtigungsbereiche den Bereich leads:create aus. Damit kann der Key neue Lead-Mitglieder erstellen.
Klicke auf Key generieren.

Wichtig: Kopiere deinen API-Key sofort und speichere ihn an einem sicheren Ort. Aus Sicherheitsgründen wird der vollständige Key nur einmal angezeigt und kann nicht erneut abgerufen werden, sobald du das Fenster „API-Key erstellt“ geschlossen hast.

Klicke im Fenster „API-Key erstellt“ auf Kopieren, um den Key zu kopieren. Aktiviere anschließend „Ich habe meinen API-Key kopiert und sicher gespeichert“ und klicke auf Fertig.

Deine API-Keys anzeigen

Alle für deine Einrichtung erstellten Keys werden auf der Seite Systemintegrationen aufgelistet. Dort siehst du den Namen, den Berechtigungsbereich und das Erstellungsdatum des jeweiligen Keys.

Der API-Key selbst wird in dieser Liste nicht erneut angezeigt – dort werden nur sein Name und Berechtigungsbereich angezeigt.

API-Key löschen

Suche auf der Seite Systemintegrationen den Key, den du löschen möchtest.
Klicke unter Aktionen auf das Löschsymbol.
Bestätige im Fenster mit Key löschen.

Wichtig: Das Löschen eines Keys erfolgt sofort und kann nicht rückgängig gemacht werden. Jedes externe System, das diesen Key noch verwendet, verliert unmittelbar den Zugriff auf die Octiv API.

Du kannst jederzeit einen neuen Key erstellen, um einen gelöschten Key zu ersetzen.

Was diese erste Version umfasst

Diese Version unterstützt das Erstellen, Benennen, Anzeigen und Löschen von API-Keys für Leads.

Noch nicht enthalten sind Ablaufdaten für Keys, Key-Rotation, Audit-Logs oder andere Integrationstypen außer Leads. Diese Funktionen können in zukünftigen Versionen ergänzt werden.