メインコンテンツまでスキップ

複数の API キーを管理する

Last updated on May 22, 2024

概要

過去には、ユーザーは各ゲームのすべての操作を実行する API キーを 1 つしか持つことができませんでした。当社は、ユーザーがゲーム内でさまざまな操作を設定できるように、ゲームに複数の API キーを作成して使用する機能を導入しました。各 API キーには、独自のスコープや権限の制限があります。

スコープは CRUD (作成、読み取り、更新、削除) 操作と一致します。許可された操作に設定されたリソースまたは REST エンドポイントを使用して、各 API キーをユーザーのニーズに合わせて調整できるようになりました。たとえば、1 つの API キーをゲームの配信において公開で使用してクラッシュを報告する一方で、別の API キーをデベロッパーが非公開で使用できます。

次の手順では、この機能の使用方法について説明します。

備考

管理者ユーザーのみが複数の API キー機能にアクセスできます。

手順

新しい API キーを追加する

以下で、新しい API キーの追加手順を説明します。

  1. Game Settings (ゲーム設定)]に移動し、[API Key Management (API キー管理)]メニューに移動します。

  2. Add New (新規を追加)]をクリックすると、ポップアップが表示されます。

  3. API Key Name (API キー名)]を入力し、新しいリソースを追加します。

  4. API キーを使用して特定の機能にアクセスするには、次のリソースのいずれかを選択します。 NAMESPACE:{namespace}:GAME:{gameId}:METADATA
    NAMESPACE:{namespace}:GAME:{gameId}:BUILD
    NAMESPACE:{namespace}:GAME:{gameId}:VERSION
    NAMESPACE:{namespace}:GAME:{gameId}:CHANNEL

    NAMESPACE:{namespace}:GAME:{gameId}:SESSION

    NAMESPACE:{namespace}:GAME:{gameId}:STREAM
    NAMESPACE:{namespace}:GAME:{gameId}:BUILD:SYMBOL

    NAMESPACE:{namespace}:GAME:{gameId}:CRASH

    NAMESPACE:{namespace}:GAME:{gameId}:PROFILING

    NAMESPACE:{namespace}:GAME:{gameId}:SYMBOL

    備考

    注意:使用できるリソースは 1 つのボックスにつき 1 つのみです。複数のリソースが必要な場合は、それぞれに新しいリソースを追加する必要があります。

  5. API キーを使用してすべての機能にアクセスするには、以下を使用します。 NAMESPACE:{namespace}:GAME:{gameId}:*

  6. 必要に応じてリソースをさらに追加し、各リソースの適切な CRUD 列のチェックボックスをクリックします。

  7. Add (追加)]ボタンをクリックします。新しい API キーが作成されます。

  8. ここが目にする唯一の機会であるため、API キーを安全な場所に保存してください。

新しい API キーを使用する

新しい API キーは、設定した機能と権限で使用する準備ができています。キーの機能例を示します。以下のリソースと権限で新しい API キーを作成したとします。

以下のように、ユーザーは API キーを使用して CLI の利用可能なバージョンを確認できますが、持っているのは読み取り権限のみです。

次の例は、ユーザーが新しい API キーを使用してバージョンを作成、更新、または削除しようとすると、エラーが発生することを示しています。

さらに API キーを追加する

さらに API キーを追加するには、新しい API キーを追加する手順を繰り返します。新しいキーに関連付けられているさまざまなリソースと権限を選択します。

API キーを削除する

API キーを削除するには、ゴミ箱アイコンをクリックします。

メッセージボックスの[Delete (削除)]をクリックして、API キーを削除することを確認します。

API キーが削除され、使用できなくなります。