Zum Hauptinhalt springen
Version: Weekly Build

API-Schlüssel

Diese Anleitung erklärt, wie API-Schlüssel in Codesphere erstellt und verwaltet werden.

API-Schlüssel werden in den Benutzereinstellungen verwaltet.

  1. Auf das Profilbild in der oberen rechten Ecke klicken.
  2. User Settings auswählen.
  3. Zum Tab API Keys in der linken Seitenleiste navigieren.

Einen neuen API-Schlüssel erstellen​

API-Schlüssel ermöglichen es externen Anwendungen, im eigenen Namen mit Codesphere zu interagieren.

  1. Im Bereich API Keys auf die Schaltfläche Add New Key klicken.
  2. Dem Schlüssel einen Namen geben (z. B. „GitHub Actions“ oder „Local Development“), um sich später an dessen Zweck zu erinnern.
  3. Auf Create klicken.
  4. Den Schlüssel sofort kopieren. Aus Sicherheitsgründen wird der Schlüssel nur einmal angezeigt. Geht er verloren, muss er neu generiert werden.

Wichtiger Hinweis zu Zugriffsebenen
Derzeit besitzt ein API-Schlüssel, der für ein Konto erstellt wurde, dieselbe Zugriffs- und Berechtigungsebene wie das jeweilige Benutzerkonto selbst. Die Unterstützung für fein abgestufte Zugriffstokens (Scopes) steht auf unserer Roadmap und wird zukünftig hinzugefügt.

Tip icon

Ein Feature fehlt? Hilf uns, die Zukunft von Codesphere mitzugestalten. Neue Features können unter feedback.codesphere.com vorgeschlagen oder auf der Community-Roadmap bewertet werden.

Einen API-Schlüssel neu generieren​

  1. Den gewünschten Schlüssel in der Liste API Keys suchen.
  2. Auf das Symbol Regenerate (kreisförmiger Pfeil) neben dem Schlüsselnamen klicken.
  3. Die Aktion im Popup-Fenster bestätigen.
  4. Anwendungen aktualisieren: Der alte Schlüssel wird sofort ungültig und muss im Code oder in den Umgebungsvariablen durch den neuen Schlüssel ersetzt werden.

Häufig gestellte Fragen​

  1. Wie viele Schlüssel können erstellt werden?
    Es können beliebig viele Schlüssel generiert werden.

  2. Was passiert, wenn ein Schlüssel gelöscht wird?
    Jede Anwendung, die diesen Schlüssel verwendet, erhält beim Verbindungsversuch sofort einen 401-Unauthorized-Fehler.

  3. Kann ein Schlüssel auf Nur-Lese-Zugriff beschränkt werden?
    Noch nicht. Derzeit erben alle Schlüssel die vollständigen Berechtigungen des jeweiligen Kontos.