API-Schlüssel erstellen und verwalten
Hinweis: Dies ist ein sehr technischer Artikel. Daher empfehlen wir, Ihre IT‑Abteilung bei der Lektüre hinzuzuziehen. Sollten Sie Fragen oder Anliegen haben, kontaktieren Sie uns 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-Gerät in Ihrem Arbeitsbereich. Sie verwalten diese Geräte auf der Seite API-Geräte.
Erstellen eines API-Schlüssels
- Gehen Sie zu Verwaltung → Geräte → Reiter API. Der Seitentitel lautet API-Geräte.
- Klicken Sie auf das gelbe Plus → Gerät hinzufügen.
- Geben Sie einen Name ein, setzen Sie Typ auf API-Gerät, und klicken Sie auf Hinzufügen.
Azumuta erstellt das Gerät und generiert einen API-Schlüssel dafür.
Für allgemeine Informationen zu den Geräte-Seiten siehe See the list of devices that are logged in on your workspace.
API-Schlüssel kopieren
Sie können einen Schlüssel auf eine der folgenden Arten kopieren:
- In der Liste API-Geräte öffnen Sie das Zeilenmenü des Geräts und klicken auf API-Schlüssel kopieren. Ein Snackbar zeigt Kopiert.
- Oder klicken Sie auf Gerät bearbeiten, suchen Sie API-Attribute und verwenden Sie dann das Kopiersymbol neben dem Feld API-Schlüssel.
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. Verwenden Sie nach Möglichkeit den Header.
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 einen API-Schlüssel niemals in Browser-Client-Code, in öffentlichen Repositories oder an Orten außerhalb Ihres Unternehmens ab. Behandeln Sie Schlüssel ausschließlich als geheime Zugangsdaten für serverseitige Integrationen.
Umgebungsbereich
API-Schlüssel sind umgebungsspezifisch. Ein Schlüssel, der in Ihrer Sandbox-Umgebung erstellt wurde, funktioniert nur in dieser Sandbox. 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 Arbeitsbereich aktiviert ist, können Sie einschränken, was ein Schlüssel darf. Öffnen Sie Gerät bearbeiten → Sicherheit und konfigurieren Sie dort API-Scopes. Wenn diese Option in Ihrem Arbeitsbereich nicht verfügbar ist, hat der Schlüssel die Standardzugriffsrechte eines API-Geräts.