API Schlüssel

API-Schlüssel verwenden die Rollebasierte Zugriffssteuerung (RBAC). Ein Schlüssel kann eine Organisationseinheit-Rolle, App-basierte Bindungen oder beide haben. Jede App-Bindung bleibt mit der zugehörigen Organisation verbunden. Für die geringste Privilegien sollten Sie einen Schlüssel auf ausgewählte Apps beschränken, anstatt eine Organisationseinheit-Rolle zuzuweisen.

Wo werden API-Schlüssel verwaltet?

Navigieren Sie zu Einstellungen > Organisation > API-Schlüssel auf console.capgo.app/einstellungen/organisation/api-schlüssel.

Die Seite zeigt zwei Abschnitte an:

• RBAC-Schlüssel — Schlüssel mit zugewiesenen Rollen (empfohlen). Diese Schlüssel verwenden das neue Rollebasierte Berechtigungssystem.
• Legacy-Schlüssel — Ältere Schlüssel, die das einfache Modus-basierte System (read, upload, write, all) ohne Rollenzuweisungen verwenden.

Wie erstellt man einen neuen API-Schlüssel?

1. Klicken Sie auf ”+” Schlüssel oben im RBAC-Tabelle

2. Füllen Sie die Schlüsselinformationen:

   • Name (erforderlich) — Eine beschreibende Bezeichnung für den Schlüssel (z. B. „CI/CD Deploy“ oder „Monitoring Read-Only“).
   • Sicheren Schlüssel erstellen (optional) — Wenn aktiviert, wird die Schlüssel hashiert. Der Plain-Text-Schlüssel wird einmal angezeigt. nur einmal nach der Erstellung und kann nicht später abgerufen werden.
   • Setzen Sie eine Ablaufzeit (optional) — Wählen Sie einen Zeitpunkt, nach dem der Schlüssel nicht mehr funktioniert. Einige Organisationen erzwingen eine Ablaufzeit durch Richtlinie.

3. Wählen Sie den Schlüsselscope:

   • Organisationsweite Zugriffsberechtigung — Wählen Sie eine Organisationsrolle um die Grundrechte innerhalb der Organisation festzulegen. Die verfügbaren Rollen hängen von Ihrem eigenen Rollenlevel ab:
     • Keine — Keine Organisationsebene Zugriff.
     • Mitglied — Grundlegende Leserecht auf die Organisation.
     • Administrator — Vollständiger Administratorzugriff auf die Organisation und alle ihre Apps.
   • Nur App-Zugriff — Aktivieren Beschränke diese Schlüssel auf ausgewählte Apps. Jedes App-Binding bleibt mit der App verbunden, die dieser Organisation gehört; Diese Modus umfasst nur eine Organisationsebene RBAC-Rolle.

4. Wenn der Schlüssel Organisationen über den öffentlichen API erstellen muss, aktiviere Erstelle Organisationen zulassen.

   Dies fügt den globalen org.create Zugriffsrechte. Der Schlüssel benötigt auch eine organisationsspezifische org_admin oder org_super_admin bindung. In der Dashboard, auswählen Admin erstellt die org_admin Zugriffsrechte. Wenn dieser Schlüssel eine neue Organisation erstellt, wird Capgo automatisch als Super Admin auf dieser neuen Organisation zugewiesen.

5. Um Anwendungen Zugriff zu gewähren:

   • Wenn Beschränke diesen Schlüssel auf ausgewählte Apps ist aktiviert, wähle eine Organisation unter Organisationen, um Apps zu filtern um deren Apps zu enthüllen. Die ausgewählten App-Bindungen bleiben mit ihren eigenen Organisationen verbunden; diese Filterung gewährt keine organisationseinheitlichen Zugriffsrechte.
   • Klicken “+ App hinzufügen”, wählen Sie eine oder mehrere Apps aus und zuweisen Sie jeder eine Rolle:
     • App Leser — Nur-Lese-Zugriff auf die App.
     • App Händler — Kann neue Pakete hochladen.
     • App Entwickler — Kann Pakete hochladen, Geräte verwalten, native Builds auslösen und Kanal-Einstellungen aktualisieren.
     • App Administrator — Vollzugriff auf die App.
     • App Vorschau – Voransicht des CI/CD-Lebenszyklus: Hochladen eines Bundles und Erstellen einer Voransichts-Kanäle. Der Kanal erhält automatische, kanalspezifische Lebenszyklusrechte nur für diese Schlüssel.

6. Klicken Sie “Erstellen”.

7. Wenn Sie ‘Erstellen’ ausgewählt haben Erstellen Sie einen sicheren Schlüssel, erscheint ein Modalfenster mit dem Klartextschlüssel. Kopieren Sie es sofort — es kann nicht nach dem Schließen des Modals wiederhergestellt werden.

Verwenden Sie einen App-Vorschau-Schlüssel für Vorschau-Workflows

Use App-Vorschau für CI, das eine temporäre, nicht öffentliche Vorschaukanal erstellt, ein Paket hochlädt und promotet, dann sowohl den Kanal als auch das Paket entfernt. Es hat keinen Lebenszyklus-Zugriff auf einen bestehenden Standard- oder Hauptkanal.

1. Erstelle eine RBAC-Schlüssel und aktiviere Beschränke diesen Schlüssel auf ausgewählte Apps.
2. Unter Organisationen, um Apps zu filtern, wähle die Organisation aus, um ihre Apps anzuzeigen; jede ausgewählte App bleibt mit ihrer eigenen Organisation verbunden.
3. Füge nur die App oder Apps hinzu, die für Vorschau-Deployments verwendet werden.
4. Wähle App-Vorschau für jede ausgewählte App.
5. Erstelle einen sicheren Schlüssel, setze einen Ablaufdatum, wenn dies angemessen ist, und speichere ihn in deinem CI-Secret-Manager.

Diese ausgewählten-Anwendungen-only-Modus verweist auf eine Organisation-Rolle; es kann entfernen Sie die Organisationen-Verbindung. Jeder app_preview Die Bindung bleibt auf die ausgewählte App beschränkt und auf die Organisation, die diese App besitzt.

Grant	Berechtigungen und Grenzen
app_preview Berechtigungen und Grenzen	app.read, app.read_bundles, app.upload_bundle, and app.create_channel.
und channel_preview Automatische	Wenn diese Schlüssel einen Kanal erstellt, gibt Capgo automatisch dem Schlüssel channel.read, channel.promote_bundle, and channel.delete für diesen Kanal nur.

app_preview beibehält app.read, sodass der Schlüssel die Kanalmetriken der ausgewählten App auflisten kann. Die automatische Kindbindung ist ein Verwaltung Grenze: Sie gewährt keine Lebenszyklusmutationen für Kanäle, die der Schlüssel nicht erstellt hat.

Capgo registriert auch, welcher App-Vorschau-Schlüssel ein Paket hochgeladen hat. Der Schlüssel kann nur sein eigenes Paket auf jedem Vorschaukanal erstellen, den er erstellt, und kann diese Paarung gemeinsam löschen. Er erhält jedoch keine Kanalbindung für einen bestehenden Standard- oder Hauptkanal, einen von einem anderen Vorschau-Schlüssel erstellten Kanal oder ein anderes Schlüsselpaar.

Für einen typischen CI-Auftrag verwenden Sie einen eindeutigen Kanalnamen pro Pull-Request:

APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"

npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"

npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

für einen neuen Kanal bundle upload --channel erstellt den Kanal, lädt das Paket hoch und promotet es in einem Workflow. Die letzte Anweisung verwendet eine enge atomische Reinigungsroute: Sie gelingt nur, wenn der Schlüssel den Vorschaukanal und dessen verbundenes, nicht geteiltes Paket besitzt. App-Vorschau hat noch keine allgemeine bundle.deletedeshalb kann es einen beliebigen Bundle nicht löschen.

Vorsicht

Verwende einen neuen nicht öffentlichen pr-<number> Kanal. Leite keine --default, --self-assign, Rollout-Optionen oder --delete-linked-bundle-on-upload diesem Workflow. Ein App-Vorschau Schlüssel kann keine bestehende Standard-/Hauptkanal, einen anderen Vorschau-Schlüssels Kanal oder einen anderen Schlüssels Bundle fördern, löschen oder ändern. Die Rücknahme oder das Ablaufdatum der App-Bindung entfernt auch den Schlüssels wirksamen Lebenszyklus-Zugriff.

Siehe die Zugriffssteuerungsreferenz für die volle Grenze.

Wie man einen API-Schlüssel bearbeitet?

Klicken Sie auf Zahnrad-Icon (Bearbeiten) auf jeder RBAC-Schlüssel in der Liste. Dies öffnet die Detailseite des Schlüssels, auf der Sie können:

• Ändern Sie die Schlüssel-ID name.
• benennen Organisationsrolle.
• Organisationsberechtigungsstatus aktivieren oder deaktivieren wenn das Schlüssel eine Admin-Organisationsrolle hat.
• Hinzufügen, entfernen oder ändern Anwendungsrollen.

Klicken “Änderungen speichern” wenn fertig.

Wie kann man einen API-Schlüssel neu generieren?

Um den geheimen Wert eines API-Schlüssels neu zu generieren, klicken Sie auf das aktualisieren-Symbol auf (Neu generieren) auf jedem Schlüssel in der Liste.

Eine Bestätigungsansicht erscheint. Nach Bestätigung:

• Für gesicherte (gehashte) Schlüssel: Ein neuer Textschlüssel wird generiert und einmal in einem Modalfenster angezeigt. Kopieren Sie ihn sofort.
• Für Textschlüssel: Der Schlüsselwert wird serverseitig neu generiert.

Jede Integration mit dem alten Schlüsselwert funktioniert sofort nicht mehr.

Wie lösche ich einen API-Schlüssel?

Klicken Sie auf Müll ikon Löschen Sie das Schlüssel in der Liste. Bestätigen Sie die Löschung im Dialog.

Das Schlüssel wird sofort widerrufen — jede Anfrage, die es verwendet, schlägt fehl.

Veraltete Schlüssel

Wenn Sie Schlüssel in der Veraltete Schlüssel Sektion (Schlüssel ohne Rollenzuweisungen) sehen, verwenden diese das ältere Modus-basierte Berechtigungssystem (read, upload, write, allSie funktionieren noch, nutzen aber nicht die Vorteile des RBAC fein abgestimmten Berechtigungssystems.

Veraltete Schlüssel können regeneriert und gelöscht werden, aber nicht bearbeitet werden, um RBAC-Rollen hinzuzufügen. Wir empfehlen, neue RBAC-Schlüssel zu erstellen und veraltete Schlüssel zu löschen, wenn möglich.

Wenn Sie veraltete Schlüssel direkt verwalten müssen, können Sie sie immer noch unter console.capgo.app/dashboard/apikartenDiese Seite ist veraltet und wird in einer zukünftigen Aktualisierung entfernt.

Weitermachen von API Schlüsseln

Wenn Sie Capgo verwenden API Übersicht API Übersicht für die Implementierungsdetails in API Übersicht API Übersicht für die Implementierungsdetails in API Übersicht Introduction für die Implementierungsdetails in der Einführung, API Übersicht Für die Implementierungsdetails in API-Schlüsseln, Geräte für die Implementierungsdetails in Devices, und Bundles für die Implementierungsdetails in Bundles.