動画:未収録(文章で進められます)
このレッスンでできること
自分のXRiftアカウントで公開する準備を整えます。デスクトップ版のログインと、ブラウザ版βのAPIキーを使う方法を分けて進めます。
始める前に
公開前のバックアップと作品情報を準備してください。認証とAPIキーの発行・入力は、アカウント本人が操作します。パスワードやAPIキーを、教材への書き込み、AIとのチャット、問い合わせ、画面録画に含めないでください。
手順
1. XRiftで使うアカウントを確かめる
- XRiftを開きます。
- 未ログインなら、自分が使う方法でログインします。初めての場合は、公式画面の登録案内と利用条件を読んで進めてください。
- 表示名を確認し、今回の作品を所有するアカウントであることを確かめます。
ブラウザでXRiftにログインしただけでは、デスクトップ版の認証や、ブラウザ版βへのAPIキー入力まで済んだことにはなりません。使用する環境の手順を続けてください。
2-A. デスクトップ版から公開する
- XRift Studioで、公開するプロジェクトを開きます。
- 「XRiftへ公開」を押し、「XRiftアカウント」の項目を確認します。
- 未ログインの場合は「ログイン」を押します。公開用のセットアップが案内された場合は、先にその準備を終えます。
- 開いたブラウザで、本人がXRiftの認証を完了します。別アカウントになっていたら、そのまま公開せず、正しいアカウントを使ってください。
- Studioに戻り、「ログインしました」の通知や、公開画面のアカウント表示を確認します。
アプリが公式ツールの認証を使うため、通常の公開手順で認証ファイルを自分で編集する必要はありません。
2-B. ブラウザ版βから公開する
ブラウザ版βが送信に使うAPIキーは、ワールドやアイテムを書き込む権限を持つ秘密情報です。自分が管理する端末で扱ってください。
- XRiftの設定を本人が開きます。
- 「APIキー」の「新規作成」から、用途が分かる「キー名」を入力します。例は「Studioのワールド公開用」です。
- 「スコープ」で、ワールドは
write:worlds、アイテムはwrite:itemsを選びます。このレッスンに不要な権限は追加しないでください。必要なら「有効期限(任意)」も設定します。 - 権限と期限を確認し、本人が「作成」を押します。キー本体は、他人に見えない場所で扱います。
- Studioの公開画面に戻り、「XRift APIキー」欄へ本人が入力します。ここではまだアップロードのボタンを押しません。
公式のPublic API v1資料には、確認時点で読み取りスコープのみが掲載されています。Studioの公開機能はワールドにwrite:worlds、アイテムにwrite:itemsを要求します。実際の設定画面で必要な権限を選べない場合は、無関係な権限を試さず、プロジェクトを書き出してデスクトップ版のログイン方式を使ってください。
キーの保存は自分で選ぶ
StudioはAPIキーをプロジェクトやWeb Storageに保存しません。公開画面を閉じると、その画面に入力したキーは消えます。
対応ブラウザでは、送信後に「APIキーをブラウザに保存」を選べます。保存確認とキーの選択を本人が終え、保存できた表示を確認してください。次回は自動入力か「保存済みキーを選ぶ」を使います。端末間の同期はブラウザの設定に従うため、共有端末では保存しないでください。
できたか確認する
- 作品を所有するアカウントを確認した
- デスクトップ版なら、Studio側もログイン済みになった
- ブラウザ版なら、必要な権限を確認し、公開画面へ本人がキーを入力した
- パスワードやキーを、作品・チャット・録画に残していない
うまくいかないとき
- ブラウザで認証したのにStudioが未ログイン:Studioで開始した認証を完了したか確認します。「ログインを完了してください」が出た場合は、開いた公式画面の案内を確かめてください
401が出る:キーの期限切れ・無効化・入力内容を本人が確認します。キーを問い合わせ本文へ貼り付けないでください403が出る:必要なスコープと、更新先の所有アカウントを確認します。権限を無条件に増やさないでください- キーを見られた可能性がある:そのキーを使い続けず、XRiftの設定で本人が管理します。ブラウザ保存済みの場合は、そちらの保存内容も見直します
次のレッスン
次はワールドを一度だけ送信するへ進みます。