Création d'un jeton de connexion — Node.js

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 Node.js suivant montre comment générer un jeton à l'aide de la bibliothèque côté serveur OpenTok pour Node.js :

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

//Generate a basic session. Or you could use an existing session ID.
var sessionId;
opentok.createSession({}, function(error, session) {
  if (error) {
    console.log("Error creating session:", error)
  } else {
    sessionId = session.sessionId;
    console.log("Session ID: " + sessionId);
  }
});

var 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 Node.js suivant montre comment obtenir un jeton doté du rôle « publisher » 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:
var opentok = new OpenTok(API_KEY, API_SECRET);

//Generate a basic session. Or you could use an existing session ID.
var sessionId;
var token
opentok.createSession({}, function(error, session) {
  if (error) {
    console.log("Error creating session:", error)
  } else {
    sessionId = session.sessionId;
    console.log("Session ID: " + sessionId);
    //  Use the role value appropriate for the user:
    var tokenOptions = {};
    tokenOptions.role = "publisher";
    tokenOptions.data = "username=bob";

    // Generate a token.
    token = opentok.generateToken(sessionId, tokenOptions);
    console.log(token);
  }
});

}

La méthode prend les arguments suivants :

  • sessionId (Chaîne) — L'identifiant de session correspondant à la session à laquelle l'utilisateur va se connecter.
  • options (Objet) — Objet contenant des paramètres facultatifs pour le jeton :
    • 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 « éditeur ».
    • data (Chaîne) — Facultatif. Une chaîne 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 de données fournies par le client, selon votre application.
    • expireTime (Nombre) — Facultatif. Heure d'expiration du jeton, définie sous la forme d'un nombre entier correspondant à un horodatage Unix (en secondes). Si vous ne précisez pas cette valeur, les jetons expirent 24 heures après leur création. Le expire_time La valeur, si elle est indiquée, doit se situer dans un délai de 30 jours à compter de la date de création.