Authentication
API KEYS
All Requests made on the Brails API must be authenticated via an API key.
You will need API keys to get started with interacting with the API. Go to the Dashboard settings; sandbox (opens in a new tab) or production (opens in a new tab). Click on Generate a new key.
To authenticate your requests, use the API key in the Authorization header of all requests you make
API Key Authorization Sample
Authorization: Bearer BRAILS-API-KEY
If you use an expired or incorrect API key, we will return an error for that request.
API Key Security
It is very important to keep your API keys secure, do not hardcode them. Your API keys can be used to make unrestricted transactions on your account.
Also, ensure that you use only test API keys for test environments and get a production API key when you're ready to go live.
Separating credentials from your code base and database is always good practice.
All API Requests should be made via HTTPS
Security is very important when dealing with financial transactions, ensure all requests are made over HTTPS. We will reject the request if it's not sent via HTTPS