So erstellen und verwalten Sie API-Schlüssel
Hinweis: Dies ist ein hoch technischer Artikel. Daher empfehlen wir, beim Lesen Ihre IT‑Abteilung hinzuzuziehen. Bei Fragen oder Anliegen kontaktieren Sie uns bitte unter support@azumuta.com – wir helfen Ihnen gerne weiter.
API‑Schlüssel authentifizieren Anfragen an Azumuta’s REST API. Jeder Schlüssel gehört zu einem API device in Ihrem Workspace. Sie verwalten diese Geräte auf der Seite API Devices.
So erstellen Sie einen API‑Schlüssel
- Gehen Sie zu Management → Devices → Tab API. Der Seitentitel lautet API Devices.
- Klicken Sie auf Add device.
- Tragen Sie einen Namen unter 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 Devices‑Seiten finden Sie in Wie Sie die Liste der auf Ihrem Workspace angemeldeten Geräte einsehen.
So kopieren Sie einen API‑Schlüssel
Sie können einen Schlüssel auf eine der folgenden Arten kopieren:
- Öffnen Sie in der Liste API Devices das Zeilenmenü des Geräts und klicken Sie auf Copy API key. Eine Snackbar zeigt Copied an.
- Oder klicken Sie auf Edit device, suchen Sie API attributes und verwenden Sie dann das Kopiersymbol neben dem Feld API key.
So authentifizieren Sie API‑Anfragen
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. Verwenden Sie nach Möglichkeit den Header.
Alle API‑Anfragen müssen HTTPS verwenden. Anfragen über reines HTTP schlagen fehl. Anfragen ohne einen gültigen Schlüssel werden ebenfalls abgewiesen.
Wichtig: Legen Sie einen API‑Schlüssel niemals in Browser‑Clientcode, öffentlichen Repositorien oder an anderen Orten außerhalb Ihres Unternehmens ab. Behandeln Sie Schlüssel ausschließlich als geheime Zugangsdaten für serverseitige Integrationen.
Gültigkeitsbereich der Umgebung
API‑Schlüssel sind umgebungsspezifisch. Ein auf Ihrem Sandbox‑Host erstellter Schlüssel funktioniert nur in dieser Sandbox‑Umgebung. Ein Produktionsschlüssel funktioniert nur in der Produktion. Die Verwendung eines Sandbox‑Schlüssels in der Produktion (oder umgekehrt) führt zu einem Authentifizierungsfehler.
Optional: API Scopes
Wenn das API‑Scopes‑Experiment für Ihren Workspace aktiviert ist, können Sie einschränken, was ein Schlüssel tun 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 den Standardzugriff für ein API device.