Get started with Zonos API

The Zonos API is constructed around REST. The API offers resource-oriented URLs, returns JSON-encoded responses, accepts form-encoded request bodies, and uses standard HTTP response codes and authentication.

To access the Zonos API, you will need an API key. The same API key will be used for testing purposes and when the integration is live. The API key is used to authenticate the requests.

Periodically, we will add fields to our API. In order to prevent errors once you are integrated with our API, we recommend ignoring unknown fields.

Authentication 

Zonos uses API keys to allow access to the API. You can register for a new Zonos account and API key here.

The API key will be included in all API requests to the server in a header that looks like the following:

serviceToken: meowmeowmeow

Note: Make sure to replace meowmeowmeow with your API key.

Version 

To access the API version, send the zonos-version header. Review the corresponding API documentation for the appropriate header information, if applicable and required.

If no version is specified, the default will be set to the last supported version.

The current version header is zonos-version: 2021-01-01.