OAuth 2.0 App-Registrierung

Die Registrierung Ihrer OAuth 2.0-App ermöglicht den Zugriff auf Roblox-Ressourcen. Nach der Registrierung weist Roblox der App eine eindeutige Client-ID und ein Geheimnis zu, die Sie verwenden können, um die Autorisierung von Benutzern zu erhalten, um auf deren Roblox-Informationen und -Ressourcen zuzugreifen.

Registrieren Sie Ihre App

Um eine App zu registrieren:

1. Gehen Sie im Creator Dashboard zur Seite OAuth 2.0 Apps.
2. Klicken Sie auf die Schaltfläche App erstellen.
3. Geben Sie einen gültigen und weltweit eindeutigen Anwendungsnamen ein.
4. Lesen Sie die Roblox-Nutzungsbedingungen und stimmen Sie ihnen zu, und klicken Sie auf Erstellen.
5. Kopieren Sie die Client-ID und das Geheimnis und bewahren Sie sie an einem sicheren Ort auf. Nach dem Schließen der Seite haben Sie keinen Zugriff mehr auf das Geheimnis und können nur ein neues generieren. Nachdem Sie eine App registriert haben, können Sie weiterhin auf die anderen Eigenschaften der App zugreifen und diese bearbeiten.
6. Klicken Sie auf Weiter bearbeiten, um Ihre App zu konfigurieren, was in den folgenden Abschnitten beschrieben wird.

Allgemeine Informationen konfigurieren

Nachdem Sie Ihre App registriert haben, sollten Sie ihre allgemeinen Informationen konfigurieren, einschließlich:

• Eine Beschreibung, die für alle in der Roblox-Community sichtbar ist.
• Ein Thumbnail-Bild für Ihre App. Die empfohlene Dateigröße beträgt mindestens 150x150 Pixel.
• Einen Einstiegslink als Einstiegspunkt Ihrer App, z. B. die Homepage der App.
• Eine Datenschutzrichtlinien-URL und eine Nutzungsbedingungen-URL, die Endbenutzer lesen können, bevor sie Ihre App autorisieren. Jede URL muss HTTPS sein und darf maximal 256 Zeichen lang sein.

Berechtigungen hinzufügen

Um eine ordnungsgemäße Zugriffskontrolle und Sicherheit innerhalb Ihrer App zu gewährleisten, müssen Sie Berechtigungsbereiche hinzufügen. Es gibt zwei Arten von Berechtigungsbereichen:

• Identitätsbereiche zur Authentifizierung, wie openid für Benutzer-IDs und profile für die vollständigen Profile. Wenn Sie den Bereich profile auswählen, müssen Sie auch openid auswählen.
• API-spezifische Berechtigungsbereiche, wie asset:read für die Leseberechtigung von Assets. Wählen Sie nur die minimal erforderliche Anzahl von Bereichen aus, die Sie für Ihre App benötigen.

Weiterleitungs-URLs hinzufügen

Weiterleitungs-URLs sind die Wiedereintrittspunkte Ihrer App, zu denen Benutzer weitergeleitet werden, wenn sie Ihre App autorisieren. Stellen Sie sicher, dass Ihre Weiterleitungs-URLs die folgenden Anforderungen erfüllen:

• Alle Weiterleitungs-URLs müssen in einer der folgenden Formen vorliegen:

  • Einfaches HTTPS, zum Beispiel: https://www.example.com.`
  • Pfade auf localhost mit HTTP oder HTTPS (selbstsigniertes Zertifikat) für lokale Debugging-Zwecke, zum Beispiel:

    • http://localhost:80
    • https://localhost:80
  • Benutzerdefinierte Schemas für spezifische Anwendungen oder Zwecke, zum Beispiel:

    • my-app-scheme:/
    • my-app-scheme://foo/bar/...
    • my-app://action?param1=value1&param2=value2
• Die maximale Länge einer Weiterleitungs-URL beträgt 256 Zeichen.
• Sie können bis zu 10 Weiterleitungs-URLs hinzufügen. Mit mehreren Weiterleitungs-URLs können Sie Testumgebungen haben und Benutzern ermöglichen, zwischen zwei Seiten ohne Ausfallzeiten zu migrieren.

Zur Überprüfung einreichen

Um die Wahrscheinlichkeit zu minimieren, dass bösartige Apps der Community schaden, macht die Registrierung einer App sie nicht allgemein zugänglich. Stattdessen bleibt sie im privaten Modus mit einer Begrenzung von 10 einzigartigen Benutzern. Dieser Modus ist hilfreich für Tests und Debugging innerhalb Ihres Teams.

Wenn Sie die Benutzerbasis Ihrer App erweitern möchten, müssen Sie sie im öffentlichen Modus veröffentlichen, indem Sie sie zur Überprüfung einreichen:

1. Gehen Sie zur Seite OAuth 2.0 Apps.
2. Klicken Sie auf die Schaltfläche Bearbeiten und Veröffentlichen für die App, die Sie veröffentlichen möchten.
3. Füllen Sie alle erforderlichen Informationen aus, einschließlich des Demovideos und der Beschreibung, und klicken Sie dann auf die Schaltfläche Überprüfen und Veröffentlichen. Eine Nachricht mit Einschränkungen zu den Berechtigungen Ihrer App während des ausstehenden Überprüfungszeitraums erscheint.
4. Klicken Sie auf Zur Überprüfung einreichen.

Die folgenden Informationen sind für Ihre Einreichung erforderlich:

• Ein öffentlicher Demovideo-Link, der nicht länger als 1 Minute ist und die folgenden Anforderungen erfüllt:

  • Beginnt mit dem Benutzer, der abgemeldet ist, und zeigt die genaue Benutzeraktion, wie das Klicken auf Mit Roblox anmelden, die den OAuth-Zustimmungsdialog auslöst. Das Video muss den gesamten Autorisierungsfluss durch die Weiterleitung zurück zu Ihrer App zeigen, einschließlich des Inhalts in Ihrer ursprünglichen App nach der Weiterleitung.
  • Zeigt die gleichen Registrierungsdetails, die Sie mit Ihrer Einreichung bereitstellen.
• Eine Begründung, die erklärt, warum Ihre App in die ausgewählte Kategorie gehört und wie sie die angeforderten Berechtigungsbereiche verwendet.

Während Ihre App-Überprüfung aussteht, können Sie keine weiteren Änderungen vornehmen oder eine andere Anfrage einreichen, bis die aktuelle Überprüfungsanfrage genehmigt oder abgelehnt wird. Ihre App bleibt während der Überprüfung im privaten Modus. Wenn Ihre App genehmigt wird, wechselt sie in den öffentlichen Modus, und Sie können sie nicht wieder in den privaten Modus zurückversetzen.

Unabhängig davon, ob Ihre App genehmigt oder abgelehnt wird, erhalten Sie eine E-Mail-Benachrichtigung über das Ergebnis, wenn die Überprüfung abgeschlossen ist.

Bearbeiten und Löschen Ihrer App

Sie können Ihre App mit den folgenden Schritten bearbeiten oder löschen, wenn sie sich nicht in der Überprüfung befindet:

1. Gehen Sie zur Seite OAuth 2.0 Apps.

2. Klicken Sie auf Bearbeiten oder Löschen für die gewünschte App.

   • Wenn Sie sich entschieden haben, eine App zu bearbeiten, folgen Sie denselben Schritten und Anforderungen der Registrierung.
   • Wenn Sie sich entschieden haben, eine App zu löschen, 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.

Das Ändern der allgemeinen Informationen oder der Weiterleitungs-URLs Ihrer App erfordert nicht, dass Benutzer die App erneut autorisieren. Wenn Sie jedoch Berechtigungsbereiche hinzufügen oder ändern, müssen Sie die Autorisierung für die neuen Berechtigungen von Ihren Benutzern einholen und ein neues Set von Tokens erwerben. Wenn Sie keine Autorisierung für die neuen Bereiche einholen, kann Ihre App weiterhin die vorhandenen Tokens verwenden, ist jedoch auf die vorherigen Bereiche beschränkt.

Für Apps im privaten Modus aktualisiert das System automatisch Ihre Änderungen mit Ihren Benutzern. Für Apps im öffentlichen Modus müssen Sie die App erneut zur Überprüfung einreichen, um diese Änderungen widerzuspiegeln. Andernfalls speichert das System die unveröffentlichten Änderungen für Sie, ohne sie der Community zugänglich zu machen.