Öffnen Sie Cloud-Authentifizieren und autorisieren Sie den Zugriff auf die API mit der Verwendung von API-Schlüsseln, mit denen Sie granulare Berechtigungen und Sicherheitssteuerung für den Zugriff und die Verwendung bestimmter Ressourcen in Ihrem Erlebnis hinzufügen können, wie z. B. Datenspeicher und Orte.
Alle Open Cloud-APIs erfordern, dass du einen API-Key mit gültigen Berechtigungen erstellst und einen x-api-key-Header in deiner Anfrage entwickelst, der die Anwendung auf deinen Namen authentifiziert, um Open Cloud auf deinen Namen zu öffnen.
API-Schlüssel erstellen
Du kannst API-Schlüssel für deine individuell besessenen Erlebnisse oder Erlebnisse einer Gruppe erstellen und konfigurieren (ein Roblox-Gruppen ermöglicht es mehreren Erstellern, an demselben Erlebnis zu arbeiten, die gleichen Ressourcen zu verwenden und API-Schlüssel zu teilen).
Du musst der Gruppenbesitzer oder einer zugewiesenen Rolle innerhalb der Gruppe sein, der die API-Schlüsselverwaltungsberechtigung hat, um einen API-Schlüssel für deine Gruppe zu erstellen. Ein Gruppenmitglied kann nur einen API-Schlüssel erstellen, der die gleichen Zugriffsberechtigungen wie seine Rolle hat. Zum Beispiel können nur Mitglieder der Gruppe erstellen und bearbeiten Gruppenerlebnisse -Berechtigung einen Ort-Datei veröffentlichen.
Um einen API-Schlüssel zu erstellen:
Navigiere zum Creator-Dashboard.
(Optional) Klicken Sie auf die Creator-Hub-Dropdown-Liste , um eine Gruppe auszuwählen, wenn Sie den API-Schlüssel für eine Gruppe erstellen.
In der linken Navigation Öffnen Cloud → API Schlüssel .
Klicken Sie auf die Schaltfläche API-Schlüssel erstellen .
Geben Sie ein einzigartigen Namen für Ihren API-Schlüssel ein. Verwenden Sie einen Namen, der Ihnen hilft, den Zweck später wieder zu erinnern, z. B. PLACE_PUBLISHING_KEY für die Veröffentlichung von Orten in Ihrem Erlebnis.
In der Zugriffsberechtigungen-Sektion, wählen Sie eine API aus dem Zugriffssystem-Menü und klicken Sie auf die Schaltfläche API-System hinzufügen ". Wiederholen Sie diesen Prozess, wenn Sie mehrere APIs zum Schlüssel hinzufügen müssen.
Wählen Sie das Erlebnis, auf das Sie mit dem API-Schlüssel zugreifen möchten.
From the Erlebnissen-Operations dropdown, select the operations that you want to enable for the API-Schlüssel.
Viele Operationen in der API-Referenz enthalten die erforderlichen Berechtigungsskope. Zum Beispiel erfordert die Flush-Memory-Store-Flush-Operation die Berechtigung universe.memory-store:flush.
Aus Sicherheitsgründen geben Sie jedem API-Key die minimale Anzahl der erforderlichen Berechtigungen. Wenn ein API-Key austreten sollte, gewährleistet dieses Prinzip der geringsten Privilegien, dass nur ein Unterteil Ihrer Ressourcen kompromittiert wird.
In der Sicherheits -Sektion, geben Sie explizit den Zugriff auf IP-Zugriff mit CIDR-Notation fest, sonst können Sie nicht auf die API-Schlüssel zugreifen. Sie können
(Optional) : Um zusätzlichen Schutz für deine Ressourcen hinzuzufügen, setze ein explizites Ablaufdatum, damit dein Schlüssel nach diesem Datum automatisch aufhört zu arbeiten.
Klicken Sie auf die Schaltfläche Speichern und generieren Sie Schlüssel .
Kopiere und speichere die API-Schlüsselstrung an einen sicheren Ort, der nicht ist nicht ein öffentliches Repository deines Codes.
Überprüfen Sie Ihren erstellten API-Schlüssel auf der Credits-Seite von Creator-Dashboard .
Die API-Schlüsselstrung entspricht dem Passwort Ihrer Anwendung. Teilen Sie es niemals mit unvertrauenswürdigen Parteien, wie z. B. jeder außer Ihrem Team.
Gruppenbesitzte API-Berechtigungen
Gruppenbesitzer können die API-Schlüsselberechtigungen für Gruppenmitglieder verwalten, um verschiedene Ebene der API-Kontrolle basierend auf den Rollen und Berechtigungen innerhalb der Gruppe zu haben. Es gibt auch Situationen, in denen die API-Schlüsselverwaltungsberechtigungen für Gruppenmitglieder automatisch zurückgezogen werden.
Berechtigungen gewähren
Als Eigentümerkannst du der Alle API-Schlüssel verwalten -Berechtigung für Rollen innerhalb deiner Gruppe gewähren. Mit dieser Berechtigung haben Mitglieder mit dieser Berechtigung alle Berechtigungen, die ein Gruppenbesitzer für API-Schlüssel hat, einschließlich der Fähigkeit, zu erstellen, anzuzeigen, zu bearbeiten, zu widerrufen und zu überprüfen alle API-Schlüssel der Gruppe.
Sie können auch der Verwalten eigenen API-Schlüssel -Berechtigung für Rollen innerhalb Ihrer Gruppe gewähren. Dies ermöglicht es den Mitgliedern, nur Schlüssel zu erstellen und anzuzeigen, die von ihnen besitzt werden, und nicht in der Lage sind, die Schlüssel anderer zu verwalten.
Berechtigungs-Unverifizierung
Es gibt mehrere Situationen, in denen die Berechtigung eines Mitgliedautomatisch widerrufen wird, um die Gruppen-API-Schlüssel zu verwalten:
- Dem Mitglied wird eine andere Rolle zugewiesen, die die Berechtigung nicht hat. Dies kann während einer Übertragung der Gruppenbesitzung passieren.
- Die Berechtigung des Mitglieds ist auf der aktuell zugewiesenen Rolle deaktiviert.
- Der Mitte verlässt oder wird aus der Gruppe entfernt.
- Das Konto des Mitglieds wird von Roblox moderiert.
In einem dieser Fälle werden API-Schlüssel, die von diesem Benutzer generiert wurden, mit dem Revoked-StatusStatus gegeben. Um diese Schlüssel erneut zu verwenden, muss der Gruppenbesitzer oder ein Mitglied mit der Alle API-Schlüssel verwalten-Berechtigung die Schlüssel wieder generieren.
CIDR-Format
Um deine Ressourcen weiter zu schützen, wenn Sie einen API-Schlüssel erstellen, geben Sie IP-Adressen an, die auf den API-Schlüssel mit normalen IP-Adressen zugreifen können, oder verwenden Sie die CIDR-Notation, eine CIDR-IP-Adresse sieht wie eine normale IP-Adresse aus, mit dem Endung mit einem Stern und einem Zeichen, das die Anzahl der Bit der IP-Adresse darstellt, die für Netzwerk-Routierung wichtig sind:
- Normal : 192.168.0.0
- CIDR : 192.168.0.0/24
Der ehemalige Teil ist die IP-Adresse, und der letzte Teil ist die Netzmaske , die die Bits von 1s in binärer Form zählt. Im folgenden Beispiel bedeutet 24 255.255.25
API-Schlüsselstatus
API-Schlüssel haben zuerst einen aktiven Status, aber sie können im Laufe ihres Lebens inaktiv werden. Um zu lernen, warum ein API-Schlüssel den Status geändert hat und wie Sie den API-Schlüssel zurück zu einem aktiven Status zurückrufen, siehe die folgende Tabelle.
Wenn Sie oder Ihre Gruppe keinen API-Schlüssel für 60 Tage verwenden oder aktualisieren, wird er automatisch abgelaufen, auch wenn er keine festgelegte Ablaufdatum hat. Dies reduziert das Risiko von Bösewichten, die alten API-Schlüssel verwenden. Wenn Sie keinen API-Schlüssel mehr verwenden, sollten Sie ihn manuell deaktivieren oder löschen.
| Status | Grund | Auflösung |
|---|---|---|
| Aktiv | Keine Probleme. Der Benutzer kann den Schlüssel verwenden, um API-Anrufe zu authentifizieren. | N/A |
| Deaktiviert | Der Benutzer deaktivierte den Schlüssel, indem er die Schlüssel aktivieren umschaltendeaktivierte. | Aktivieren Sie die Taste aktivieren umschalten. |
| Abgelaufen | Die Verfallsdatum des Schlüssels ist abgelaufen. | Entfernen Sie entweder ein oder setzen Sie ein neues Ablaufdatum. |
| Automatisch abgelaufen | Der Benutzer hat den Schlüssel in den letzten 60 Tagen nicht verwendet oder aktualisiert. | Du kannst entweder den Disable Key umschaltendeaktivieren, oder du kannst alle Eigenschaften des Schlüssels aktualisieren, wie den Namen, die Beschreibung oder das Ablaufdatum. |
| Widerrufen | Nur für Gruppen Schlüssel. Der帐, der den Schlüssel erstellt hat, hat nicht mehr die Berechtigung, die Schlüssel der Gruppe zu verwalten. | Klicken Sie auf den Regenerate Key, um einen neuen Schlüssel zu erhalten. |
| Moderiert | Ein Roblox-Administrator hat den Schlüssel aus Sicherheitsgründen geändert. | Klicken Sie auf den Regenerate Key, um einen neuen Schlüssel zu erhalten. |
| Benutzer moderiert | Das Konto, das den Schlüssel erstellt hat, wird von Roblox moderiert. | Löse das Moderationsproblem auf dem Konto. |