Quick Start

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Dashboard at any time.

API keys must be passed as an HTTP header using the x-yoyo-key key. We recommend that you don't expose your API key in your client app. They are meant to be used from backend servers.

User Agent

All API requests MUST include a valid User-Agent header key-value pair. Requests without a valid User-Agent header will be rejected.

We request that you use the name of your application, for the User-Agent header key-value pair. This allows us to identify your API requests properly and contact you if there are problems.

Here's an example:

User-Agent: App-Name

cURL and Postman send a valid User-Agent header key-value pair by default. If you do not provide a valid User-Agent header via cURL (or via an alternative client), you will receive an HTTP status code 403 response.