Création d'un jeton de connexion — .NET

Pour authentifier un utilisateur se connectant à une session OpenTok, un client doit se connecter à l'aide d'un jeton (voir cet aperçu).

Le code .NET suivant montre comment générer un jeton à l'aide du SDK OpenTok pour .NET :

// 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);

Appeler le GenerateToken() La méthode renvoie une chaîne de caractères. Cette chaîne correspond au jeton.

Le code .NET suivant montre comment obtenir un jeton doté du rôle « éditeur » et d'une chaîne de métadonnées de connexion :

// 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);
=

La méthode prend les arguments suivants :

  • sessionId (chaîne de caractères) — L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter.
  • role (chaîne de caractères) — Facultatif. Ce paramètre définit le rôle que l'utilisateur aura. Il existe trois rôles : abonné, éditeur et modérateur. Les abonnés peuvent uniquement s'abonner aux flux de la session (ils ne peuvent pas publier). Les éditeurs peuvent s'abonner et publier des flux dans la session, et ils peuvent utiliser l'API de signalisation. Les modérateurs disposent des privilèges des éditeurs et, en outre, ils peuvent également forcer d'autres utilisateurs à se déconnecter de la session ou à cesser de publier. Le rôle par défaut (si aucune valeur n'est fournie) est celui d'éditeur.
  • expireTime (int) — Facultatif. Heure d'expiration du jeton, définie sous la forme d'un nombre entier correspondant à un horodatage Unix (en secondes). Si vous ne spécifiez pas cette valeur, les jetons expirent 24 heures après leur création. Le expireTime La valeur, si elle est indiquée, doit se situer dans un délai de 30 jours à compter de la date de création.
  • data (chaîne de caractères) — Facultatif. Une chaîne de caractères contenant des métadonnées décrivant la connexion. Vous pouvez, par exemple, transmettre l'identifiant de l'utilisateur, son nom ou d'autres données décrivant la connexion. Vous pouvez obtenir ces données à partir d'une base de données côté serveur ou à partir des données fournies par le client, selon votre application.