主站对外开放API接口文档,取件模块对接规范,数据回调定义
所有接口需要在Header中携带认证令牌:
Authorization: Bearer {access_token}
微信一键登录,获取用户Token
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| code | string | 是 | 微信授权code |
| encryptedData | string | 否 | encryptedData |
| iv | string | 否 | iv |
获取当前登录用户信息
查询快递包裹信息
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trackingNumber | string | 是 | 快递单号 |
| stationId | string | 否 | 驿站ID(用于验证) |
确认取件(包含签名数据回传)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trackingNumber | string | 是 | 快递单号 |
| pickupCode | string | 是 | 取件码 |
| signatureImage | string | 是 | 签名Base64图片 |
| stationId | string | 是 | 驿站ID |
| userId | string | 是 | 用户ID |
获取用户取件记录
取件成功后获取跳转主站的URL
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| source | string | 是 | 流量来源标识:yz_pickup |
| yz_id | string | 是 | 取件驿站ID |
| user_id | string | 是 | 主站用户ID |
| coupon_template_id | string | 否 | 优惠券ID |
主站响应:主站根据参数自动发放优惠券并跳转到指定落地页
获取代理下的驿站列表
审核驿站入驻申请
获取驿站包裹列表
获取驿站专属取件二维码
| 错误码 | 说明 |
|---|---|
| 1000 | 成功 |
| 1001 | 参数错误 |
| 1002 | 未登录 |
| 1003 | 权限不足 |
| 2001 | 包裹不存在 |
| 2002 | 包裹已取件 |
| 2003 | 取件码错误 |
| 3001 | 驿站不存在 |
| 3002 | 驿站已停用 |