loading...
Vonage

Announcing the Vonage APIs Postman Collection

iza_biro profile image Julia Biro Originally published at nexmo.com on ・3 min read

At Vonage, we publish OpenAPI specifications for all our APIs. These specs enable our developer community to explore, evaluate, and integrate the Vonage APIs efficiently.

As Lorna mentioned in her article on evaluating APIs using OpenAPI, downloading an OpenAPI Spec and exploring it in Postman is a great way to familiarize yourself with new APIs.

I couldn’t agree more! If you’re not already familiar with Postman, it’s a friendly graphical interface to a powerful cross-platform HTTP client that I encourage you to try.

We’re excited to announce that exploring the Vonage APIs has just gotten even quicker and easier! We’ve added a “Run in Postman” button to the Postman page on our developer portal, so now you’re only a couple of clicks away from making your first request.

It is also discoverable on the main Postman network if you’d rather browse it there.

Once you click on the Run in Postman button, you’ll be taken to your Postman instance of choice, and all of the Vonage API Calls will be waiting for you, nicely organized into a collection.

Vonage APIs Postman collection imported view

A great thing about using a Postman Collection is that we can prepare the requests for you, so there’s minimal work involved in making the API calls.

It also has some neat features, like the ability to configure environment variables. This collection comes with a Vonage Environment that lists API_KEY, API_SECRET, and JWT, which are the most commonly used parameters, but feel free to add others as you go. You can find the environments by clicking the cog icon in the top right-hand corner.

Vonage environment variables in Postman Collection

To add your credentials, update the current values of API_KEY and API_SECRET with the API key and secret found in your Vonage dashboard (no need to set up JWT for now).

Using the Vonage APIs Postman Collection

Next, let’s have a closer look at using the Vonage APIs Postman Collection to explore the Numbers API.

Expand the collection folder and find the Numbers folder inside it.

Numbers requests in Vonage APIs Postman collection

Vonage’s Numbers API allows you to manage your virtual number inventory programmatically. To find out more about the available operations, make sure to check out the Numbers API Reference.

For this example, let’s try out the List numbers you own entry.

Your api_key and api_secret will be pulled in dynamically from the Vonage Environment, so double-check that you’ve set those values in the environment, then click send.

Numbers API List numbers you own response body

Et voilà! You’ve successfully made your fist Vonage API request using our Postman collection!

Give it a try, have fun, and let us know what you think!

Where Next?

The post Announcing the Vonage APIs Postman Collection appeared first on Vonage Developer Blog.

Discussion

pic
Editor guide