# 数据格式定义
- 数据编码采用UTF-8格式
- 采用HTTPS传输协议,POST方法
- Content-Type:application/json;charset=utf-8
- 涉及到金额的单位统一为分
- 涉及到时间格式的统一为毫秒级时间戳
# 字段释疑
名称 | 类型 | 说明 | 备注 |
---|---|---|---|
appid | string | 开发者账号 | 裹小递技术人员提供 |
secret | string | 开发者密钥 | 裹小递技术人员提供 |
timestamp | string | 数据格式为毫秒级时间戳,60秒内时间有效 | |
nonce | string | 数据格式为非重复的字符串,该串1分钟之内只能使用一次 | |
accountNo | string | 商家ID或手机号 | 由裹小递运营人员提供 |
signature | string | 加密签名 | 生成方式见下文 |
{SERVER_HOST} | string | 裹小递接口地址 | 由裹小递运营人员提供 |
# 联调账号信息
名称 | 说明 |
---|---|
appid | 由裹小递运营人员提供 |
secret | 由裹小递运营人员提供 |
accountNo | 由裹小递运营人员提供 |
# 请求接口访问及签名方式
所有接口均采用HTTP或HTTPS的方式,POST的方法,数据传输的格式为JSON;
每个请求头参数(Header parameter)均需要携带appid,nonce,timestamp,accountNo,signature
appid: appidval
nonce: nonceval
timestamp: timestampval
accountNo: accountNoval
signature: signatureval
签名(signature)生成方式如下:
- 根据 secret=secretVal=nonce=nonceVal=timestamp=timestampVal=accountNo=accountNoval 方式进行拼接
- 对上步得到的字符串用MD5加密得到签名,MD5加密Java代码示例如下:
String str = String.format("%s=%s=%s=%s=%s=%s=%s=%s", "secret", secretVal, "nonce", nonceVal, "timestamp", timestampVal, "accountNo", accountNoval) String signature = cn.hutool.crypto.SecureUtil.md5(str);
# 错误码定义
- 1010:此API接口已不再支持
- 2403:余额不足,无法进行操作
- 1800:商家不存在
- 1801:请添加寄件人信息
- 1802:请添加收件人信息
- 1803:请添加物品重量
- 1804:请选择取件时间方式
- 1807:路线规划距离无效
- 1808:路线规划距离为0
- 1809:运费规则不存在
- 1810:运费规则明细不存在
- 3403:开发账号不存在
- 3404:APP_ID不存在
- 3405:APP_SECRET不存在
- 3408:请求头参数缺失
- 3409:请求头nonce格式错误
- 3410:请求头nonce失效
- 3411:请求头timestamp格式错误
- 3412:请求头timestamp失效
- 3400:签名错误
- 1403:请求太快
- 400:错误请求
- 403:禁止访问
- 1999:请求参数异常
- 2000:系统异常,请联系统管理员
- 2001:未知错误
- 2002:请求的数据格式不符
- 2404:禁止重复发单
- -1:操作失败
- 0:操作成功
# 接口简介
订单相关🧾 →