![]() ![]() The Capabilities endpoint lists the available shipment options (and their exclusions) given a certain country, parcel type and whether the recipient of the parcel is a business or a consumer. Suggested Test CasesĬreate an authorization token (initial request)Īn access token and a refresh token with expiration are returned by the My DHLParcel application.Ĭreate an new authorization with refresh token Please extend with test cases which are suitable for your line of business or wishes. tests with a negative outcome should also be taken into scope. These test cases with their positive outcomes are merely suggestions and it is not an extensive test set, e.g. To limit this list, you may provide the optional accountNumbers field in your authentication request.Įxample of response body (200) of the /api-key: By default, access tokens give access to all account numbers assigned to your API key user. The resulting access tokens contain some encoded information about your access rights, including a list of account numbers. The response of the refresh endpoint is the same as the initial call to the Authenticate API key endpoint it also results in an access and a refresh token with expiration date times. Please keep in mind that this refresh token also has an expiration date time, but it is significantly longer than that of the access token. ![]() When this time (expressed as a unix time stamp) has expired, the secure access can again be established by obtaining a new access token using the refresh token and the Authenticate refresh token endpoint. The access token is valid for a limited time, indicated by the expiration time in the response attribute ‘accessTokenExpiration’. As a response, the endpoint returns both an access token and a refresh token. The user-id and key are used to make the initial call to the Authenticate API key endpoint. When pressing the button again, a new user-id and key will be generated, overwriting and invalidating the previous one. ![]() ![]() Hold on to this information, since it will only be given out once. These unique values can be generated under the user account on the My DHL-Parcel Application page.īy selecting ‘Settings’ in the user dropdown menu and clicking the button ‘CREATE API KEY’ in the tab ‘API KEYS’, the user-id and key are generated. To get an authentication token, you will need the user-id and user key for your application. You can place a request for an account as a business by email to: CIM Parcel BNL.ġ.2 Services 1.2.1 Get your user-id and key Information pertaining to the user account.Ī business account is handed out by the sales department. This token is to be provided in the Authorization header of the HTTPĭHL has chosen JWT not just for authentication but also for the secure exchange of JSON The JWT token is necessary to test and work in the DHL production environment when dealing DHL secure endpoints are identified by a lock in the API docs (see right hand side of the specific endpoint). The DHL API endpoints (but not all) make use of JWT (JSON Web Tokens) for secure authentication and authorization. This documentation is ordered in the natural flow when using the api:ġ Authentication and Authorization 1.1 Intro But if you think there is any information missing, incorrect or you wish to provide us with suggestions, please feel free to contact us at: CIM Parcel BNL. The DHL shipping interfaces are there to help you to give the best possible experience to your end users. As such, we consider added fields to be backwards-compatible changes. However, certain additional fields may appear in the returned JSON, and we expect all clients to be able to deal with this. Of course, we guarantee backwards compatibility and will never change the contents or semantics of existing fields. Please note that our APIs are continually evolving, and as such additional functionality and data may become available over time. Please use that as the leading technical description of our API. The documentation present at the previous URL is generated automatically and therefore more correct over this manually created document. In this document some of our most important API endpoints are discussed, giving their business context and some examples on how to use specific features provided by the endpoints. Our API endpoints are implemented as RESTful web services so they can be easily integrated on any programming platform.īasic prior knowledge on JSON, HTTPS and an understanding of software programming is assumed.Ī quick overview on all endpoints of the DHL API can be found in our documentation gateway: This document is a developer’s guide and provides the necessary information to integrate your websites and mobile apps with our DHL API. Department : DHL MDP Development Introduction ![]()
0 Comments
Leave a Reply. |