Cartero

Nuestras API pueden utilizarse con cualquier cliente HTTP; ¡elija su favorito! Nos encanta Carteroes una interfaz gráfica amigable para un potente cliente HTTP multiplataforma.

Pruebe nuestro botón "Ejecutar en Postman" para iniciarse rápidamente en nuestras API más utilizadas:

Si necesitas alguna de nuestras API Beta o Developer Preview, sigue leyendo para saber cómo utilizar los documentos OpenAPI de las páginas de referencia de API con Postman.

Postman y OpenAPI

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

Instala Postman y sigue los pasos que se detallan 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 ingresar valores.

Obtener la descripción OpenAPI de la API

La forma más sencilla de encontrar el documento OpenAPI es pulsar el botón "Descargar especificación OpenAPI 3" en la referencia de la API que desea probar. Por ejemplo, visite la página Verify Página de referencia de la API y haga clic en el botón de descarga. Los archivos están en .yml formato.

Importar especificaciones a Postman

Inicie Postman y busque el botón "Importar" encima de la barra de la izquierda. Busque el archivo .yml que desea utilizar, seleccione "Abrir" y, a continuación, "Siguiente".

En la barra lateral izquierda, ahora tendrá una carpeta/colección para su API, y dentro de ella una solicitud de plantilla para cada uno de los puntos finales de la API.

Realizar una llamada a la API

Por ejemplo, si ha importado la descripción de Verify API, podrá elegir "Verify Request" en la barra de la izquierda y obtener una solicitud lista para usar. Siga adelante y añada los campos que necesite:

• Sus credenciales de la API En el caso de Verify API son las API_KEY y API_SECRET y podrá encontrar estos datos en el panel de control de su Account
• El número de teléfono a Verify (recuerde utilizar el formato E.164)
• El nombre de la marca que realiza la verificación (aquí puede elegir cualquier cosa, ya que sólo está probando cosas).
• Fije el format en la sección de parámetros de la ruta a json

Ahora pulse "Enviar" y compruebe la respuesta de la API.

Uso avanzado de Postman

Somos grandes fans de Postman, así que hemos pensado en compartir contigo nuestros mejores consejos.

Entornos de uso

El cartero tiene un característica de los entornos que resulta realmente útil cuando se utilizan las mismas variables (como las credenciales de la 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

Guarde los valores y, a continuación, en su solicitud, en lugar de pegar su clave de API, puede escribir {{api_key}} y Postman utilizará el valor del entorno actual.

Puedes tener múltiples entornos, lo que es útil si utilizas diferentes claves para diferentes cosas, o si estás enviando peticiones API a una herramienta de depuración o a un servidor de imitación de API como Prism. Añade tantos entornos como necesites repitiendo los pasos anteriores y eligiendo el entorno a utilizar en el desplegable de la parte superior derecha de la pantalla.

Colecciones de carteros

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