OAuth 2.0 アプリを登録すると、Roblox リソースにアクセスできるようになります。登録後、Roblox はアプリに一意のクライアント ID とシークレットを割り当て、ユーザーからの承認を得て、彼らの Roblox 情報やリソースにアクセスするために使用できます。
アプリを登録する
アプリを登録するには:
- クリエイターダッシュボードに移動し、OAuth 2.0 アプリページにアクセスします。
- アプリを作成ボタンをクリックします。
- 有効でグローバルに一意のアプリケーション名を入力します。
- Roblox 利用規約を読み、同意して作成をクリックします。
- クライアント IDとシークレットを安全な場所にコピーして保存します。ページを閉じた後は、シークレットにアクセスできなくなり、新しいものを生成することしかできません。アプリの登録が完了した後でも、アプリの他のプロパティにアクセスして編集することができます。
- 編集を続けるをクリックしてアプリを構成します。これは次のセクションで説明します。
一般情報を構成する
アプリを登録したら、次の一般情報を構成する必要があります:
- Roblox コミュニティの全員に表示される説明。
- アプリのサムネイル画像。推奨ファイルサイズは少なくとも 150x150 ピクセルです。
- アプリのエントリポイントとしてのエントリリンク、例えばアプリのウェブサイトのホームページ。
- エンドユーザーがアプリを承認する前に読むためのプライバシー規約 URLと利用規約 URL。各 URL は HTTPS でなければならず、256 文字以内でなければなりません。
権限を追加する
アプリ内で適切なアクセス制御とセキュリティを確保するために、権限スコープを追加する必要があります。利用可能な権限スコープには 2 種類あります:
- 認証用のアイデンティティスコープ、例えばユーザー ID 用の openid や、フルプロファイル用の profile。profile スコープを選択した場合は、openid も選択する必要があります。
- 特定の API 用の権限スコープ、例えば資産の読み取り権限用の asset:read。アプリに必要な最小限のスコープのみを選択してください。
リダイレクト URL を追加する
リダイレクト URLは、ユーザーがアプリの承認を完了したときにリダイレクトされるアプリの再入ポイントです。リダイレクト 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 を使用することで、テスト環境を持ち、ユーザーがダウンタイムなしで 2 つのサイト間を移動できるようにします。
レビューのために提出する
悪意のあるアプリがコミュニティに害を及ぼす可能性を最小限に抑えるために、アプリを登録しても広くアクセス可能にはなりません。代わりに、プライベートモードのままで、10 人のユニークユーザーに制限されます。このモードは、チーム内でのテストやデバッグに役立ちます。
アプリのユーザーベースを拡大したい場合は、レビューのために提出して公開モードで公開する必要があります:
- OAuth 2.0 アプリページに移動します。
- 公開したいアプリの編集と公開ボタンをクリックします。
- デモ動画や説明を含むすべての必須情報を入力し、レビューと公開ボタンをクリックします。保留中のレビュー期間中のアプリの権限に関する制限が表示されるメッセージが表示されます。
- レビューのために提出をクリックします。
提出に必要な情報は次のとおりです:
- 1 分以内で、次の要件を満たす公開のデモ動画リンク:
- ユーザーがサインアウトした状態から始まり、OAuth 同意ダイアログをトリガーする正確なユーザーアクション(例:Roblox でサインインをクリック)を示します。動画は、リダイレクトを経てアプリに戻る全体の承認フローを示し、リダイレクト後の元のアプリのコンテンツを含む必要があります。
- 提出時に提供する登録詳細と同じ内容を示します。
- アプリが選択したカテゴリに属し、要求された権限スコープをどのように使用するかを説明する正当化。
アプリのレビューが保留中の間は、現在のレビューリクエストが承認または拒否されるまで、他のリクエストを編集または提出することはできません。アプリはレビュー中はプライベートモードのままです。アプリが承認されると、公開モードに移行し、プライベートモードに戻すことはできません。
アプリが承認されたか拒否されたかに関わらず、レビューが完了した際に結果のメール通知が届きます。
アプリを編集および削除する
レビュー中でない場合、次の手順でアプリを編集または削除できます:
OAuth 2.0 アプリページに移動します。
希望するアプリの編集または削除をクリックします。
- アプリを編集することを選択した場合は、登録の同じ手順と要件に従ってください。
- アプリを削除することを選択した場合は、削除を確認するためにはい、削除をクリックします。アプリを削除した後は、復元することはできません。
アプリの一般情報やリダイレクト URL を変更しても、ユーザーに再承認を求める必要はありません。ただし、権限スコープを追加または変更した場合は、新しい権限の承認をユーザーから取得し、新しいトークンセットを取得する必要があります。新しいスコープの承認を取得しない場合、アプリは既存のトークンを引き続き使用できますが、以前のスコープに制限されます。
プライベートモードのアプリでは、システムが自動的にユーザーとの編集を更新します。公開モードのアプリでは、これらの変更を反映させるために再度レビューのためにアプリを提出する必要があります。そうしないと、システムは未公開の変更を保存し、コミュニティに公開しません。