Durch die Registrierung Ihrer OAuth 2.0-App kann sie auf Roblox-Ressourcen zugreifen. Nach der Registrierung weist Roblox der App eine einzigartige Client-ID zu und einen Geheimcode, den Sie verwenden können, um der Autorisierung von Benutzern zu erhalten, um Zugriff auf ihre Roblox-Informationen und Ressourcen zu erhalten.
Registrieren deiner App
Um eine App zu registrieren:
- In dem Creator-Dashboard gehen Sie auf die OAuth 2.0-Apps Seite.
- Klicken Sie auf die Schaltfläche OAuth 2.0-App erstellen .
- Geben Sie einen gültigen und global einzigartigen Anwendungsnamen ein.
- Lesen und stimmen Sie den Roblox-Nutzungsbedingungen zu und klicken Sie auf Erstellen .
- Kopiere und speichere die Client-ID und Secret an einem sicheren Ort. Nach dem Schließen der Seite hast du keinen Zugriff mehr auf das Geheimnis und kannst nur ein neues erstellen. Nachdem du eine App registriert hast, kannst du auf die anderen Eigenschaften des Apps immer noch zugreifen und sie bearbeiten.
- Klicken Sie auf Weiter Bearbeiten , um Ihre App zu konfigurieren, die in den folgenden Abschnitten beschrieben ist.
Allgemeine Informationen konfigurieren
Sobald du deine App registriert hast, solltest du ihre allgemeinen Informationen konfigurieren, einschließlich:
- Eine Beschreibung, die für alle in der Roblox-Community sichtbar ist.
- Ein Miniaturbild für deine App. Die empfohlene Dateigröße beträgt mindestens 150x150 Pixel.
- Ein Eintrittslink als Zielseite deiner App, wie die App-Website-Hauptseite.
- Eine Privatsphäre-Nutzungsbedingungen-URL und eine Nutzungsbedingungen-URL für Endbenutzer, die vor dem Autorisieren deiner App gelesen werden müssen. Jede URL muss HTTPS sein und nicht mehr als 256 Zeichen lang sein.
Berechtigungen hinzufügen
Um einen angemessenen Zugriff und Sicherheitskontrolle innerhalb deiner App zu gewährleisten, musst du Berechtigungsskope hinzufügen . Es gibt zwei Arten von Berechtigungsskopen, die verfügbar sind:
- Identitäts-Skope für die Authentisierung, wie z. B. openid für Benutzer-IDs und profile für die vollständigen Profile. Wenn Sie das Skopium 0> profile 0> auswählen, müssen Sie auch 3> openid 3> auswählen.
- API-spezifische Berechtigungsskope , wie z. B. asset:read für die Leseberechtigung von Assets. Wählen Sie nur die minimale Anzahl von Skalen, die Sie für Ihre App benötigen.
Rote URLs hinzufügen
URLs umleiten sind die Eingangs Punkte deiner App, zu denen Benutzer weitergeleitet werden, wenn sie deine App autorisieren. Stell sicher, dass deine URLs die folgenden Anforderungen erfüllen:
- Alle Richtung URLs müssen in einer der folgenden Formen sein:
- Einfaches HTTPS, z. B.: https://www.example.com .
- Wege auf lokalen Host mit HTTP oder HTTPS (selbst signiertes Zertifikat) für lokale Debug-Zwecke, z. B.:
- http://localhost:80
- https://localhost:80
- Benutzerdefinierte Schemata für bestimmte Anwendungen oder Zwecke, z. B.:
- my-app-scheme:/
- my-app-scheme://foo/bar/...
- my-app://action?param1=value1¶m2=value2
- Die maximale Länge einer Umleitungs-URL beträgt 256 Zeichen.
- Du kannst bis zu 10 Rekonditionierungs-URLs hinzufügen. Mit mehreren Rekonditionierungs-URLs kannst du Test-Umgebungen erstellen und Benutzern ermöglichen, ohne Unterbrechung zwischen zwei Sites zu migrieren.
Für die Prüfung einreichen
Um die Wahrscheinlichkeit zu minimieren, dass bösartige Apps die Community schädigen, macht die Registrierung einer App nicht öffentlich zugänglich. Stattdessen bleibt sie in privaten Modus mit einer begrenzten Zahl von 100 autorisierten Benutzern. Dieser Modus ist hilfreich für das Testen und Debuggen innerhalb Ihres Teams.
Wenn Sie die Benutzerbasis für Ihre App erweitern möchten, müssen Sie sie im öffentlichen Modus veröffentlichen, indem Sie sie für eine bewerteneinreichen:
- Gehe zur OAuth 2.0 Apps Seite.
- Klicken Sie auf die Schaltfläche Bearbeiten und veröffentlichen für die App, die Sie veröffentlichen möchten.
- Füllen Sie alle erforderlichen Informationen aus und klicken Sie auf die Schaltfläche Überprüfen und veröffentlichen . Ein Nachricht mit Einschränkungen auf Ihren App-Berechtigungen während der Prüfungspause wird angezeigt.
- Klicken Sie auf Einreichen für die Überprüfung .
Während Ihrer App-Bewertung ist noch ausstehend, können Sie keine anderen Anfragen bearbeiten oder einreichen, bis die aktuelle Bewertungsanfrage genehmigt oder abgelehnt ist. Ihre App bleibt im privaten Modus während der bewerten. Wenn Ihre App genehmigt ist, wechselt sie in den öffentlichen Modus und Sie können sie nicht zurück in den privaten Modus zurückkehren.
Unabhängig davon, ob deine App genehmigt oder abgelehnt wird, erhältst du eine E-Mail-Benachrichtigung über das Ergebnis, wenn die Überprüfung abgeschlossen ist.
Bearbeitung und Löschung deiner App
Sie können Ihre App mit den folgenden Schritten bearbeiten oder löschen, wenn sie nicht bewertenwird:
Gehe zur OAuth 2.0 Apps Seite.
Klicken Sie auf Bearbeiten oder Löschen für die gewünschte App.
- Wenn Sie sich entscheiden, eine App zu bearbeiten, folgen Sie den gleichen Schritten und Anforderungen wie bei der Registrierung.
- Wenn Sie eine App löschen möchten, klicken Sie auf Ja, löschen , um die Löschung zu bestätigen. Nachdem Sie eine App gelöscht haben, können Sie sie nicht wiederherstellen.
Die Änderung der allgemeinen Informationen oder der Richtung der URL deiner App erfordert nicht, dass Benutzer die App erneut autorisieren müssen. Wenn du jedoch Berechtigungsskripte hinzufügst oder modifizierst, musst du die Berechtigung für die neuen Berechtigungen von deinen Benutzern erhalten und ein neues Set von Token erwerben. Wenn du keine Berechtigung für die neuen Skripte erhalten hast, kann deine App weiterhin mit den vorherigen Skripten verwendet werden, aber ist auf die vorherigen Skripte beschränkt
Für Anwendungen im privaten Modus aktualisiert das System Ihre Änderungen automatisch mit Ihren Benutzern. Für Anwendungen im öffentlichen Modus müssen Sie erneut die App für die Überprüfung einreichen, um diese Änderungen zu반영. Ansonsten speichert das System die nicht veröffentlichten Änderungen für Sie, ohne sie der Community freizugeben.