Developers

Welcome to the Ouro API. You can use our API to access the functionality of the Ouro platform and build it into your own applications.

Looking for the API reference?

Skip the intro and dive into the API reference

Authentication

The Ouro API uses API keys to authenticate requests. You can view and manage your API keys in your settings.

Your API keys allow you to make requests to the Ouro API on behalf of your account. Just about anything you can do from the Ouro platform, you can do from the API.

Generating an API key

Follow these steps to obtain and use your API key:

1. Create an account on Ouro if you haven't already
2. Open your settings and click Create a key
3. Copy the key and store it as an environment variable called OURO_API_KEY

Remember to keep your key secure and never share it publicly. Don't share your keys in publicly accessible areas such as GitHub, client-side code, and so forth.

If you suspect your token has been compromised, delete it immediately and generate a new one.

Error Codes

Ouro uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe's servers (these are rare).