OpenAPI

OpenAPI is an industry standard specification for describing APIs. We use OpenAPI to describe all our APIs, and we make those specifications publicly available too.

Finding an OpenAPI Specification

Each of our products has its own OpenAPI specification. The easiest way to find it is from the API reference - at the top of the page you'll find "Download OpenAPI Specification", where you can download the API reference. The API reference pages themselves are generated from these specifications.

Each specification is available in both YAML and JSON formats; you can view them with a plain text editor.

Use an OpenAPI Specification in Your Own Projects

Having the OpenAPI description of an API that you want to integrate with can really make things easier! Here are some suggestions that you might like to try:

Local Documentation

Whether you're working on a poor connection or prefer to keep things straightforward, an OpenAPI spec has all the information you need to be able to run a local application to show documentation. ReDoc is one example of an open source documentation tool that you can use to view the API specification.

Postman Collections

Vonage has a dedicated Postman collection for our most used APIs. You can read about it in the Postman guide.

Mock Server for Testing with Prism

One tool that many of our developers find useful is Prism. It's an open source JavaScript tool that accepts an OpenAPI spec and then imitates the API behavior it describes. It's an ideal way to work with a local API, avoids using up account credit when you're testing something, and also provides a way to test error responses locally.