API-Schlüssel verwalten

Open Cloud authentifiziert und autorisiert den API-Zugriff mit der Verwendung von API-Schlüsseln, mit denen du granulare Berechtigungen und Sicherheitskontrollen hinzufügen kannst, um auf bestimmte Ressourcen in deiner Erlebniszuzugreifen und sie zu nutzen, wie z. B. Datenlagern und Orten.

Alle offenen Cloud-APIs erfordern, dass du einen API-Schlüssel mit gültigen Berechtigungen erstellst und einen x-api-key -Header in deiner Anfrage enthält, der es der Anwendung ermöglicht, sich bei Open Cloud in deinem Namen zu authentifizieren.

Erstelle API-Schlüssel

Du kannst API-Schlüssel für deine individuell im Besitz befindlichen Erlebnisse oder gemeinsam im Besitz befindlichen Erlebnisse erstellen und konfigurieren (eine Roblox-Gruppe gruppe ermöglicht es mehreren Erstellern, an demselben Erlebnis zu arbeiten, die gleichen Assets zu verwenden und API-Schlüssel zu teilen).

Du musst der Gruppenbesitzer oder einer Rolle innerhalb der Gruppe sein, die die API-Schlüsseladministratorberechtigung hat, um einen API-Schlüssel für deine Gruppe zu erstellen.Ein Gruppenmitglied kann nur einen API-Schlüssel mit den gleichen Ressourcenzugriffsberechtigungen seiner Rolle erstellen.Zum Beispiel können nur Gruppenmitglieder mit der Berechtigung Gruppenerlebnisse erstellen und bearbeiten einen API-Schlüssel erstellen, der einen Platz-Datei veröffentlichen kann.

Um einen API-Schlüssel zu erstellen:

1. Navigiere zum Creator-Dashboard.

2. (Optional) Klicken Sie auf das Dropdown-Feld Creator Hub , um eine Gruppe auszuwählen, wenn Sie den API-Schlüssel für eine Gruppe erstellen.

3. Wählen Sie im linken Navigationsmenü Öffne Wolke → API-Schlüssel .

4. Klicken Sie auf die Schaltfläche API-Schlüssel erstellen .

5. Geben Sie einen einzigartigen Namen für Ihren API-Schlüssel ein.Verwende einen Namen, der dir helfen kann, den Zweck später zu erinnern, wie z. B. PLACE_PUBLISHING_KEY für Veröffentlichungsplätze zu deiner Erlebnis.

6. Wählen Sie im Abschnitt Zugriffsberechtigungen eine API aus dem Menü API-System auswählen und klicken Sie auf die Schaltfläche API-System hinzufügen .Wiederhole diesen Schritt, wenn du mehrere APIs zum Schlüssel hinzufügen musst.

7. Wählen Sie das Erlebnis aus, auf das Sie mit dem API-Schlüssel zugreifen möchten.

8. Wählen Sie aus der Erfahrungsoperationen Dropdown-Liste die Operationen aus, die Sie für den API-Schlüssel aktivieren möchten.

   Viele Operationen in der API-Referenz enthalten die erforderlichen Berechtigungsbereiche.Zum Beispiel erfordert die Operation Flush-Speicher die Berechtigung ].

   Aus Sicherheitsgründen gib jedem API-Schlüssel die minimale Anzahl der erforderlichen Berechtigungen.Wenn ein API-Schlüssel ausläuft, gewährleistet dieses Prinzip des geringsten Privilegiums, dass nur ein Teil Ihrer Ressourcen kompromittiert wird.

9. Im Sicherheits -Abschnitt legen Sie den IP-Zugriff auf den Schlüssel explizit mit CIDR-Notation fest, sonst können Sie den API-Schlüssel nicht verwenden.Sie können die IP-Adresse Ihrer lokalen Maschine finden und sie zum Abschnitt Akzeptierte IP-Adressen hinzufügen, zusammen mit zusätzlichen IP-Adressen für diejenigen, die Zugriff benötigen.Wenn du keine feste geistiges Eigentumhast oder die API-Schlüssel nur in einer lokalen Umgebung verwendest, kannst du einfach 0.0.0.0/0 zum Abschnitt Akzeptierte IP-Adressen hinzufügen, um jede IP die Verwendung deines API-Schlüssels zu ermöglichen.

10. (Optional) : Um zusätzlichen Schutz für Ihre Ressourcen hinzuzufügen, legen Sie ein explizites Ablaufdatum fest, so dass Ihr Schlüssel nach diesem Datum automatisch aufhört zu arbeiten.

11. Klicken Sie auf die Schaltfläche Speichern und Generieren von Schlüsseln .

12. Kopiere und speichere den API-Schlüsselstring an einen sicheren Ort, der nicht ein öffentliches Repository deines Codes ist.

13. Überprüfe deinen erstellten API-Schlüssel auf der API-Erweiterungen Seite von Creator-Dashboard .

API-Schlüsselberechtigungen der Gruppe

Gruppenbesitzer können Gruppenmitgliedern mit API-Schlüsselberechtigungen unterschiedliche Kontrollstufen für API-Schlüssel auf der Grundlage der Rollen und Berechtigungen innerhalb der Gruppe ermöglichen.Es gibt auch Situationen, in denen API-Schlüsselverwaltungsberechtigungen automatisch für Gruppenmitglieder widerrufen werden.

Berechtigungen gewähren

Als Eigentümerkannst du den Alle API-Schlüssel verwalten -Berechtigungen Rollen innerhalb deiner Gruppe gewähren.Mitglieder mit dieser Berechtigung haben alle Berechtigungen, die ein Gruppenbesitzer für API-Schlüssel hat, einschließlich der Möglichkeit, alle API-Schlüssel der Gruppe zu erstellen, anzuzeigen, zu bearbeiten, zu widerrufen und zu überprüfen.

Du kannst auch der Verwaltung eigener API-Schlüssel Berechtigung für Rollen innerhalb deiner Gruppe gewähren.Dies ermöglicht es Mitgliedern, nur Schlüssel zu erstellen und anzuzeigen, die ihnen gehören, anstatt andere Schlüssel verwalten zu können.

Berechtigungsunwirksamkeit

Es gibt mehrere Situationen, die die Berechtigung eines Mitgliedautomatisch widerrufen, um Gruppen-API-Schlüssel zu verwalten:

• Das Mitglied wird einer anderen Rolle zugewiesen, die nicht die Berechtigung hat. Dies kann während einer Übertragung der Gruppenbesitz passieren.
• Die Berechtigung des Mitglieds ist auf seiner derzeit zugewiesenen Rolle deaktiviert.
• Das Mitglied verlässt oder wird aus der Gruppe entfernt.
• Der Account des Mitglieds wird von Roblox moderiert.

In jedem dieser Fälle werden API-Schlüssel, die von diesem Benutzer generiert wurden, den Widerruf Status erhalten.Um diese Schlüssel wieder zu verwenden, muss der Gruppeninhaber oder ein Mitglied mit der Berechtigung Alle API-Schlüssel verwalten die Schlüssel regenerieren.

CIDR-Format

Um deine Ressourcen weiter zu schützen, wenn du einen API-Schlüssel erstellst, gib IP-Adressen an, die auf den API-Schlüssel mit normalen IP-Adressen oder mit der CIDR-Notation zugreifen können.Eine CIDR-IP-Adresse sieht wie eine normale IP-Adresse aus, außer dass sie mit einem Schrägstrich und einer Zahl endet, die darstellt, wie viele Bits der IP-Adresse für das Netzwerk routing wichtig sind:

• Normal : 192.168.0.0
• CIDR : 192.168.0.0/24

Der frühere Teil ist die IP-Adresse und der letzte Teil ist die Netzmaske , die die Bits von 1s im Binärformat zählt.Im vorherigen Beispiel bedeutet 24 255.255.255.0 (24 1s), dass alle IPs zwischen 192.168.0.0 und 192.168.0.255 erlaubt sind.Die Verständnis des CIDR-Formats ist besonders nützlich, wenn Sie planen, Ihre Anwendungen auf einem Server auszuführen.

Status

API-Schlüssel haben zunächst einen aktiven Status, können aber im Laufe ihrer Lebenszeit inaktiv werden.Um zu erfahren, warum sich der API-Schlüsselstatus geändert hat und wie der API-Schlüssel zurück in einen aktiven Zustand gebracht werden kann, siehe die folgende Tabelle.