Getting started
Introduction
Bring provides a collection of APIs to facilitate integration with your systems. If you're running a webshop, or any software dealing with shipments from Nordic countries, using Bring APIs can add value to your business and to your customers:
- Let the customer choose between alternative shipping methods upon checkout with the Shipping Guide API
- Show your customers the current status of their shipment with the Tracking API
- Book a shipment through the Booking API
- Generate and download reports with the Reports API
API status
We continuously monitor our APIs with health checks. We use that for active monitoring and to measure our uptime. As a customer, you find our realtime and historical status at our status page.
Authentication
APIs for Shipping Guide, Pickup Point, Postal Code, Booking, Shipment, Modify Delivery, Event Cast, Reports and Invoice require authentication, while Tracking has extra features when authenticated.
We currently use custom headers for authenticating:
| 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 that sort of identifies where you're using the APIs. |
Getting an API key
To get an API key, you must be registered in Mybring and have an invoice agreement with Bring.
As a registered Mybring user, head to settings and API to generate and get the API key for your user.
JSON, XML, SOAP
Our APIs support a mix of formats:
| API | JSON | XML | SOAP | Requires authentication | Extra features when authenticated |
|---|---|---|---|---|---|
| Shipping Guide | ✓ | ✓ | ✓ | ✓ | — |
| Pickup Point | ✓ | ✓ | — | — | — |
| Postal Code | ✓ | ✓ | — | ✓ | — |
| Booking | ✓ | ✓ | ✓ | ✓ | — |
| Shipment | ✓ | ✓ | — | ✓ | — |
| Easy Return Service | — | ✓ | — | ✓ | — |
| Modify Delivery | ✓ | ✓ | — | ✓ | — |
| Tracking | ✓ | ✓ | — | — | ✓ |
| Event Cast | ✓ | ✓ | — | ✓ | — |
| Reports | ✓ | ✓ | — | ✓ | — |
| Invoice | ✓ | ✓ | — | ✓ | — |
| Order Management | ✓ | ✓ | ✓ | ✓ | — |
| Warehousing | ✓ | ✓ | ✓ | ✓ | — |