1. 概述
1.1 简介
提供货运跟踪节点的推送更新。
推送通知的优势:
- 避免不必要的 API 调用和数据轮询;
- 推送更新提供接近实时的状态更新,并持续让客户了解最新情况。无需主动请求最新的货运更新即可获得最新状态。
更好的客户体验:
推送更新是一种灵活而简单的解决方案,只需进行最少的设置即可集成到客户工作流程中。
最终结果是实时通知,成本更低。
网址:https://developer.dhl.com/user/login?destination=/api-reference/shipment tracking-unified-push#get-started-section/
如果您想了解更多详细信息,请参阅网站的概述页面。
请注意:客户仅能使用尾程单号(last-mile tracking number)请求Tracking Push API进行订阅获取轨迹节点推送更新,如使用shipment ID进行订阅并不会收到节点更新信息。
客户可以使用shipment ID作为单号请求Tracking Pull API后获取对应的尾程单号,再使用该尾程单号请求Tracking Push API进行订阅节点推送。
2. 注册流程
您必须请求获取Tacking Push API凭证.
➢ 创建开发者账户
o 输入姓名、邮箱、公司名称等相关信息进行注册
o 验证码
o 点击“Send”按钮
➢ DHL员工 – 点击"Log in as a DHL employee".
2.1 注册
➢ 网址:https://developer.dhl.com/user/login?destination=/node/3
➢ 创建开发者账户 – 点击“Sign up here”按钮注册;
➢ 已注册客户 – 点击“sign in here”按钮登录。
➢ 忘记密码 – 点击“Forgot your password?”
图1 DHL API Developer Portal登录页面
➢ 创建开发者账户
o 输入姓名、邮箱、公司名称等相关信息进行注册(建议使用公司邮箱注册,请勿使用网易163邮箱注册)
o 验证码
o 点击“Send”按钮
图 2 DHL API Developer Portal注册页面
➢ 注册完成后会跳转到以下页面,同时注册邮箱会收到DHL API Developer Portal的邮件通知,请根据邮件内容设置密码。
图3 DHL API Developer Portal首页
2.2 获取 API 凭证
1. 进行API权限申请:请访问Tacking Push API说明页面:https://developer.dhl.com/api-reference/shipment-tracking#get-started-section/,点击右上角Get Access按钮(图4)填写公司信息进行API权限申请。
图4 Tacking Push API说明页面
2. 填写申请信息:请于图5页面填写申请信息,申请信息填写完成后,请点击Send message发送申请(图6)。申请发送成功后您会收到通知邮件告知您API Customer Support Team已收到您的申请。
图5 Tacking Push API权限申请页面1
图6 Tacking Push API权限申请页面2
3. 查看申请状态:点击右上角菜单栏 图标(图7),进入User Dashboard界面查看APP(图8)。创建后,APP状态 为“in progress”。 申请批准后,系统将向注册的电子邮件地址发送批准电子邮件,并且 APP 状态将更新为“approved”。
图7 User Dashboard图标
图8 APP页面
4. 查看API凭证:在APP信息页面点击申请的Shipment Tracking - Unified – Push(图9),在图10 APP详情页面,点击Show key可查看API Key和API Secret。
图9 点击对应APP name
图10 APP详情页面
2.3 升级速率限制
点击Upgrade Rate Limit(图11),进入升级API速率限制的申请页面(图12),填写完成后点击Send message发送申请。
图11 Upgrade Rate Limit
图12 Upgrade Request
3. Shipment Tracking - Unified – Push API对接说明
请访问以下Tracking Push API对接说明页面查看详情信息。
API USER GUIDE:https://developer.dhl.com/api-reference/shipment-tracking-unified-push#get-started-section