Each API defines its own integration approach. Common predefined options include:
- Access to a Test Environment (Sandbox) for initial development and testing.
- Access to a Production Environment with a small rate limit of calls per day.
- Access to a Production Environment with a higher rate limit of calls per day.
The type of access you receive is determined by the specific API and cannot be chosen by the user. While there may be similarities across DHL divisions, each API may follow a different model. We recommend testing the API before going fully live with your business processes.
Which Environments are available for your APIs?
Available environments may vary by API. For details, please refer to the “Environments” section in the documentation for the API you are using.
Note: Not all APIs provide a Test or Sandbox environment. In some cases, testing must be performed directly in the Production environment.
Where can I find examples of requests and responses of your APIs?
Most APIs include a “Try Now!” section in their documentation, offering sample requests for different parameters and example responses. This section is typically located in the top-right corner of the page. Please note that not all possible use cases are covered in these examples.
Do the APIs have an Open API Specification?
Yes. Most APIs provide an OpenAPI Specification file. You can find it in the “Reference Docs” section of the API documentation.
I ran out of calls when testing an API. Can I get a larger rate limit?
In many cases, this is possible. Please refer to the “Rate Limits” or “Quota Limits” section in the documentation for the specific API. Learn more in the "Get a Higher Rate Limit" step.