Getting started with Bring APIs
Authentication is required by all APIs, that means having a Mybring user account with an API key. Authorisation is required by some APIs, that means having a customer number and certain rights connected to the user. The following describes how the requirements work together and how to obtain them.
Customer number
In order to use the majority of our APIs, your company needs to be a Bring customer and have a customer number. While most customers have only one customer number, many also choose to have multiple when they need to separate departments or subsidiaries.
If the API you want to use requires a customer number and you don’t have one yet, contact customer support via your country’s Bring site.
If you need a customer number for testing purposes, it can be found in the API testing documentation.
Mybring user account
You need a personal Mybring user account to work with the Bring API’s. If you don’t have one already, register a new account.
Customer number access
You can see the customer numbers your account has access to on the Mybring API page. If the customer number you are looking for isn’t listed, you can get access to it through one of the following methods:
- Go to the Mybring authorisation page, search for the customer number and apply for access.
- Contact your customer’s administrator and get them to connect your user.
You might work with multiple companies and each of these companies might have multiple customer numbers in Bring. You can use the same Mybring user for different companies.
User rights
Rights control what the user can do, for instance order certain services on behalf of the company or see certain information about it. While one user can have access to many different customers, the rights are specific for each customer number. The company administrator controls the accesses and rights within a company and the user can apply for them in the Mybring authorisation page.
API Key
When you have a Mybring user, you can create an API key. The key is necessary for authentication and is unique to your user account. It’s used together with the user account email address when connecting to the APIs. The same key is used for all APIs and all Bring customer numbers the user has access to.
Be aware that if you choose to change or delete the API key or delete the entire user account, any integration using it will stop working and must be updated with a new key.
The API key is created and managed in the Mybring API page.
Authentication headers
When you have the user account with the access, rights and API key, you are ready to connect to the APIs in either your own system or an API client. Each API has individual details, but the following three HTTP header parameters are always required.
- X-Mybring-API-Uid
- The email address of your Mybring user account.
- Example:
name@your-company-domain.com - X-Mybring-API-Key
- The user account’s API key.
-
Example:
1234abc-abcd-1234-5678-abcd1234abcd - X-Bring-Client-URL
- The URL for the service where you are using the API.
- Example:
your-company-domain.com
Updates, status and support
Stay up to date on changes and new features by subscribing to API updates. You can subscribe to all or pick the areas relevant to you.
We continuously monitor our APIs with health checks to measure uptime. Real-time and historical status can be found on the operational 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 are REST APIs supporting JSON and XML. Order Management and Warehousing are also SOAP APIs.