You're invited

We invite you to innovate with our APIs. Join the moment and let's change logistics together.

For developers by developers

We understand what you need to bring value to your users. Clear documentation and access to real data for testing purposes.

We'll help you to succeed

We are focused on building the best APIs. We'll look after the complexities of logistic processes, so you can focus on creating remarkable user experiences.

Our APIs:

• Shipments: Information about your active shipments.
• Invoices: Information about your invoices
• Contacts: Information about the contacts involved in a specific shipment.
• Parties: Information about the Party the Contact is part of.
• Webhooks: Receive notifications based on events.

The APIs can be called up to 100 times per minute.

To get started with our APIs you have to follow 3 mandatory steps which are described below:

Step 1: Get an account

To use our APIs, you need to have both a myHillebrandGori user account aswell as an API key. If you do not have a myHillebrandGori user account yet, you can get one here: https://my.hillebrandgori.com/signup
The user account is used to obtain access to the data that is relevant for you. To obtain the API key for your application, sign up here: https://developer.hillebrandgori.com/Register
The API key is necessary for your application to be able to call our APIs.
Note that we need to authorise your request first, which is a manual process.
After receiving the confirmation email that your account has been approved, follow the instructions in this email to activate your account. After these steps you will be able to login to our dev portal. This email will also contain your API key.

Step 2: Authenticate with oauth

To obtain a token that is needed later in every API call, you need to exchange your user credentials and API key for a token. Do a http post to https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token. Provide your API key and secret in the basic authorisation header (separated by a colon and base64 encode it).
Set Content-Type to application/x-www-form-urlencoded and Accept to application/json. In the body provide the following: grant_type=password&username=[username]&password=[password]&scope=offline_access
The response will contain your access token and a refresh token. Store them securely in private, non user accessible storage. Example request:

POST https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Authorization: Basic YXBpa2V5OmFwaXNlY3JldA==
grant_type=password&username=EnterUserNameHere&password=EnterPasswordHere&scope=offline_access

Step 3: Call the API (for example get all shipments)

Use the provided access token in every API call in the authorisation header, prefix it with 'Bearer '. Example request

GET https://api.hillebrandgori.com/v4/shipments 
Accept: application/json
Authorization: Bearer eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJzYW1wbGUiOiJqd3QifQ.1m34VpI4w-rYut4F6VruoMyI95i4nOgED9iY6hDLytI

Step 4 (optional): Expired token

The access token will expire after a certain period, if this happens you have to request a new access token, using your refresh token. Do a http post to https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token. Provide your API key and secret in the basic authorisation header (separated by a colon and base64 encode it).
Set Content-Type to application/x-www-form-urlencoded and Accept to application/json. In the body provide the following: grant_type=refresh_token&refresh_token=[refresh token]&scope=offline_access
The response will contain your new access token and new refresh token.
Use these tokens for your next requests. Example request:

POST https://login.hillebrand.com/oauth2/aus95hq7r8iIqp14M0i7/v1/token
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Authorization: Basic YXBpa2V5OmFwaXNlY3JldA==
grant_type=refresh_token&refresh_token=PIr11vkIjOIX0b8asESirqGvx0nV12FG&scope=offline_access

Note that you could also do step 2 instead of this step to get a new access token. Using step 4 is more secure though.

Via our webhook mechanism HillebrandGori offers a pro-active update mechanism for our customers. You can create a subscription for one or more event-types and we will notify you when the event(s) occur without the need to regularly poll for updates. Json content will be posted to a URI which you can provide when subscribing to an event-type.
For example, you want to receive a notifications when shipments are ready for transport. Via the 'Shipment ready for transport (new)' event-type subscription you will receive a notification when a shipment becomes ready.

HillebrandGori expects to receive an HTTP 200-OK response code from your endpoint. If we do not receive one we will try to post the webhook again. Our suggestion to prevent time-outs is to send the HTTP 202-Accepted response before doing any processing on the data.

Events are split into two types

• 'new' events are triggered when a date is entered for the first time
• 'changed' events are triggered when there is a change to the originally entered date

The full list of events we currently support is shown below:

Welcome to the FAQ section of our API Developer Portal! Here, you’ll find answers to the most common questions and challenges developers encounter while integrating with our APIs. If you can’t find what you’re looking for here, feel free to reach out to our support team for further assistance.

Token retrieval and expiration

Token retrieval process can be found here https://developer.hillebrandgori.com/#section/Get-Started.
Token expiration is 2 hours

Rate limits

100 calls per minute.

Timestamp format

Timestamps are expressed in UNIX format (also known as POSIX time or epoch time).
It is represented as a single integer that counts the number of seconds since the epoch.
The epoch is defined as 00:00:00 Coordinated Universal Time (UTC) on January 1, 1970.

Authorization mode for webhook subscription

The available authorization mode is BASIC. When submitting the subscription, it is required to provide base64 encoded username and password separated by a ":".

Webhook subscription deactivation due to error response

Webhook subscription can be set to inactive if a non-200 series response is returned when calling the subscriber's endpoint, to which events are posted.

Webhook subscription monitoring

Subscription status can be monitored via GET webhooks/me