通用快递鸟接口(API)技术文档汇总

1 前言

快递鸟 API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动 APP 等系 统提供专业、稳定、优质的 API 接口服务，满足不同用户的物流管理需求。 本文档就各个 API 接口进行详细说明，方便用户快速对接及使用快递鸟服务。

2 接口规范说明

2.1 接口规范及说明

2.1.1 报文及报文编码

报文格式：Json 格式

请求方法的编码格式(utf-8)："application/x-www-form-urlencoded;charset=utf-8" 交互协议上统一用 UTF-8，避免传递中文数据出现乱码。

2.1.2 接口数据包结构 图例 - 数据包结构 (系统级{数据})

 2.1.3 JSON 示例

 

 2.1.4 系统级参数

 2.1.5 流程示意图

 2.2 签名说明

2.2.1 关于签名 快递鸟和第三方电子商务公司系统进行对接，有一定的安全机制。采用 IP 认证加签名 的方式对接，具体方案如下：

1.防止数据被篡改

在 POST 请求中会传递 5 个必须(R)参数

 注： DataSign 生成后，对方接收到数据后，以同样的算法进行签名(推送接口 RequestType 为 101/102 不需要进行 URL 编码)，生成摘要，对比两者的摘要是否相同，如果不同，说明传 递过程中发生数据篡改。

2.调用接口的身份认证

注册成为快递鸟用户后，会生成对应的用户 ID 和 APIKey，用户 ID 相当于用户名， APIKey 相当于密码。

举例：

1.假设

 2.那么 DataSign 签名的内容为

 

 3.接收方收到数据后，获得

EBusinessID 和 RequestData 和 DataSign 等这几个数据。

4.接收方对 EBusinessID 得到 APIKey，RequestData+APIKey 的数据进行 md5 和 base64 后的内容就为

OWFhM2I5N2ViM2U2MGRkMjc4YzU2NmVlZWI3ZDk0MmE=

5.接收方判断签名后的数据跟传递过来的 DataSign 是否一致，如果一致进行业务操作，如 果不一致返回错误。

2.2.2 (C#)DataSign 签名加密代码

 

 2.3 接入步骤

1.快递鸟官网注册账号成为快递鸟用户; 快递鸟提供的用户 ID 是调用接口服务的身份证明，不可更改、不可转用，API Key 是应用访问 API 的签名附加密钥，必须妥善保存。两者关系类似于用户名和密码，两者都会 在签名和业务参数中使用。

官网登录网址： http://www.kdniao.com/v2/IndexNew.aspx?from=news

官网注册网址： https://www.kdniao.com/reg?from=CSDN

官网接口介绍网址： http://www.kdniao.com/api-eorder?from=CSDN

2.登陆用户后台，进行实名认证，并开通会员服务;

 3.根据技术文档进行开发并在调试平台测试联调；

快递鸟提供各个 API 接口的 DEMO(包括：.Net 版本、Java 版本、PHP 版本)供开发参 考。

DEMO 下载地址：https://www.kdniao.com/documents-demo

4.系统发布上线。

注意：测试环境中获取的测试快递单号不可用于实际发货。