Trabajar con las API de Vonage

¡Bienvenido a la plataforma API de Vonage! Vonage ofrece un conjunto de API que te permiten comunicarte con tus clientes usando tus canales preferidos.

Este sitio ofrece documentación exhaustiva sobre todas nuestras API. Encontrará todo lo que necesita saber para trabajar con una API concreta en la sección correspondiente.

Sin embargo, hay algunos conceptos fundamentales que debe comprender y herramientas que pueden ayudarle y que se aplican a todas nuestras API:

Crear una Account

Para trabajar con nuestras API, necesitará crear una Account. Esto le proporcionará una clave API y un secreto que podrá utilizar para acceder a nuestras API.

Acceso al panel de control para desarrolladores

Una vez que disponga de una Account, puede acceder a la sección Panel de control para desarrolladores. El Developer Dashboard es una interfaz gráfica de usuario para gestionar su Account:

  • Ver su clave y secreto API. Los necesitará para autenticar sus solicitudes a nuestras API
  • Gestione el saldo de su Account. El acceso a nuestras API se cobra por solicitud. Le daremos algo de crédito gratis cuando abra su Account por primera vez y podrá aumentar cuando se te acabe.
  • Alquilar números virtuales. Puede utilizar Números virtuales proporcionado por Vonage para enviar y recibir llamadas y mensajes. Ver alquilar un número virtual.
  • Gestionar aplicaciones. Algunas de nuestras APIs (como Voice y Messages API) requieren que crees un Aplicacionesque actúa como contenedor de la información de seguridad y configuración. Puede crear y gestionar estas Applications en el Developer Dashboard.
  • Gestione su Account. Puede realizar otras tareas administrativas aquí.

Uso de la CLI de Vonage

Opcionalmente, puedes realizar muchas de las tareas del panel desde la línea de comandos, usando la CLI de Vonage. Esto suele ser más rápido y también te permite programar estas operaciones.

La CLI de Vonage está escrita con oclif y puede instalarse mediante el gestor de paquetes Node (npm). En README en el repositorio GitHub de Vonage CLI te muestra cómo instalar y trabajar con la CLI de Vonage.

Autenticación

Al utilizar las API de Vonage, tus solicitudes deben ser autentificado. Normalmente esto se hace utilizando Autenticación básica o JWTs. Puedes generar un JWT adecuado utilizando la CLI de Vonage, o nuestro herramienta en línea. Mientras que Autenticación básica funcionará, pero no le permitirá recibir webhooks - éstos sólo pueden activarse utilizando JWTs.

Si se utiliza la autenticación silenciosa con Verify, debe ser el primer canal de la matriz de flujos de trabajo.

Experimentar con nuestras API

En última instancia, vas a querer construir una aplicación en tu lenguaje de programación elegido. Pero para empezar, es posible que desee hacer algunas peticiones de muestra a nuestras API para comprobar que ha proporcionado los parámetros correctos y que está recibiendo las respuestas que desea.

Si está familiarizado con la herramienta de línea de comandos Rizarencontrará fragmentos de Curl para cada una de nuestras API que puede copiar, pegar y modificar.

Cartero

Existen varias herramientas GUI más fáciles de usar que Curl. Una de las más populares es Cartero. Lea nuestra guía sobre utilizar Postman para trabajar con nuestras API. Vonage también ofrece un conjunto de Colecciones de carterosque permite empezar a utilizar las API inmediatamente.

OpenAPI

Cada una de nuestras API tiene su propio Especificación OpenAPI. Puede obtener más información sobre OpenAPI en nuestro documentación. Nuestras especificaciones se ajustan a la versión 3 de la especificación OpenAPI, también conocida como OAS3.

Uso de un SDK de servidor

Cuando esté listo para empezar a crear su aplicación, querrá utilizar uno de nuestros SDK de servidor en lugar de codificar cada solicitud a mano. Puedes encontrar enlaces a todos nuestros SDKs en la página Herramientas página.

Trabajar con Webhooks

Una vez que haya aprendido a realizar solicitudes a nuestras API para realizar llamadas, enviar mensajes, etc., querrá aprender a recibir comunicaciones entrantes en su número virtual.

Cuando nuestras API quieren notificar algo a tu aplicación, ya sea una llamada entrante, un mensaje o una actualización de estado, necesitan que tu aplicación exponga un punto final URL al que nuestra plataforma pueda hacer una petición. Estas deben ser accesibles a través de la Internet pública.

Estos puntos finales se denominan Webhooks. Más información sobre webhooks. Una vez que haya creado su gancho web, debe indicar a nuestra plataforma API que lo utilice. El proceso para hacerlo depende de la API que esté utilizando y las instrucciones completas se pueden encontrar en la documentación de esa API.

Hacer que estos webhooks sean públicamente accesibles durante el desarrollo puede ser complicado, por lo que recomendamos una herramienta llamada Ngrok.

Visite nuestra guía sobre pruebas con Ngrok para aprender a utilizarlo.

Formato de los Numbers

Dentro de las API de Vonage, todos los números de teléfono están en Formato E.164. Esto significa que Numbers:

  • Omitir tanto la inicial + y el código de acceso internacional como 00 o 001.
  • No contener caracteres especiales, como espacios, () o -

Por ejemplo, un número estadounidense tendría el formato 14155550101. Un número del Reino Unido tendría el formato 447700900123.

Si no está seguro de cómo formatear el número, el botón Number Insight API puede utilizarse para encontrar información correcta sobre un número.

Ver también Formato de los Numbers en la documentación de la Voice API.

Concepts

Hay una serie de conceptos compartidos entre las API de Vonage: el uso de tokens web JSON (JWT), solicitudes firmadas y webhooks. Las guías a continuación explican en detalle cómo usar estos elementos.

  • Applications - Información de seguridad y configuración que necesitas para conectarte a los terminales de Vonage.
  • Autenticación - Claves API y JSON Web Tokens (JWTs).
  • Firma de mensajes - cómo firmar criptográficamente mensajes y verificar firmas de mensajes.
  • Webhooks - La API de Vonage puede enviar datos a tu servidor web a través de un webhook.
  • OpenAPI - Todas las API de Vonage tienen descripciones OpenAPI que puedes aprovechar en tu propio proceso de desarrollo.
  • Glosario - Un glosario de términos comunes utilizados en toda la plataforma de Vonage.

¿Qué hacer a continuación?

Esta guía le presenta algunos de los conceptos y herramientas fundamentales que debe conocer cuando trabaje con nuestras API.

Una vez que comprenda estos conceptos fundamentales y haya instalado las herramientas que va a utilizar, estará listo para empezar a construir. Ver la documentación de la API elegida para empezar.

Si encuentra alguna dificultad, consulte nuestro Comunidad Slacko eche un vistazo a nuestra base de conocimientos y pida ayuda si es necesario en nuestro sitio de asistencia.