In general, calls will be made in the following sequence:
- Driver is Assigned to an Order
- Start Order
- Update Driver Location (this call should happen at least every 30 seconds while the driver is busy with the delivery)
- Check In / Driver Arrives on Site
- Create Note / Add POD (Signature / Photo / Comment / Form / Document) (if relevant)
- Check Out / Driver Leaves Site
- Complete Order
- Cancel Order
- Update Order
All the specific endpoints will be found in your Sandbox.
POST calls
All the API calls (including Get Token API) use POST.
If you use GET, you will receive a 404 error.
AUTHORIZING API CALLS
- Your API calls need to be authorized using an OAuth2 token.
- This token is generated using the Client ID and Secret Key found in your Sandbox.
- The token will be valid for 30 minutes.
- Make sure to include the token in the Authorization header of the API calls in the Bearer format e.g. "Bearer < token >".
Instructions on how to send the Get Token API can be found here.
ERROR RESPONSES
- Bringg will return "401 Unauthorized" errors if there is an issue with the authentication of the API call. e.g. if the token has expired or the wrong secret key/token was used
- Bringg will return "403 Forbidden" errors if there is an issue with the payload itself e.g. if the incorrect task_id is specified.
TLS PROTOCOL
- All secure connections to Bringg require Transport Layer Security (TLS) 1.2 or later.
For SSL connections, the following ciphers suites are supported:
- ECDHE-ECDSA-AES128-GCM-SHA256
- ECDHE-RSA-AES128-GCM-SHA256
- ECDHE-ECDSA-AES256-GCM-SHA384
- ECDHE-RSA-AES256-GCM-SHA384
- AES128-GCM-SHA256
- AES256-GCM-SHA384
- ECDHE-ECDSA-AES128-SHA256
- ECDHE-RSA-AES128-SHA256
- ECDHE-ECDSA-AES256-SHA384
- ECDHE-RSA-AES256-SHA384
- AES128-SHA256
- AES256-SHA256
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
- TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256