API キーの管理

*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

Open Cloud で API へのアクセスを認証し、API キーを使用して特定のリソースへのアクセスを許可します。これにより、データストアや場所など、エクスペリエンスで特定のリソースにアクセスするためのグラナイアルな権限とセキュリティコントロールを追加できます。

すべてのオープンクラウド API は、有効なパーミッションを持つ API キーを作成し、リクエストに含める必要があります x-api-key ヘッダーを含めることで、アプリケーションがあなたの代わりに Open Cloud に認証できます。

API キーの作成

個人が所有するエクスペリエンスまたはグループが所有するエクスペリエンスの API を作成および構成できます (Roblox グループ グループ は、複数のクリエーターが同じエクスペリエンスで作業し、同じアセットを使用し、API キーを共有できます)。

グループの所有者であるか、グループ内の役割に割り当てられたロール内の 1つの API キーを作成するために API キーを作成する権限がある必要があります。グループメンバーは、 グループエクスペリエンスの作成と編集 権限を持つロール内のみで API キーを作成できます。たとえば、

API キーを作成するには：

  1. ナビゲート to the クリエイターダッシュボード。

  2. (オプション) グループの API キーを作成する場合は、 クリエイターハブ ドロップダウンをクリックしてグループを選択します。

  3. 左側のナビゲーションメニューで クラウドを開く → API キー を選択します。

  4. クリックする API キーを作成する ボタン。

  5. API キーにユニークな名前を入力します。後で目的を思い出すのに役立つ名前を使用してください。たとえば、PLACE_PUBLISHING_KEY は、場所をエクスペリエンスに公開するのに使用できます。

  6. In the アクセス許可 セクション, select an API from the Select API System メニュー and click the Add API System ボタン. Repeat this step if you need to add multiple APIs to the key.

  7. API キーでアクセスしたいエクスペリエンスを選択します。

  8. エクスペリエンスオペレーションズドロップダウンから、API キーに有効にしたいオペレーションを選択します。

    多くのオペレーションは、API リファレンス に含まれる必要なパーミッションスコープを含まれています。たとえば、メモリーストアをフラッシュ する操作は、universe.memory-store:flush 権限必要です。

  9. In the セキュリティ セクション, CIDR 記述 を使用して、IP アクセスをキーに明示的に設定することができます。そ

  10. (オプション) : リソースに追加の保護を追加するには、明示的な有効期限を設定して、キーがその日付以後に機能を停止します。

  11. クリックして 保存とキーを生成するボタン 。

  12. コードの公開されていない場所に API キーストリングをコピーして保存する

  13. Check your created API key on the クリエイターダッシュボード page of クリエイターダッシュボード .

グループ所有の API キー許可

グループのオーナーは、グループのメンバーが API のキーを持つ API のコントロールレベルを異ならせるためのグループの所有済みの API キーの許可を管理できます。グループのメンバーには、ロールと権限 内のグループのメンバーに基づいて API キーのコントロールレベルを自動的に取り消すこともあります。

許可の付与

グループの所有者として、 すべての API キーを管理する 権限をグループ内のロールに付与できます。この権限を持つメンバーは、グループの所有者が API キーに対するすべての権限を含む、グループの API キーを作成、表示、取り消す、取り消し、およびオーディオするすべての権限を持っています。

グループ内のロールに API キーの管理 権限を付与することもできます。これにより、メンバーは、他のメンバーのキーを管理することなく、自分の API キーを作成および表示できます。

権限無効

グループメンバーの権限をグループ API キーの管理に再び取り消すことができる複数の状況があります：

  • メンバーは権限可がない役割に割り当てられています。これはグループ所有権の転送中に発生する可能性があります。
  • メンバーの権限は、現在割り当てられているロールでは無効です。
  • メンバーはグループから退出するか、削除されます。
  • メンバーのアカウントは、Roblox によってモデレーションされています。

これらの場合のいずれかで、そのユーザーが生成した API キーは、 取り消し ステータス を持つようになります。これらのキーを再び使用するには、グループ所有者または すべての API キーを管理する 権限を持つメンバーが、キーを再生する必要があります。

CIDR 形式

さらに資源を保護するために、API キーを作成する ときに、IP アドレスを使用して API キーにアクセスできる IP アドレスを指定します。CIDR 記号 を使用すると、IP アドレスがネットワークルーティングのために重要なビット数を表示する CIDR IP アドレスが、通常の IP ア

  • ノーマル : 192.168.0.0
  • CIDR : 192.168.0.0/24

前の部分は IP アドレスであり、後の部分は ネットマスク で、1秒のビットをバイナリ形式でカウントします。以前の例では、 24 は

API キーステータス

API キーは最初にアクティブなステータ状況を持っていますが、寿命の経過とともに無効になることがあります。API キーがステータスを変更した理由と、API キーをアクティブなステータ状況に戻す方法については、次の表を参照してください。

ステータス理由解像度
アクティブ問題なし。ユーザーはキーを使用して API 呼び出しを認証できます。N/A
無効ユーザーは、キーを有効化 トグルを無効にすることでキーを無効にしました。Enable the Enable Key toggle.
有効期限切れキーの有効期限が切れました。新しい有効期限を削除するか、設定します。
自動有効期限切れユーザーは、過去の 60 日間にキーを使用したり更新したりしていません。また、キーの有効化 トグルを無効にして、キーのプロパティを更新できます。たとえば、詳細前、説明、または有効期限など。
取り消しグループキーのみに対応しています。キーを生成したアカウントは、グループのキーを管理するのに十分なアクセス許可を持っていなくなります。クリックして キーを再生する を押すと、新しい秘密を手に入れます。
モデレートされたRoblox 管理者は、セキュリティの理由でキーの秘密を変更しました。クリックして キーを再生する を押すと、新しい秘密を手に入れます。
ユーザーモデレートキーを生成したアカウントは、Roblox によるモデレーションの対象になります。アカウントのモデレーション問題を解決する。