Cartero

Nuestras API pueden utilizarse con cualquier cliente HTTP; sin embargo, recomendamos Cartero, una interfaz gráfica intuitiva para un potente cliente HTTP multiplataforma.

Vonage ha creado una colección de Postman, diseñada para brindarte un rápido comienzo con nuestras API más utilizadas. El espacio de trabajo está estructurado por capacidad, lo que te permite encontrar fácilmente la API que estás buscando. También contiene solicitudes completamente documentadas; en la pestaña "Descripción" de cada solicitud, encontrarás documentación que explica qué hace la llamada, cuándo la usarías, las variables requeridas (claves de API, secretos, JWT) y las respuestas esperadas.

Haz clic en el botón «Ejecutar en Postman» para crear una copia del espacio de trabajo en tu propio entorno de Postman y probar la colección:

También puede descargar e importar directamente nuestras especificaciones OpenAPI siguiendo las instrucciones que se indican a continuación.

Postman y OpenAPI

Postman es compatible con los documentos OpenAPI que publicamos junto con todas nuestras API.

Instala Postman y sigue los pasos que se indican a continuación para probar rápidamente cualquiera de las API de Vonage. Publicamos un documento OpenAPI para cada API, y Postman puede leerlos y crear una colección de solicitudes en las que puedes introducir valores.

Descargar e importar la especificación OpenAPI

La forma más sencilla de encontrar el documento OpenAPI es hacer clic en el botón «Descargar la especificación OpenAPI 3» que aparece en la referencia de la API que quieras probar. Por ejemplo, visita la Página de referencia de la API de Verify y haz clic en el botón de descarga. Puedes descargarlo en .yml o .json formato.

A continuación, puede seguir estas instrucciones para importar el archivo en Postman.

Realizar una llamada a la API

Una vez importada, podrá ver los diferentes puntos finales disponibles para la API. Por ejemplo, si ha importado la descripción de la API Verify, podrá elegir "Solicitar el envío de una verificación a un usuario" en el menú de la izquierda y obtener una solicitud lista para usar. Una vez que haya actualizado las cabeceras y el cuerpo con la información necesaria, puede pulsar "Enviar" y comprobar la respuesta de la API.

Uso avanzado de Postman

Entornos de uso

El cartero tiene un características de los entornos que le permite utilizar las mismas variables (como sus credenciales de API) en muchas solicitudes diferentes.

Para crear un entorno, haz clic en el engranaje de configuración de la parte superior derecha de la pantalla y elige "Añadir". Dale un nombre a tu entorno y añade las variables que quieras utilizar, por ejemplo:

• api_key
• api_secret
• phone_number

Una vez guardado, puedes, por ejemplo, introducir {{api_key}} en tus peticiones en lugar de pegar tu clave API. Postman utilizará el valor del entorno actual.

Puedes tener varios entornos, lo cual resulta útil si utilizas claves diferentes para distintas tareas, o si envías solicitudes de API a una herramienta de depuración o a un servidor de simulación de API, como Prism. Añade tantos entornos como necesites repitiendo los pasos anteriores y seleccionando el entorno que desees utilizar en el menú desplegable situado en la esquina superior derecha de la pantalla.

Colecciones de carteros

Para obtener información sobre las colecciones Postman, consulte la página Colecciones de Postman documentación.