In der Setup-Umgebung in MICE können Sie Ihre eigenen API-Keys erstellen und verwalten. In diesem Artikel finden Sie eine Erklärung, was ein API-Key ist, welche Optionen verfügbar sind und wie Sie diese nutzen.
Sie finden den Bereich für API-Keys unter Setup > Integrationen > API-Keys.
Was ist ein API-Key?
Ein API-Key ist eine Art digitaler Schlüssel. Man kann ihn mit dem Schlüssel zu Ihrer Haustür vergleichen: Nur mit dem richtigen Schlüssel erhält man Zutritt. In diesem Fall gewährt der API-Key Ihren Systemen oder Apps Zugriff auf Daten aus Ihrem MICE-Konto.
Mit einem API-Key können Sie sicher und automatisch Daten zwischen MICE und anderen von Ihnen verwendeten Systemen austauschen.
⚠️ Wichtig: Genau wie einen echten Schlüssel sollten Sie Ihren API-Key mit Sorgfalt behandeln. Wenn jemand anderes in den Besitz des Schlüssels gelangt, könnte diese Person ebenfalls Zugriff auf Ihre Daten oder Systeme erhalten (um Daten zu lesen, zu ändern oder zu löschen). Teilen Sie einen API-Key niemals mit nicht vertrauenswürdigen Parteien.
Funktionen im Bereich API-Keys
Im Bereich API-Keys können Sie verschiedene Aktionen durchführen:
1. Einen neuen API-Key erstellen
Benutzende mit der Rolle Administrator können einfach einen neuen API-Key generieren:
Gehen Sie zu Setup > Integrationen > API-Keys.
Klicken Sie auf die Schaltfläche + Neuer API-Key.
Geben Sie dem Schlüssel optional einen erkennbaren Namen (z. B. den Namen der Anwendung oder Integration).
Bestätigen Sie die Aktion.
💡 Tipp: Erstellen Sie für jede Integration einen separaten API-Key und verwenden Sie einen eindeutigen Namen. So wissen Sie immer, welcher Schlüssel zu welcher Integration und welchem Datenaustausch gehört.
API-Key-Übersicht
In der API-Key-Übersicht finden Sie alle vorhandenen API-Keys. Sie können folgendes einsehen:
Das Datum und die Uhrzeit, zu der ein API-Key erstellt wurde.
Den Namen eines API-Keys.
Eine Schaltfläche zum Anzeigen des API-Keys.
Eine Schaltfläche zum Regenerieren des API-Keys.
Den Status des API-Keys: Aktiviert oder Widerrufen.
2. Einen API-Key anzeigen und kopieren
Klicken Sie auf Key anzeigen, um den vollständigen API-Key einzublenden.
Um den Key zu kopieren, klicken Sie auf das Zwischenablage-Symbol (siehe Beispiel unten).
3. Einen API-Key neu generieren
Falls ein API-Key versehentlich geteilt wurde oder kompromittiert sein könnte, können Sie ihn neu generieren:
Öffnen Sie die API-Key-Übersicht.
Klicken Sie neben dem entsprechenden API-Key auf Regenerieren.
Der alte Key wird automatisch ungültig und durch einen neuen ersetzt.
4. Einen API-Key widerrufen oder freigeben
Wenn Sie einen API-Key nicht mehr verwenden oder wenn er ungültig gemacht werden soll (zum Beispiel, wenn eine Integration beendet wurde), können Sie ihn widerrufen:
Öffnen Sie die API-Key-Übersicht.
Klicken Sie auf der rechten Seite des entsprechenden API-Keys auf Widerrufen.
Der API-Key wird sofort ungültig. Alle verbundenen Integrationen verlieren augenblicklich den Zugriff.
E-Mail-Benachrichtigungen für neue API-Keys
Wenn jemand in Ihrer Organisation einen neuen API-Key erstellt, erhalten alle Administratoren automatisch eine E-Mail-Benachrichtigung. Auf diese Weise bleiben Admins über neue Integrationen informiert und können bei Bedarf Maßnahmen ergreifen.
Beispiel-E-Mail:
Tipps
Separate Keys pro Integration nutzen: Dies sorgt für Klarheit und erleichtert den Widerruf, falls erforderlich.
Zugriff beschränken: Widerrufen Sie ungenutzte oder unerwünschte API-Keys sofort.
Regelmäßig prüfen: Behalten Sie die Übersicht im Auge und achten Sie auf ungewöhnliche Erstellungszeitpunkte.
Vorsicht beim Teilen: Teilen Sie einen API-Key niemals über unsichere Kanäle oder mit unbekannten Personen oder E-Mail-Adressen.
API-Key-Historie: Wer hat was getan?
Zusätzlich zum Erstellen, Regenerieren oder Widerrufen von API-Keys bietet die Setup-Umgebung innerhalb von MICE Operations auch Einblick darüber, wer welche Aktionen in der API-Key-Umgebung durchgeführt hat.
Unter Setup > Historie ist ein Protokoll verfügbar, das zeigt, wann ein API-Key erstellt, angezeigt, geändert oder widerrufen wurde – und durch welchen Benutzenden. Dies ermöglicht es Ihnen, leicht zu überprüfen, wer eine Aktion mit welchem Key durchgeführt hat.
💡 Tipp: Wählen Sie im Bereich Historie das Objekt „API-Key“ aus, um eine Übersicht aller Aktionen im Zusammenhang mit API-Keys zu erhalten.
