文档介绍：快递鸟接口(API)技术文档
(沙箱环境)
1 前言 5
2 接口规范说明 5
接口规范及说明 5
报文及报文编码 5
接口数据包结构 6
JSON范例 6
系统级参数 6
流程示意图 7
名词定义 7
签名说明 7
关于签名 7
(C#)DataSign签名加密代码 9
接入步骤 10
3 下单类接口 12
预约取件接口 12
功能说明 12
基本信息 12
接口规则 12
支持情况 12
应用场景 12
沙箱接口响应场景模拟规则 13
应用级参数 13
返回参数 16
电子面单接口 17
功能说明 17
基本信息 17
接口规则 17
支持情况 17
应用场景 18
沙箱接口响应场景模拟规则 18
应用级参数 18
返回参数 22
订单分发状态推送接口 24
功能说明 24
基本信息 24
接口规则 24
接口要求 24
支持情况 24
沙箱接口响应场景模拟规则 24
应用级参数 25
返回参数 28
客户号申请接口 28
功能说明 28
基本信息 28
支持情况 29
沙箱接口响应场景模拟规则 29
应用级参数 29
返回参数 30
客户号推送接口 31
功能说明 31
基本信息 31
接口规则 31
支持情况 31
沙箱接口响应场景模拟规则 31
应用级参数 31
返回参数 32
4 轨迹查询类接口 32
即时查询接口 32
功能说明 32
基本信息 32
接口规则 33
支持情况 33
应用场景 33
沙箱接口响应场景模拟规则 33
应用级参数 33
返回参数 34
物流跟踪 37
轨迹订阅接口 37
轨迹推送接口 42
单号识别接口 49
功能说明 49
基本信息 49
接口规则 49
应用场景 49
沙箱接口响应场景模拟规则 49
应用级参数 50
返回参数 50
5 增值类接口 51
隐私快递 51
安全号码接口 51
6 附录 54
接口指令汇总 54
对接相关资料 55
电子面单模板规格 55
返回编码列表 57
7 技术支持 58
前言
快递鸟API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API 接口服务,满足不同用户的物流管理需求。
由于很多快递公司没有提供测试环境或者测试环境不稳定,快递鸟开发了一套沙箱环境,用于辅助接入API,在尚未开通快递鸟套餐服务的情况下,可以先对接和调试好接口。
节省API接入成本。
本文档就各个沙箱API接口进行详细说明,方便用户快速对接及使用快递鸟服务,沙箱API的数据完全是模拟的,并且不对数据的真实性做校验,并且不涉及过深的业务逻辑,沙箱API的宗旨就是辅助接入API,沙箱环境和正式环境还是有一些差别,但是API的请求参数和响应参数完全一致,具有很高的相似性。
接口规范说明
接口规范及说明
报文及报文编码
报文格式:Json格式
编码格式:UTF-8
交互协议上统一用UTF-8,避免传递中文数据出现乱码。
接口数据包结构
图例- 数据包结构(系统级{数据})
JSON范例
string userID = "test1237100";
//加密私钥,由快递鸟提供
string keyValue = "56da2cf8-c8a2-44b2-b6fa-476cd7d1ba17";
//请求地址
string url = "http://api./Ebusiness/";
//2-json
s