ステップ 3: チャットトークンを作成する

チャット参加者がルームに接続してメッセージの送受信を開始するには、チャットトークンを作成する必要があります。チャットトークンは、チャットクライアントの認証と認可に使用されます。

この図は、IVS Chat トークンを作成するためのワークフローを示しています。

上記のように、クライアントアプリケーションはサーバー側のアプリケーションにトークンを要求し、サーバー側のアプリケーションは AWS SDK または SigV4 署名付きリクエストを使用して CreateChatToken を呼び出します。AWS 認証情報が API の呼び出しに使用されるため、トークンはクライアント側のアプリケーションではなく、安全なサーバー側のアプリケーションで生成する必要があります。

トークン生成のデモンストレーションを行うバックエンドサーバーアプリケーションは、Amazon IVS Chat デモバックエンドで入手可能です。

セッション期間とは、確立されたセッションが自動的に終了されるまでのアクティブな状態を維持できる期間を指します。つまり、セッション期間は、新しいトークンを生成して新しい接続を確立する必要が生じる前に、クライアントがチャットルームに接続したままにできる期間です。オプションでは、トークンの作成中に、セッション期間を指定できます。

エンドユーザーの接続を確立するために、各トークンは一度だけ使用できます。接続が終了した場合、接続を再確立する前に、新しいトークンを作成する必要があります。トークン自体は、応答に含まれるトークンの有効期限のタイムスタンプまで有効です。

エンドユーザーがチャットルームに接続する場合、クライアントはサーバーアプリケーションにトークンを要求する必要があります。サーバーアプリケーションはトークンを作成し、それをクライアントに返します。トークンはオンデマンドでエンドユーザー向けに作成する必要があります。

チャット認証トークンを作成するには、以下の手順に従います。チャットトークンを作成する際は、リクエストフィールドを使用してチャットエンドユーザーとエンドユーザーのメッセージング機能に関するデータを渡します。詳細については、「IVS チャット API リファレンス」の「CreateChatToken」を参照してください。

AWS SDK での手順

AWS SDK を使用してチャットトークンを作成するには、最初にアプリケーションに SDK をダウンロードして設定する必要があります。以下は、JavaScript による AWS SDK の手順です。

重要: このコードは、サーバー側で実行し、その出力をクライアントに渡す必要があります。

前提条件: 以下のコードサンプルを使用するには、AWS JavaScript SDK をアプリケーションにロードする必要があります。詳細については、Getting started with the AWS SDK for JavaScript を参照してください。

async function createChatToken(params) {
  const ivs = new AWS.Ivschat();
  const result = await ivs.createChatToken(params).promise();
  console.log("New token created", result.token);
}
/*
Create a token with provided inputs. Values for user ID and display name are 
from your application and refer to the user connected to this chat session.
*/
const params = {
  "attributes": {
    "displayName": "DemoUser",
  }",
  "capabilities": ["SEND_MESSAGE"],
  "roomIdentifier": "arn:aws:ivschat:us-west-2:123456789012:room/g1H2I3j4k5L6",
  "userId": 11231234
};
createChatToken(params);

CLI の手順

AWS CLI を使用してチャットトークンを作成することは詳細オプションであり、最初に CLI をダウンロードしてマシンに設定する必要があります。詳細については、「AWS Command Line Interface のユーザーガイド」を参照してください。注: AWS CLI を使用したトークンの生成はテスト目的の場合は問題ありませんが、本番環境で使用する場合は、AWS SDK を使用してサーバー側でトークンを生成することをお勧めします (上記の手順を参照)。