DSV API Catalogue onboarding process
Dear customer,
Thank you for starting to integrate with the DSV API catalogue for submitting bookings, printing labels and to track the status of your shipments.
To start using the DSV API, you will need to obtain the following credentials from DSV:
- DSV service authentication user name
- DSV service authentication password
- Subscription key for each integration with DSV (Booking, label, tracking)
- Test MDM (account) number
- Production MDM (account) number
Follow the below steps to receive credentials for your integration with the DSV API Catalogue.
Step 1: Sign up for a developer account
Go to https://developer.dsv/com/signup
, fill in the account details and click on the ‘sign up’ button.
Step 2: Activate the developer account
Once you have have filled in the sign up form, you will receive an email from DSV, containing an activation link, to activate your account.
An example email is as follows:
Please click on the activation link to activate your developer account.
Once the account is activated you are able to continue subscribing on the API product(s).
Step 3: Subscribe on the API product(s)
Once the activation of your developer account has been completed, you will receive another email from DSV, which includes an explanation on how to subscribe to the API product(s).
For each subscription you will receive a subscription key, that should be used in the configuration.
- Login via
https://developer.dsv.com/signin
with the created developer account. - Click on
API Catalogue
in the top of the screen, the below screen will open - Click on the
Subscribe
button for the following module(s):- For configuring Ordering
- Booking - Generic
- Labels - Generic
- For configuring Tracking
- Tracking - Generic
Note: DSV offers multiple versions for some subscriptions. Make sure that you are using the same version as you have selected in the carrier integration configuration. (e.g. TRACKING - V1 or TRACKING V2)
- For configuring Ordering
- Populate the request
- Set the name for the API in
- Read and agree to the terms of use by clicking on the checkbox.
- Click on the
Subscribe
button
With an approved subscription you get a set of authentication details which is required to call each API.
Step 4: Find subscription key(s)
To find the subscription keys, for each of the API(s) that you have just subscribed to:
- Go to
https://developer.dsv.com/
- Click on Sign in
- Go to your profile by clicking on
Profile
on the top right of the screen. - The subscription key can be found for each subscription by clicking on the show button.
- Use the Primary key for production
- The Secondary key can be ignored.
For every subscription (Booking, Labels, Tracking), two seperate email are forwarded to the email used for registration.
An example of the first email is:
An example of the second email is:
Step 5: Activating for production
After testing the setup, DSV will have to configure the account and provide the related MDM(acount) number for production.
Send an email to the DSV developer support team
(developer.support@dsv.com) and specify which API(s) you would like to activate for production (Booking, label, tracking).
DSV will respond by sending an email where you have to provide your contact details. Fill in the contact details accordingly. NOTE: The mobile phone number in the developer details will be used by DSV to provide the password via SMS. Make sure that you fill in a phone number to which you have access to so that you can receive the password safely.
Once DSV has received all the contact details, they will confirm a go-live date and provide you with the production MDM number.
Use of credentials
During the onboarding process, credentials were received in several steps of the process. Below is listed when and where each credential is received in the process.
- DSV service authentication user name = Created during sign up for DSV developer account
- DSV service authentication password = Received via SMS after providing developer contact details to DSV via email (Note: this is a different password from logging in into the DSV developer portal)
- Production subscription key for each integration with DSV = Found in the profile section of the DSV developer portal. Named as primary key.
- Test MDM (account) number = received via email after subscriping to an API
- Production MDM (account) number = received via email after confirmation and approval of registration by DSV