Overview

Getting started with the Vygo API

Get Your API Key

You can create your API keys in the admin > developer section of the Vygo platform. All new keys will be created in ‘Test Mode’ by default. This will allow you to test your configuration and receive 'production-like' responses without triggering the operation. You will need ‘Organisation Admin’ level permission to access the developer section of the platform.

Pass your API key via the "x-api-key" header with each request.

Rate Limiting

The Vygo API has a rate limit of 18 requests per minute.

Only one request can be in-flight at a time.