Postman

Our APIs can be used with any HTTP client; however, we recommend Postman, a friendly graphical interface to a powerful cross-platform HTTP client.

Vonage has created a Postman collection, designed to give you a quick start with our most well-used APIs. The workspace is structured by capability, allowing you to easily find the API you're looking for. It also contains fully documented requests; in the 'Description' tab for each request, you'll find documentation explaining what the call does, when you’d use it, required variables (API keys, secrets, JWTs), and expected responses.

Click the "Run in Postman" button to fork the workspace into your own Postman environment and test the collection:

You can also download and import our OpenAPI specifications directly by following the instructions below.

Postman and OpenAPI

Postman has support for the OpenAPI documents that we publish with all our APIs.

Install Postman and follow the steps laid out below to very quickly try out any of the Vonage APIs. We publish an OpenAPI document for each API, and Postman can read these and create a collection of requests that you can enter values into.

Download and Import the OpenAPI Specification

The easiest way to find the OpenAPI document is to click the "Download OpenAPI 3 Specification" button on the API reference for the API you'd like to try. For example visit the Verify API reference page and click the download button. You can download it in .yml or .json format.

You can then follow these instructions to import the file into Postman.

Make an API Call

Once imported, you'll be able to see the different endpoints available for the API. For example, if you imported the Verify API description, you'd be able to choose "Request a verification be sent to a user" from the left hand nav, and get a ready-made request to use. Once you've updated the headers and body with any required information, you can press 'Send' and check the response from the API.

Postman Advanced Usage

Use Environments

Postman has an environments feature that allows you to use the same variables (such as your API credentials) in many different requests.

To create an environment, click the settings cog in the top right hand side of the screen and choose "Add". Give your environment a name, and add any variables you want to use, such as:

• api_key
• api_secret
• phone_number

Once saved, you can, for example, enter {{api_key}} in your requests instead of pasting in your API key. Postman will use the value from the current environment.

You can have multiple environments, which is useful if you use different keys for different things, or if you are sending API requests to a debugging tool or API mocking server such as Prism. Add as many environments as you need by repeating the steps above and choosing the environment to use from the dropdown in the top right hand section of the screen.

Postman collections

For information about Postman collections see the Postman Collections documentation.