接続トークンの作成 — .NET

OpenTokセッションに接続するユーザーを認証するには、クライアントはトークンを使用して接続する必要があります（参照： この概要).

以下の .NET コードは、OpenTok .NET SDK を使用してトークンを生成する方法を示しています：

// Set the following constants with the API key and API secret
// that you receive when you sign up to use the OpenTok API:
OpenTok opentok = new OpenTok(API_KEY, API_SECRET);

//Generate a basic session. Or you could use an existing session ID.
string sessionId = opentok.CreateSession().Id

string token = opentok.GenerateToken(sessionId);

を呼び出す。 GenerateToken() このメソッドは文字列を返します。この文字列がトークンです。

以下の .NET コードは、「publisher」というロールを持ち、接続メタデータ文字列を持つトークンを取得する方法を示しています：

// Set the following constants with the API key and API secret
// that you receive when you sign up to use the OpenTok API:
OpenTok opentok = new OpenTok(API_KEY, API_SECRET);

//Generate a basic session. Or you could use an existing session ID.
string sessionId = opentok.CreateSession().Id

// Replace with meaningful metadata for the connection.
string connectionMetadata = "username=Bob,userLevel=4";

// Generate a token. Use the Role value appropriate for the user.
string token = opentok.GenerateToken(sessionId, Role.PUBLISHER, Null, connectionMetadata);
=

このメソッドは、以下の引数を受け取ります：

  • sessionId (文字列) — ユーザーが接続するセッションに対応するセッションID。
  • role (文字列) — オプション。これは、ユーザーが持つ役割を定義します。役割には、「サブスクライバー」、「パブリッシャー」、「モデレーター」の3つがあります。サブスクライバーは、セッション内のストリームを購読することしかできません（配信はできません）。 パブリッシャーは、セッションへのストリームの購読および配信が可能で、シグナリングAPIも使用できます。モデレーターはパブリッシャーと同様の権限を持ち、さらに他のユーザーに対してセッションからの切断や配信の中止を強制することもできます。デフォルトのロール（値が指定されていない場合）はパブリッシャーです。
  • expireTime (int) — 省略可能。トークンの有効期限。Unix タイムスタンプ（秒単位）の整数値として指定します。この値を指定しない場合、トークンは作成から 24 時間後に失効します。 expireTime 値が指定されている場合、その値は作成日時から30日以内である必要があります。
  • data (文字列) — 省略可能。接続に関するメタデータを記述した文字列です。たとえば、ユーザー ID や名前、あるいは接続に関するその他のデータを渡すことができます。このデータは、Applications に応じて、サーバー側のデータベースから取得するか、クライアントから提供されたデータから取得することができます。