OAuth 2.0 앱을 등록하면 Roblox 리소스에 접근할 수 있습니다. 등록 후, Roblox는 앱에 고유한 클라이언트 ID와 비밀을 할당하며, 이를 사용하여 사용자로부터 Roblox 정보 및 리소스에 접근할 수 있는 권한을 얻을 수 있습니다.
앱 등록하기
앱을 등록하려면:
- Creator Dashboard에서 OAuth 2.0 Apps 페이지로 이동합니다.
- Create App 버튼을 클릭합니다.
- 유효하고 전 세계적으로 고유한 Application Name을 입력합니다.
- Roblox Terms of Service를 읽고 동의한 후 Create를 클릭합니다.
- Client ID와 Secret를 안전한 장소에 복사하여 저장합니다. 페이지를 닫은 후에는 비밀에 접근할 수 없으며, 새 비밀을 생성할 수만 있습니다. 앱 등록을 마친 후에도 앱의 다른 속성에 접근하고 수정할 수 있습니다.
- Continue to Edit를 클릭하여 앱을 구성합니다. 이는 다음 섹션에서 설명합니다.
일반 정보 구성하기
앱을 등록한 후에는 일반 정보를 구성해야 합니다. 여기에는 다음이 포함됩니다:
- Roblox 커뮤니티의 모든 사용자에게 보이는 설명.
- 앱의 썸네일 이미지. 권장 파일 크기는 최소 150x150 픽셀입니다.
- 앱의 진입점으로서의 Entry Link, 예를 들어 앱의 웹사이트 홈페이지.
- 최종 사용자가 앱을 승인하기 전에 읽을 수 있는 Privacy Terms URL 및 Terms of Service URL. 각 URL은 HTTPS여야 하며 256자를 초과할 수 없습니다.
권한 추가하기
앱 내에서 적절한 접근 제어 및 보안을 보장하기 위해 Permission Scopes를 추가해야 합니다. 사용할 수 있는 권한 범위는 두 가지 유형이 있습니다:
- 인증을 위한 Identity scopes, 예를 들어 사용자 ID를 위한 openid 및 전체 프로필을 위한 profile. profile 범위를 선택하면 openid도 선택해야 합니다.
- 자산의 읽기 권한을 위한 API-specific permission scopes, 예를 들어 asset:read. 앱에 필요한 최소한의 범위만 선택하십시오.
리디렉션 URL 추가하기
Redirect URLs는 사용자가 앱을 승인한 후 리디렉션되는 앱의 재진입 지점입니다. 리디렉션 URL이 다음 요구 사항을 충족하는지 확인하십시오:
- 모든 리디렉션 URL은 다음 형식 중 하나여야 합니다:
- 일반 HTTPS, 예: https://www.example.com.`
- 로컬 디버깅 목적으로 HTTP 또는 HTTPS(자체 서명된 인증서)에서 로컬호스트의 경로, 예:
- http://localhost:80
- https://localhost:80
- 특정 애플리케이션이나 목적을 위한 사용자 정의 스킴, 예:
- my-app-scheme:/
- my-app-scheme://foo/bar/...
- my-app://action?param1=value1¶m2=value2
- 리디렉션 URL의 최대 길이는 256자입니다.
- 최대 10개의 리디렉션 URL을 추가할 수 있습니다. 여러 리디렉션 URL을 사용하면 테스트 환경을 가질 수 있으며, 사용자가 두 사이트 간에 중단 없이 이동할 수 있습니다.
검토 제출하기
악의적인 앱이 커뮤니티에 해를 끼칠 가능성을 최소화하기 위해, 앱 등록은 광범위하게 접근 가능하게 만들지 않습니다. 대신, 앱은 private mode에 남아 있으며 10명의 고유 사용자로 제한됩니다. 이 모드는 팀 내에서 테스트 및 디버깅에 유용합니다.
앱의 사용자 기반을 확장하려면 검토를 제출하여 공개 모드로 게시해야 합니다:
- OAuth 2.0 apps 페이지로 이동합니다.
- 게시하려는 앱의 Edit and Publish 버튼을 클릭합니다.
- 데모 비디오 및 설명을 포함한 모든 필수 정보를 입력한 후 Review and Publish 버튼을 클릭합니다. 대기 중인 검토 기간 동안 앱 권한에 대한 제한이 표시됩니다.
- Submit for Review를 클릭합니다.
제출을 위해 필요한 정보는 다음과 같습니다:
- 1분을 초과하지 않는 공개 Demo Video 링크로, 다음 요구 사항을 충족해야 합니다:
- 사용자가 로그아웃된 상태로 시작하고 Sign In with Roblox 클릭과 같은 정확한 사용자 행동을 보여주어 OAuth 동의 대화 상자를 트리거합니다. 비디오는 리디렉션을 통해 앱으로 돌아오는 전체 인증 흐름을 보여주어야 하며, 리디렉션 후 원래 앱의 콘텐츠를 포함해야 합니다.
- 제출 시 제공하는 동일한 등록 세부정보를 보여줍니다.
- 앱이 선택한 카테고리에 속하는 이유와 요청한 권한 범위를 사용하는 방법을 설명하는 정당화.
앱 검토가 대기 중일 때는 현재 검토 요청이 승인되거나 거부될 때까지 다른 요청을 편집하거나 제출할 수 없습니다. 검토 중에는 앱이 private mode에 남아 있습니다. 앱이 승인되면 공개 모드로 전환되며, 다시 private mode로 되돌릴 수 없습니다.
앱이 승인되거나 거부되었는지 여부에 관계없이 검토가 완료되면 결과에 대한 이메일 알림을 받게 됩니다.
앱 편집 및 삭제하기
검토 중이 아닐 경우 다음 단계를 통해 앱을 편집하거나 삭제할 수 있습니다:
OAuth 2.0 apps 페이지로 이동합니다.
원하는 앱에 대해 Edit 또는 Delete를 클릭합니다.
- 앱을 편집하기로 선택한 경우, 등록과 동일한 단계와 요구 사항을 따릅니다.
- 앱을 삭제하기로 선택한 경우, 삭제를 확인하기 위해 Yes, Delete를 클릭합니다. 앱을 삭제한 후에는 복구할 수 없습니다.
앱의 일반 정보나 리디렉션 URL을 수정해도 사용자가 앱을 다시 승인할 필요는 없습니다. 그러나 권한 범위를 추가하거나 수정하는 경우, 새로운 권한에 대한 승인을 사용자로부터 받아야 하며 새로운 토큰 세트를 획득해야 합니다. 새로운 범위에 대한 승인을 받지 않으면 기존 토큰을 계속 사용할 수 있지만, 이전 범위로 제한됩니다.
private mode의 앱에 대해서는 시스템이 자동으로 사용자의 편집 내용을 업데이트합니다. public mode의 앱에 대해서는 이러한 변경 사항을 반영하기 위해 검토를 제출해야 합니다. 그렇지 않으면 시스템이 커뮤니티에 공개하지 않고 미게시된 변경 사항을 저장합니다.