API Key Management
2 Minuten Lesezeit
API Key Management
Im Bereich API Key Management können API Keys erstellt, eingesehen und gelöscht werden.
Die API Keys für die CloudHub API haben ein Ablaufdatum und müssen nach einer bestimmten Zeit erneuert werden. 8 Wochen bevor sie ablaufen, erinnern wir Sie mit einem Banner und einer E-Mail daran, die API Keys zu erneuern. Die E-Mail wird jede Woche einmal verschickt.
Wenn noch keine API Keys erstellt wurden, wird lediglich die Schaltfläche zur API-Key-Erstellung angezeigt.
API Key erstellen
Klicken Sie auf „API Key hinzufügen“ (wenn Sie noch keine API Keys erstellt haben, heißt der Button “API Key erstellen”). Daraufhin gelangen Sie zu einem Formular, in dem Sie folgende Angaben tätigen müssen:
| API-Key-Name | Der Name, unter dem der API Key angezeigt werden soll. Dieser wird nicht zur Authentifizierung verwendet. |
| gewünschte API-Version | Die CloudHub API ist versioniert und bei Breaking Changes wird eine neue Version ausgerollt. Hier können Sie auswählen, für welche Version Sie einen API Key erstellen. |
| Ablaufdatum | Die API Keys für die CloudHub API müssen nach einer bestimmten Zeit erneuert werden. Hier können Sie auswählen, nach welcher Zeit. Zur Auswahl stehen 30, 90 und 180 Tage. |
| IP-Bereich, auf den der API Key begrenzt sein soll | Sie können Ihren API Key auf einen bestimmten IP-Bereich einschränken, dieser ist dann nur für Requests aus diesem IP-Bereich gültig. Die Auswahl ist optional und kann nach der Erstellung im Identity & Access Management abermals getätigt bzw. angepasst werden. |
Nachdem Sie das Formular bestätigt haben, gelangen Sie zurück zu der Übersicht und sehen oben auf der Seite in einem grünen Kasten die API Key ID und das API Key Secret des erstellten Schlüssels. Diese beiden Angaben sind für die Authentifizierung Ihrer Requests mit dem zugehörigen API Key notwendig. Das API Key Secret wird Ihnen nur direkt nach der Erstellung angezeigt und wenn Sie die Seite verlassen, wird es Ihnen nicht noch einmal angezeigt. Die API Key ID wird Ihnen in der Übersichtstabelle weiterhin angezeigt.
Um Ihren API Key nutzen zu können, müssen Sie ihm noch Berechtigungen erteilen. Eine Anleitung dazu finden Sie hier.