Getting started
Authentication
You need an API key to integrate with the Bring APIs.
The key is unique to your user and is used in the authentication headers. All our APIs require authentication except for some basic functionality in the Tracking API. This is so that we can offer better support and notify our users about new features and changes.
Get an API key
1. Sign up
If you don’t already have a user, register a new one in Mybring.
2. Generate key
Head to the API page in your user profile and generate the API key.
Authentication headers
| Header | Example | Comment |
|---|---|---|
X-MyBring-API-Uid |
john.doe@example.com |
Mybring login ID |
X-MyBring-API-Key |
1234abc-abcd-1234-5678-abcd1234abcd |
Your user’s API key |
X-Bring-Client-URL |
https://example.com/ |
A URL identifying where you’re using the APIs |
Status and support
We continuously monitor our APIs with health checks to measure uptime. Real-time and historical status can be found at our status page.
If you have trouble or questions regarding the different APIs, we actively use the comment sections on the respective API docs.
Formats
All our APIs support JSON and XML. Shipping Guide, Booking, Order Management and Warehousing also support SOAP.