Przykładowa aplikacja OAuth 2.0

*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Roblox udostępnia przykładową aplikację Node.js, która pokazuje, jak używać OAuth 2.0, aby umożliwić użytkownikom logowanie się do ich kont Roblox oraz nadawanie wiadomości w ich grach. Ta aplikacja używa flow autoryzacji bez PKCE i jest zatem odpowiednia tylko dla zaufanych klientów, takich jak serwery prywatne.

Po pobraniu pliku .zip, rozpakuj go do własnego folderu.

Zarejestruj aplikację

Pierwszym krokiem do skonfigurowania aplikacji jest zarejestrowanie jej na stronie Roblox i skopiowanie identyfikatora klienta oraz sekretu w bezpieczne miejsce. Następnie postępuj zgodnie ze standardowymi krokami rejestracji z tymi ustawieniami:

W sekcji Uprawnienia dodaj zakresy openid, profile oraz universe-messaging-service:publish.
W sekcji Adresy URL przekierowań dodaj http://localhost:3000/oauth/callback do przekierowań. Jeśli chcesz używać portu innego niż domyślny dla swojej aplikacji, określ go tutaj.

Ustaw zmienne środowiskowe

Zamiast przechowywać je w kodzie (co nie jest zalecane), aplikacja używa zmiennych środowiskowych dla twojego identyfikatora klienta i sekretu. Proces dodawania zmiennych środowiskowych różni się w zależności od systemu operacyjnego.

Na systemie Windows uruchom następujące polecenia PowerShell:


$env:ROBLOX_CLIENT_ID='your_client_id_here'
$env:ROBLOX_CLIENT_SECRET='your_client_secret_here'
$env:ROBLOX_PORT=3000 # Opcjonalnie. Domyślnie 3000.

Na Macu i większości dystrybucji Linuksa uruchom te polecenia w terminalu:


export ROBLOX_CLIENT_ID=your_client_id_here
export ROBLOX_CLIENT_SECRET=your_client_secret_here
export ROBLOX_PORT=3000 # Opcjonalnie. Domyślnie 3000.

Jeśli określiłeś port inny niż domyślny w adresie URL przekierowań podczas rejestracji aplikacji, upewnij się, że dodasz zmienną ROBLOX_PORT.

Te polecenia ustawić zmienne środowiskowe tylko na czas sesji terminalowej. Jeśli chcesz, aby te zmienne były ładowane za każdym razem, gdy otwierasz nowe okno terminala, dodaj te polecenia do swojego pliku konfiguracyjnego powłoki, takiego jak .zshrc lub .bashrc. Wiele usług hostingowych ma funkcje, które pomagają również w dodawaniu zmiennych środowiskowych do swoich serwerów.

Zainstaluj zależności

Aplikacja ma kilka zależności, widocznych w package.json. Aby je zainstalować, uruchom:


npm ci

Uruchom aplikację

Aby uruchomić aplikację, uruchom:


npm start

Następnie przejdź do http://localhost:3000 (lub swojego innego portu) w przeglądarce internetowej.

Aplikacja natychmiast przekierowuje cię na ekran logowania Roblox, gdzie możesz się zalogować, zweryfikować uprawnienia, które aplikacja żąda, a następnie kliknąć Potwierdź i przyznaj dostęp.

Roblox następnie przekierowuje cię z powrotem do localhost, gdzie możesz zobaczyć, że aplikacja teraz wyświetla minimalne informacje o użytkowniku, łącze powrotne do Twojego profilu na Roblox oraz pola, które możesz użyć do nadawania wiadomości w swoich grach.

O aplikacji

W szerszym ujęciu index.js wykonuje następujące operacje:

Uruchamia nowy serwer webowy za pomocą express.
Pobiera konfigurację Roblox OpenID Connect (OIDC), która zawiera punkty końcowe dla autoryzacji, informacji o użytkowniku itd. Aby uzyskać więcej informacji na temat tych punktów końcowych, zobacz autoryzację OAuth 2.0.
Tworzy nowego klienta Open ID za pomocą openid-client i twoich zapisanych poświadczeń. Ten klient znacznie upraszcza proces odpowiedniego formułowania i wysyłania żądań HTTP do punktów końcowych OAuth 2.0.
Definiuje trasy dla aplikacji, w tym przekierowania dla logowania i wylogowywania oraz zwrotu OAuth 2.0.
Po pomyślnym zalogowaniu przechowuje różne tokeny jako ciasteczka, wraz z minimalnymi informacjami o użytkowniku, które są wyświetlane jako HTML z pomocą getHomeHtml.js.

Polski