Cree su Aplicación, Usuarios y Tokens

Para utilizar el Client SDK, hay tres cosas que debe configurar antes de empezar:

  • Aplicación de Vonage - una Aplicación que contiene la configuración para la aplicación que está construyendo.
  • Usuarios - Usuarios asociados con la aplicación de Vonage. Se espera que Los usuarios tengan un mapeo uno a uno con su propio sistema de autenticación.
  • Tokens Web JSON, JWTs - Client SDK utiliza JWTs para la autenticación. Para que un usuario pueda iniciar sesión y usar la funcionalidad del SDK, debes proporcionar un JWT por usuario. Los JWT contienen toda la información que la plataforma de Vonage necesita para autenticar las solicitudes, así como información como las Applications, Users y permisos asociados.

Todos ellos pueden ser creado por su backend. Si desea empezar y experimentar con el SDK, también puede desplegar una aplicación backend para utilizarla con el Client SDK con la aplicación Client SDK Ejemplo de plantilla de servidor. De lo contrario, este tutorial le mostrará cómo hacerlo, utilizando la función CLI de Vonage.

Requisitos previos

Asegúrate de tener lo siguiente:

Crear una aplicación de Vonage

Ahora debes crear una aplicación de Vonage. En este ejemplo, crearás una aplicación capaz de manejar el caso de uso de In-App Voice.

  1. En primer lugar, cree el directorio de su proyecto si aún no lo ha hecho.
  2. Cambia al directorio del proyecto que has creado.
  3. Utiliza los siguientes comandos para crear y configurar una aplicación de Vonage con funciones de voz y WebRTC. Reemplaza las URL de webhook por las tuyas. Si tu plataforma restringe el tráfico entrante que puede recibir mediante rangos de direcciones IP deberás agregar el comando Direcciones IP de Vonage a su lista de permitidos. Las direcciones IP pueden obtenerse mediante programación enviando una petición GET a https://api.nexmo.com/ips-v4.
vonage apps create 'Your application'

✅ Creating Application
Saving private key ... Done!
Application created

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
  None Enabled

Añade funciones de voz:

vonage apps capabilities update 00000000-0000-0000-0000-000000000000 voice `
  --voice-answer-url='https://example.com/webhooks/voice/answer' `
  --voice-event-url='https://example.com/webhooks/voice/event' `
  --voice-fallback-url='https://example.com/webhooks/voice/fallback'
  
✅ Fetching Application
✅ Adding voice capability to application 00000000-0000-0000-0000-000000000000

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
 VOICE:
    Uses Signed callbacks: On
    Conversation TTL: 41 hours
    Leg Persistence Time: 6 days
    Event URL: [POST] https://example.com/webhooks/voice/event
    Answer URL: [POST] https://example.com/webhooks/voice/answer
    Fallback URL: [POST] https://example.com/webhooks/voice/fallback

Añadir funciones RTC

vonage apps capabilities update 00000000-0000-0000-0000-000000000000 messages `
  --messages-inbound-url='https://example.com/messages/inboud' `
  --messages-status-url='https://example.com/messages/status' `
  --messages-version='v1' `
  --no-messages-authenticate-media
  
✅ Fetching Application
✅ Adding messages capability to application 00000000-0000-0000-0000-000000000000

Name: Your application
Application ID: 00000000-0000-0000-0000-000000000000
Improve AI: Off
Private/Public Key: Set

Capabilities:
  MESSAGES:
    Authenticate Inbound Media: Off
    Webhook Version: v1
    Status URL: [POST] https://example.com/messages/status
    Inbound URL: [POST] https://example.com/messages/inboud

A continuación se crea la aplicación. Un archivo de clave privada private.key también se crea.

La creación de una aplicación y las capacidades de la aplicación se tratan en detalle en la sección guía de aplicación.

Crear un usuario

Crea un usuario que iniciará sesión en Vonage Client y participará en la funcionalidad del SDK: Conversaciones, llamadas, etc.

Ejecute el siguiente comando en su terminal para crear un usuario llamado Alice:

vonage users create `
  --name='Alice'
  
✅ Creating User

User ID: USR-00000000-0000-0000-0000-000000000000
Name: Alice
Display Name: Not Set
Image URL: Not Set
Time to Live: Not Set

Channels:
  None Set

El ID de usuario se utiliza para realizar tareas del SDK, como iniciar sesión, iniciar una llamada, etc.

Generar un JWT de usuario

JWTs se utilizan para autenticar a un usuario en el Client SDK.

Para generar un JWT para Alice ejecute el siguiente comando (sustituyendo con su información):

# A command with parameters
vonage jwt create `
--app-id='00000000-0000-0000-0000-000000000000' `
--private-key=./private.key `
--sub='Alice' `
--acl='{\"paths\":{\"\/*\/users\/**\":{},\"\/*\/conversations\/**\":{},\"\/*\/sessions\/**\":{},\"\/*\/devices\/**\":{},\"\/*\/push\/**\":{},\"\/*\/knocking\/**\":{},\"\/*\/legs\/**\":{}}}'

# Will produce a token
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2wiOnsicGF0aHMiOnsiLyovcnRjLyoqIjp7fSwiLyovdXNlcnMvKioiOnt9LCIvKi9jb252ZXJzYXRpb25zLyoqIjp7fSwiLyovc2Vzc2lvbnMvKioiOnt9LCIvKi9kZXZpY2VzLyoqIjp7fSwiLyovcHVzaC8qKiI6e30sIi8qL2tub2NraW5nLyoqIjp7fSwiLyovbGVncy8qKiI6e319fSwiZXhwIjoxNzQxMTgyMzA3LCJzdWIiOiJBbGljZSIsImp0aSI6Ijg1MTViNzk2LTA1YjktNGFkMS04MTRkLTE1NWZjZTQzZWM1YiIsImlhdCI6MTc0MTE4MTQwNywiYXBwbGljYXRpb25faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAifQ.BscMdDXZ1-nuLtKyPJvw9tE8E8ZjJvTPJPMT9y0TjPz4Q7qqNaqxcjglc5QPtYEjh2YpZH6btSKbUF4XTClI026Hl5_QOBlnayYo7jXwhba16fa5PeyzSf30QFGFrHbANwrQJFVCjd329SZUpwK4GxgB1gf230NhbfmkhegKezqicru2WTGCKm8kQncYliFwIEYUlcRAb2c8xcaVrn_6QNNahyeJRwGFfWpIkX0Oe-S4RDlPjoq47_gYWac9MmaetB4Dd3Yp531AuniGV5JiIShkaEwuY4Zyov4Hcmajm4Lm_UFY119la7vzHis0P7cT9pPUDe5cyPj7eT8-VhitfQ

El comando anterior establece por defecto la caducidad del JWT en 24 horas. Puede cambiar la caducidad a un período de tiempo más corto utilizando el comando tiempo usando el comando --exp bandera.

NOTA: En aplicaciones de producción, se espera que su backend exponga un endpoint que genere JWT por su solicitud del cliente.

Para más información