元驿生活服务平台 - API接口文档

主站对外开放API接口文档,取件模块对接规范,数据回调定义

认证说明

所有接口需要在Header中携带认证令牌:

Authorization: Bearer {access_token}

用户相关接口

POST /api/user/login

微信一键登录,获取用户Token

请求参数:

参数类型必填说明
codestring微信授权code
encryptedDatastringencryptedData
ivstringiv
GET /api/user/info

获取当前登录用户信息

取件相关接口

GET /api/pickup/query

查询快递包裹信息

请求参数:

参数类型必填说明
trackingNumberstring快递单号
stationIdstring驿站ID(用于验证)
POST /api/pickup/confirm

确认取件(包含签名数据回传)

请求参数:

参数类型必填说明
trackingNumberstring快递单号
pickupCodestring取件码
signatureImagestring签名Base64图片
stationIdstring驿站ID
userIdstring用户ID
GET /api/pickup/records

获取用户取件记录

引流跳转接口

GET /api/pickup/getJumpUrl

取件成功后获取跳转主站的URL

请求参数:

参数类型必填说明
sourcestring流量来源标识:yz_pickup
yz_idstring取件驿站ID
user_idstring主站用户ID
coupon_template_idstring优惠券ID

主站响应:主站根据参数自动发放优惠券并跳转到指定落地页

代理/驿站相关接口

GET /api/agent/stations

获取代理下的驿站列表

POST /api/agent/approve

审核驿站入驻申请

GET /api/station/packages

获取驿站包裹列表

GET /api/station/qrcode

获取驿站专属取件二维码

错误码说明

错误码说明
1000成功
1001参数错误
1002未登录
1003权限不足
2001包裹不存在
2002包裹已取件
2003取件码错误
3001驿站不存在
3002驿站已停用