Dhl Api

Technical Preview

Overview

Client-mode REST API connectors for the DHL API Developer Portal: Shipment Tracking Unified (every DHL division) with Tracking Push subscriptions, Location Finder service points, DHL Express MyDHL API (rates, landed cost, shipments and labels, pickups, tracking, proof of delivery, paperless trade uploads) and Post & Parcel Germany (Parcel DE Shipping, Pickup and Returns with OAuth); purchases marked; companion server connector for DHL Tracking Push webhooks. This is one of the templates in the DHL API Developer Portal REST API app (dhl-api-developer-portal). Deploy it alongside the other connectors of that app when they depend on each other (for example a token connector plus an API connector).

Not yet verified against the live vendor API: No own DHL credentials on the factory box (no DHL_* / MYDHL_* variables): no developer.dhl.com app key with the Tracking / Location Finder / Push / Parcel DE products, no MyDHL API username + password, no DHL Express account or Parcel DE billing number. Static, mock, negative-control and no / fake-credential public probes ran; DHL’s public pre-defined test keys gave live 200s for TrackShipment (mocked data), Location Finder and the Parcel DE sandbox token + hello, but those demo keys have no shipping product (Parcel DE ValidateShipments 401 no apiproduct match; MyDHL rejects the portal demo key), so no authenticated GET + POST round trip of the shipping APIs and no broker MQTT round trip.

Auth

Per product: DhlApi + DhlLocationFinder header DHL-API-Key (developer.dhl.com app key); MyDhlExpress HTTP Basic MyDHL username:password (from DHL Express, not the portal key) + x-version 3.3.3 + Message-Reference; DhlParcelDeAuth OAuth 2.0 password grant (form grant_type=password, username, password = GKP system user, client_id = API key, client_secret = API secret; reply access_token Bearer, expires_in 1799, no refresh token); DhlParcelDe Authorization: Bearer only (bearer + dhl-api-key together -> 401). Every event sends User-Agent: Coreflux-Broker. Auth headers used by the template: DHL-API-Key: {value.json.api_key}.

Template parameters

Placeholder	Type	Description	Required
`RouteName`	string	Name of the Dhl Api connector	no
`BaseUrl`	string	Dhl Api base URL without trailing slash (e.g. https://api-eu.dhl.com)	yes

BASE_ADDRESS default: https://api-eu.dhl.com.

Events

Event	Method	Endpoint	Request topic	Response topic	Payload fields
`TrackShipment`	GET	`/track/shipments?{value.json.query}`	`fleet/dhl/shipment-tracking/get`	`fleet/dhl/shipment-tracking/get/response`	`api_key`, `query`
`CreateTrackingSubscription`	POST	`/tracking/push/v1/subscription`	`fleet/dhl/tracking-subscription/create`	`fleet/dhl/tracking-subscription/create/response`	`api_key`, `body`
`ActivateTrackingSubscription`	POST	`/tracking/push/v1/subscription/{value.json.id}`	`fleet/dhl/tracking-subscription/activate`	`fleet/dhl/tracking-subscription/activate/response`	`api_key`, `hook_secret`, `id`
`GetTrackingSubscription`	GET	`/tracking/push/v1/subscription/{value.json.id}`	`fleet/dhl/tracking-subscription/get`	`fleet/dhl/tracking-subscription/get/response`	`api_key`, `id`
`ListTrackingSubscriptions`	GET	`/tracking/push/v1/subscriptions`	`fleet/dhl/tracking-subscription/list`	`fleet/dhl/tracking-subscription/list/response`	`api_key`
`DeleteTrackingSubscription`	DELETE	`/tracking/push/v1/subscription/{value.json.id}`	`fleet/dhl/tracking-subscription/delete`	`fleet/dhl/tracking-subscription/delete/response`	`api_key`, `hook_secret`, `id`

Deploy

Get the template card (JSON with template and metadata) from the broker, then deploy the connector:

mosquitto_pub -t '$SYS/Coreflux/Command' -m "-routeCode DHL_API"

The deployable connector from the REST API app, with BASE_ADDRESS already filled in:

DEFINE ROUTE DhlApi WITH TYPE REST_API
    ADD REST_API_CONFIG
        WITH BASE_ADDRESS "https://api-eu.dhl.com"
        WITH ENABLE_CLIENT "true"
        WITH USE_SSL "true"
        WITH REQUEST_TIMEOUT '60'
        WITH DEFAULT_CONTENT_TYPE "application/json"
    ADD EVENT TrackShipment
        WITH SOURCE_TOPIC "fleet/dhl/shipment-tracking/get"
        WITH DESTINATION_TOPIC "fleet/dhl/shipment-tracking/get/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/track/shipments?{value.json.query}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "DHL-API-Key" "{value.json.api_key}"
    ADD EVENT CreateTrackingSubscription
        WITH SOURCE_TOPIC "fleet/dhl/tracking-subscription/create"
        WITH DESTINATION_TOPIC "fleet/dhl/tracking-subscription/create/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/tracking/push/v1/subscription"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "DHL-API-Key" "{value.json.api_key}"
            ADD "Content-Type" "application/json"
        WITH BODY "{value.json.body}"
    ADD EVENT ActivateTrackingSubscription
        WITH SOURCE_TOPIC "fleet/dhl/tracking-subscription/activate"
        WITH DESTINATION_TOPIC "fleet/dhl/tracking-subscription/activate/response"
        WITH METHOD "POST"
        WITH ENDPOINT "/tracking/push/v1/subscription/{value.json.id}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "DHL-API-Key" "{value.json.api_key}"
            ADD "DHL-API-Hook-Secret" "{value.json.hook_secret}"
        WITH BODY ""
    ADD EVENT GetTrackingSubscription
        WITH SOURCE_TOPIC "fleet/dhl/tracking-subscription/get"
        WITH DESTINATION_TOPIC "fleet/dhl/tracking-subscription/get/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/tracking/push/v1/subscription/{value.json.id}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "DHL-API-Key" "{value.json.api_key}"
    ADD EVENT ListTrackingSubscriptions
        WITH SOURCE_TOPIC "fleet/dhl/tracking-subscription/list"
        WITH DESTINATION_TOPIC "fleet/dhl/tracking-subscription/list/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/tracking/push/v1/subscriptions"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "DHL-API-Key" "{value.json.api_key}"
    ADD EVENT DeleteTrackingSubscription
        WITH SOURCE_TOPIC "fleet/dhl/tracking-subscription/delete"
        WITH DESTINATION_TOPIC "fleet/dhl/tracking-subscription/delete/response"
        WITH METHOD "DELETE"
        WITH ENDPOINT "/tracking/push/v1/subscription/{value.json.id}"
        WITH HEADERS
            ADD "Accept" "application/json"
            ADD "User-Agent" "Coreflux-Broker"
            ADD "DHL-API-Key" "{value.json.api_key}"
            ADD "DHL-API-Hook-Secret" "{value.json.hook_secret}"

Deploy it with -addRoute (do not include ADD METADATA).

Usage example

Call TrackShipment by publishing a JSON payload to its request topic, and read the reply on the response topic:

mosquitto_sub -t 'fleet/dhl/shipment-tracking/get/response' &
mosquitto_pub -t 'fleet/dhl/shipment-tracking/get' -m '{"api_key": "<api_key>", "query": "<query>"}'

Quick Start

Coreflux MQTT Broker

LoT Language

Coreflux HUB

VS Code - LoT Notebooks

Coreflux Portal

Using AI with Coreflux

Product Updates

Overview

Auth

Template parameters

Events

Deploy

Usage example

​Overview

​Auth

​Template parameters

​Events

​Deploy

​Usage example

​Related

Overview

Auth

Template parameters

Events

Deploy

Usage example

Related