API-Schlüssel erstellen und verwalten

Aktualisiert

Hinweis: Dieser Artikel ist technisch; wir empfehlen, dass Sie jemanden mit entsprechender technischer Expertise hinzuziehen. Bei Fragen kontaktieren Sie uns unter support@azumuta.com.

API-Schlüssel authentifizieren Anfragen an Azumutas REST-API. Jeder Schlüssel gehört zu einem API device in Ihrem workspace. Sie verwalten diese Geräte auf der API Devices-Seite.

API-Schlüssel erstellen

  1. Gehen Sie zu Management → Devices → Reiter API. Der Seitentitel lautet API Devices.
  2. Klicken Sie auf das gelbe plus → Add device.
  3. Geben Sie einen Name ein, setzen Sie Type auf Api Device, und klicken Sie dann auf Add.

Azumuta erstellt das Gerät und generiert dafür einen API-Schlüssel.

Weitere Informationen zu den Geräte-Seiten allgemein finden Sie unter Sehen Sie die Liste der Geräte, die in Ihrem Workspace angemeldet sind.

API-Schlüssel kopieren

Sie können einen Schlüssel auf eine der folgenden Arten kopieren:

  • In der Liste API Devices öffnen Sie das Zeilenmenü des Geräts und klicken auf Copy API key. In der Snackbar erscheint Copied.
  • Oder klicken Sie auf Edit device, suchen Sie API attributes, und verwenden Sie das Kopiersymbol neben dem Feld API key.

API-Anfragen authentifizieren

Senden Sie den Schlüssel im Request-Header X-API-Key. Das ist die empfohlene Methode.

Sie können den Schlüssel auch als Query-Parameter apiKey übergeben. Bevorzugen Sie jedoch den Header, wenn möglich.

Alle API-Anfragen müssen HTTPS verwenden. Anfragen über unverschlüsseltes HTTP schlagen fehl. Anfragen ohne gültigen Schlüssel schlagen ebenfalls fehl.

Wichtig: Legen Sie niemals einen API-Schlüssel in Browser-Client-Code, öffentlichen Repositories oder an einem Ort außerhalb Ihres Unternehmens ab. Behandeln Sie Schlüssel als geheime Zugangsdaten ausschließlich für serverseitige Integrationen.

Umgebungsscope

API-Schlüssel sind environment-scoped. Ein Schlüssel, der auf Ihrem Sandbox-Host erstellt wurde, funktioniert nur gegen diese Sandbox-Umgebung. Ein Produktionsschlüssel funktioniert nur in der Produktionsumgebung. Die Verwendung eines Sandbox-Schlüssels in der Produktion (oder umgekehrt) führt zu einem Authentifizierungsfehler.

Optional: API Scopes

Wenn das Experiment API scopes für Ihren Workspace aktiviert ist, können Sie einschränken, was ein Schlüssel darf. Öffnen Sie Edit device → Security, und konfigurieren Sie dort API scopes. Wenn diese Option in Ihrem Workspace nicht verfügbar ist, hat der Schlüssel die Standardzugriffsrechte für ein API device.

Auf dieser Seite