MyDHLAPI onboarding process

Dear customer,

We appreciate your decision to integrate with MyDHLAPI, the comprehensive solution for all DHL Express service operations. In order to proceed with using the integration, it is essential to acquire credentials from DHL. These credentials can be easily requested on the DHL website.

Please keep in mind that having an account number is a prerequisite before initiating the onboarding process

Onboarding steps

Follow the below steps to receive credentials for your integration with MyDHLAPI

Step 1: Sign up for a developer account

1. Go to https://developer.dhl.com/
2. Click on the “Sign Up” button to create a new account.
3. Fill in the required information and agree to the the terms and conditions.
   1. Note the email adress used for this acccount can NOT be changed afterwards.
4. Submit the registration form.
5. After the registration form, DHL sends an email to set your password and to complete your developer registration.
6. DHL sends an email how you can setup the password and complete the developer registration.
7. Once the instructions in the email have been followed and your new password has been saved, click on the DHL logo in the top bar to go back to the home screen to continue with the next step.

Step 2: Create an application

Once you have signed up on the DHL website, you have to create an app to get access to the API(s)

1. Click on the Browse our APIs button.
2. Search for "MyDHLAPI" in the top left search bar and click on the the result DHL Express - MYDHLAPI
3. Click on the Get Access button on the top right.
4. Fill in the required information
   1. At Account Details: provide your DHL account number
   2. At Requester company details: provide the requester details.
      1. NOTE: These details can be different from the account owner details. If so, click on ‘No’ at the question, Are the Requestor Details the same as the DHL Account Owner details?
      2. If the account owner details are different from the requestor details, DHL also requests the address details of the account owner.
   3. At How would you like to use the API?:
      1. select the option ‘I require credentials to DHL Express- MyDHL API for an existing plugin/ecommerce platform/third-party solution’.
      2. For Requestor platform name, fill in ShipitSmarter.
   4. At Requested Services: select the option(s) and fill in the expected usage and volume:
      1. Products and Shipment for ordering shipments and retrieval of labels.
      2. Tracking to receive tracking information for your DHL shipments
      3. Pickup to book pickup requests
      4. Rating to receive shipping rates and transit times
5. Agree with the terms and conditions, which are the bottom two checkboxes.
6. Submit the registration form.
7. After submission, DHL shows a confirmation. Now you are able to see the onboarding status in the My Apps Dashboard

Once your application is created, you are able to view the status of your credentials in the App dashboard. In this dashboard, you are also able to find your user credentials once they are approved by DHL.

3. View status of onboarding request

Once your application is created, you are able to view the status of your credentials in the App dashboard. In this dashboard, you are also able to find your user credentials once they are approved by DHL.

1. You will see your newly created app in the list with apps with the status next to it.
2. Click on the Edit button to see more details about your request.
3. According to DHL, it takes 2-5 working days to receive a response on the onboarding request. It is however recommended to also contact your account manager to possibly speed up the process.
   1. NOTE: Please also check the status of your onboarding with the account manager, as some countries are not aware of the portal and therefore are not using the portal.

4. Obtain API credentials

Once an approval has been received from DHL via email, you are able to obtain the API credentials via the developer portal.

1. Log in with your developer account on https://developer.dhl.com/
2. Click on Apps
3. You will see your app in the list with apps with the status next to it.
4. Click on the Edit button to see more details of your request.
5. This page shows the following information:
   1. The top section shows general information on your onboarding like the app name and the status
   2. The Credential section shows you the credentials required for using the API.
      1. The API Key, is used as the username (Click on ‘Show key’ to show the actual value)
      2. The API Secret, is used as the password (Click on ‘Show key’ to show the actual value)
   3. The APIs section shows you for which environments the keys are enabled.
      1. If your credentials have been enabled for Customer (Integration) testing, you are able to use the credentials in the playground environment.
      2. If your credentials have been enabled for Production (Global), you are able to use the credentials in the production environment.