Overview of the API capabilities.

Scope

The API Scope is described here. Please describe the scope in a business language, so people can understand which services are offered.

Using the API

What's needed to use the API?

Example Use Cases

Describe use cases which people can relate to their use of the API.

Many Users find Example Use Cases as helpful in determining if this is the right API for their needs.

Get Access

You must request credentials for any applications you develop

To register your app and get your API subscription keys:

1. Click My Apps on the portal website.
2. Click the + Add App button.
   The "Add App" form appears.
3. Complete the Add App form.
   You can select the APIs you want to access.
4. When you have completed the form, click the Add App button.

Postman Collection

Download link

Authentication

Every call to the API requires a subscription key. This key needs to be either passed through a query string parameter or specified in the request header (DHL-API-Key).

To view your API subscription keys:

1. From the My Apps screen, click on the name of your app.
   The Details screen appears.
2. If you have access to more than one API, click the name of the relevant API.
   Note: The APIs are listed under the "Credentials" section.
3. Click the Show link below the asterisks that is hiding the Consumer Key.
   The Consumer Key appears.

Environments

The addressable API base URL/URI environments are:

Rate limits

Rate limits protect the DHL infrastructure from suspicious requests that exceed defined thresholds.

The table below details the main request limits:

Please contact api@dpdhl.com if you need a different service level.

When the limit is reached, you will receive an HTTP Status code:

429: Too many requests.  

Additional Information

Example requests

Simple HTTP request example

curl -X GET 'https://api-eu.dhl.com/your_endpoint?parameter=1234' -H 'DHL-API-Key:PasteHere_ConsumerKey'

Legal Terms Content. This section is required for customer facing APIs.

Simon Wirges (simon.wirges@dhl.com) is the point of contact for this matter.