Vue d'ensemble

Dans ce guide, vous apprendrez à ajouter le Client SDK à votre application JavaScript côté client.

Conditions préalables

Le Client SDK requiert Node.js et NPM.

Pour ajouter le Client SDK à votre projet

Ouvrez votre terminal. Si vous avez une application existante, naviguez jusqu'à sa racine. Sinon, créez un nouveau répertoire pour votre projet.

Ajouter le Client SDK à votre projet

Install the Client SDK package

Add a default package.json by running:

npm init -y

Install the Client SDK using npm:

npm install nexmo-client -s

Import the Client SDK into your code

If your application is using ES6 module syntax, you can import the client module near the top of your application code:

import NexmoClient from 'nexmo-client';

If your application will run on a single page, you can load the module in your HTML using a script tag:

<script src="./node_modules/nexmo-client/dist/nexmoClient.js"></script>

Be sure to check that the path to nexmoClient.js is correct for your project structure.

Utiliser le Client SDK dans votre application

Création d'utilisateurs et de JWT

Un jeton Web JSON (JWT) est nécessaire pour se connecter à votre application Vonage. Le Client SDK ne peut pas gérer les utilisateurs ni générer des JWT, vous devez donc choisir une méthode de traitement en arrière-plan :

  • À des fins d'intégration ou de test, vous pouvez faire fonctionner votre application côté client avant de mettre en place un backend en procédant comme suit générer un JWT de test à partir de la ligne de commande et de le coder en dur dans votre JavaScript côté client.

  • Pour une utilisation concrète, vous pouvez délivrer des JWTs depuis le serveur en utilisant Node ou PHP SDK d'arrière-planet définir le jwt dans votre code en récupérant ces données :

    fetch('/getJwt')
  .then(results => results.json())
  .then(data => {
    jwt = data.token;
  })
  .catch(err => console.log(err));

  • En savoir plus sur la génération de JWT dans cet article

Instanciation et connexion au NexmoClient

Aucun argument n'est nécessaire à l'instanciation d'un nouveau NexmoClientmais vous devrez passer votre JWT comme argument à la commande createSession().

let nexmo = new NexmoClient()
  .createSession(jwt)
  .then(app => console.log('Logged in to app', app))
  .catch(err => console.log(err));

Données d'analyse et d'utilisation du Client SDK

Pour fournir à Vonage plus d'informations afin de nous permettre de corriger les bogues et de développer des fonctionnalités, vous pouvez éventuellement accepter notre programme d'analyse et de données d'utilisation du Client SDK.

Pour activer les analyses et les rapports sur l'utilisation des données, veuillez définir l'option enabled paramètre de log_reporter à true. Le code suivant en est un exemple :

new NexmoClient({debug:true, log_reporter: {enabled: true}})

NOTE : Il s'agit d'une option facultative qui est désactivée par défaut.

Conclusion

Vous avez ajouté le Client SDK à votre application JavaScript côté client et vous vous êtes connecté à une application NexmoClient qui renvoie une instance Application objet. Vous pouvez maintenant utiliser Application.newConversation() pour créer une conversation, puis accéder à la fonctionnalité d'un Conversation.

Voir aussi