Rejestracja aplikacji OAuth 2.0 pozwala jej na dostęp do zasobów Roblox. Po rejestracji Roblox przypisuje aplikacji unikalny identyfikator klienta i sekret, które możesz użyć do uzyskania autoryzacji od użytkowników na dostęp do ich informacji i zasobów Roblox.
Zarejestruj swoją aplikację
Aby zarejestrować aplikację:
- W Panelu Twórcy przejdź do strony Aplikacje OAuth 2.0.
- Kliknij przycisk Utwórz aplikację.
- Wprowadź ważną i globalnie unikalną Nazwę aplikacji.
- Przeczytaj i zgódź się na Warunki korzystania z usług Roblox, a następnie kliknij Utwórz.
- Skopiuj i przechowuj Identyfikator klienta i Sekret w bezpiecznym miejscu. Po zamknięciu strony nie będziesz miał dostępu do sekretu i możesz tylko wygenerować nowy. Po zakończeniu rejestracji aplikacji nadal możesz uzyskać dostęp do innych właściwości aplikacji i je edytować.
- Kliknij Kontynuuj edytowanie, aby skonfigurować swoją aplikację, co jest opisane w kolejnych sekcjach.
Skonfiguruj ogólne informacje
Gdy już zarejestrujesz swoją aplikację, powinieneś skonfigurować jej ogólne informacje, w tym:
- Opis, który jest widoczny dla wszystkich w społeczności Roblox.
- Miniaturę obrazu dla swojej aplikacji. Zalecany rozmiar pliku to co najmniej 150x150 pikseli.
- Link wejściowy jako punkt wejścia do twojej aplikacji, na przykład strona główna witryny aplikacji.
- URL warunków prywatności oraz URL warunków korzystania z usług, które użytkownicy końcowi powinni przeczytać przed autoryzacją twojej aplikacji. Każdy URL musi być HTTPS i nie może mieć więcej niż 256 znaków.
Dodaj uprawnienia
Aby zapewnić odpowiednią kontrolę dostępu i bezpieczeństwo w swojej aplikacji, musisz dodać Zakresy uprawnień. Dostępne są dwa rodzaje zakresów uprawnień:
- Zakresy tożsamości do autoryzacji, takie jak openid dla identyfikatorów użytkowników i profile dla pełnych profili. Jeśli wybierzesz zakres profile, musisz również wybrać openid.
- Zakresy uprawnień specyficzne dla API, takie jak asset:read dla uprawnienia do odczytu zasobów. Wybierz tylko minimalną liczbę zakresów, które potrzebujesz dla swojej aplikacji.
Dodaj adresy URL przekierowania
Adresy URL przekierowania to punkty ponownego wejścia do twojej aplikacji, do których użytkownicy są przekierowywani po zakończeniu autoryzacji twojej aplikacji. Upewnij się, że twoje adresy URL przekierowania spełniają następujące wymagania:
- Wszystkie adresy URL przekierowania muszą być w jednej z następujących form:
- Zwykły HTTPS, na przykład: https://www.example.com.`
- Ścieżki na localhost z HTTP lub HTTPS (certyfikat samopodpisany) do lokalnych celów debugowania, na przykład:
- http://localhost:80
- https://localhost:80
- Niestandardowe schematy dla konkretnych aplikacji lub celów, na przykład:
- my-app-scheme:/
- my-app-scheme://foo/bar/...
- my-app://action?param1=value1¶m2=value2
- Maksymalna długość adresu URL przekierowania wynosi 256 znaków.
- Możesz dodać do 10 adresów URL przekierowania. Dzięki wielu adresom URL przekierowania możesz mieć środowiska testowe i pozwolić użytkownikom na migrację między dwoma witrynami bez przestojów.
Złóż wniosek o przegląd
Aby zminimalizować szanse na to, że złośliwe aplikacje zaszkodzą społeczności, rejestracja aplikacji nie czyni jej szeroko dostępną. Zamiast tego pozostaje w trybie prywatnym z limitem 10 unikalnych użytkowników. Ten tryb jest pomocny do testowania i debugowania w zespole.
Jeśli chcesz rozszerzyć bazę użytkowników swojej aplikacji, musisz opublikować ją w trybie publicznym, składając wniosek o przegląd:
- Przejdź do strony Aplikacje OAuth 2.0.
- Kliknij przycisk Edytuj i opublikuj dla aplikacji, którą chcesz opublikować.
- Wypełnij wszystkie wymagane informacje, w tym film demo i opis, a następnie kliknij przycisk Przegląd i publikacja. Pojawi się komunikat z ograniczeniami dotyczącymi uprawnień twojej aplikacji w okresie oczekiwania na przegląd.
- Kliknij Złóż wniosek o przegląd.
Następujące informacje są wymagane do twojego zgłoszenia:
- Publiczny link do Filmu demo, który nie przekracza 1 minuty i spełnia następujące wymagania:
- Zaczyna się od użytkownika, który jest wylogowany, i pokazuje dokładną akcję użytkownika, taką jak kliknięcie Zaloguj się z Roblox, która uruchamia okno zgody OAuth. Film musi pokazać cały proces autoryzacji poprzez przekierowanie z powrotem do twojej aplikacji, w tym treści w twojej oryginalnej aplikacji po przekierowaniu.
- Pokazuje te same szczegóły rejestracji, które podajesz w swoim zgłoszeniu.
- Uzasadnienie wyjaśniające, dlaczego twoja aplikacja należy do wybranej kategorii i jak wykorzystuje żądane zakresy uprawnień.
Podczas oczekiwania na przegląd twojej aplikacji nie możesz edytować ani składać kolejnego wniosku, aż aktualny wniosek o przegląd zostanie zatwierdzony lub odrzucony. Twoja aplikacja pozostaje w trybie prywatnym podczas przeglądu. Gdy twoja aplikacja zostanie zatwierdzona, przechodzi do trybu publicznego, a ty nie możesz cofnąć jej z powrotem do trybu prywatnego.
Bez względu na to, czy twoja aplikacja zostanie zatwierdzona, czy odrzucona, otrzymasz powiadomienie e-mail o wyniku, gdy przegląd zostanie zakończony.
Edytuj i usuń swoją aplikację
Możesz edytować lub usunąć swoją aplikację, wykonując następujące kroki, jeśli nie jest w przeglądzie:
Przejdź do strony Aplikacje OAuth 2.0.
Kliknij Edytuj lub Usuń dla żądanej aplikacji.
- Jeśli wybrałeś edytowanie aplikacji, postępuj zgodnie z tymi samymi krokami i wymaganiami rejestracji.
- Jeśli wybrałeś usunięcie aplikacji, kliknij Tak, usuń, aby potwierdzić usunięcie. Po usunięciu aplikacji nie możesz jej odzyskać.
Modyfikacja ogólnych informacji o aplikacji lub adresów URL przekierowania nie wymaga od użytkowników ponownej autoryzacji aplikacji. Jednak jeśli dodasz lub zmodyfikujesz zakresy uprawnień, musisz uzyskać autoryzację dla nowych uprawnień od swoich użytkowników i zdobyć nowy zestaw tokenów. Jeśli nie uzyskasz autoryzacji dla nowych zakresów, twoja aplikacja może nadal korzystać z istniejących tokenów, ale jest ograniczona do poprzednich zakresów.
Dla aplikacji w trybie prywatnym system automatycznie aktualizuje twoje edycje u twoich użytkowników. Dla aplikacji w trybie publicznym musisz ponownie złożyć aplikację do przeglądu, aby odzwierciedlić te zmiany. W przeciwnym razie system zapisuje nieopublikowane zmiany dla ciebie, nie udostępniając ich społeczności.