元仓开放平台
首页
元仓客户端
元仓开放平台
目录
开发者必读
授权
基础资料
商品
入库
订单
库存
换单
退货
订阅
Powered by Apifox

对接说明

开发信息#

测试环境接口地址:https://test.api.yc-client.anestcang.com

正式环境接口地址:https://api.yc-client.anestcang.com

测试密钥

  • appKey: yc_u8VtWSYfwX4SCDeHsIcndKm7c
  • appSecret: APUR2io8WqhhhUysbilo4E0yeUcC

正式密钥 请到元仓客户端下用户中心->开发者信息下查看
image.png

请求说明#

  • 除了授权接口无需传递header,其余接口需传递header的传输示例如下:
    Authorization : Bearer 980|t7yNjmZK4F73dyHB0Rk1tL9KJZ6Abncl4n5nGOF8

数据返回结构#

  1. 非分页结构
{
    "state": "000001",
    "msg": "注销成功",
    "data": []
}
  • state 状态码
  • msg 信息描述
  • data 返回数据
  1. 分页结构
{
    "state": "000001",
    "msg": "请求成功",
    "data": {
        "list": [
            {
                "id": 5,
                "channelName": "LGS-挂号",
                "channelCode": "Y7002S",
                "status": 1,
                "labelSize": 1,
                "maxWeigh": 1000,
                "channelType": 1,
                "platformCode": [
                    "SE"
                ]
            }
        ],
        "total": 19,
        "page": 1,
        "prePage": 10
    }
}
  • state 状态码
  • msg 信息描述
  • data 返回数据
  • data.list 具体数据内容
  • data.page 当前页 默认第1页
  • data.total 数据总记录数
  • data.prePage 每页条数 默认15条

ps: 每页条数不能大于100条 ,页数不能大于2000

状态码#

状态码描述
000001成功
000400请求失败,详细见描述(msg)
000401鉴权失败 (token已过期或者token无效)
000403无权限访问
000405请求方法不允许
000422请求数据异常
000429请求太频繁
000500程序内部错误
011xxx订单相关
012xxx入库相关
013xxx商品相关
014xxx换单相关
015xxx退货相关

000开头为系统全局状态码,目前我们提供业务模块的状态码比较少,有需要可以联系我们添加

接口频率#

  • 一个开发者账号每1分钟限制300次请求. 超过次数则响应state为000429
  • header 响应 参数如下 X-Ratelimit-Limit (限制次数), X-Ratelimit-Remaining(剩余次数)。

订阅说明#

  • 提交订阅信息
    请到元仓客户端下用户中心->开发者信息提交订阅地址和勾选订阅的消息。

image.png

  • 推送消息的格式如下
POST /example/uri HTTP/1.1
Host: www.example.com
Content-Type: application/json
Content-Length: 1238
Authorization: 8947b18cf1b62e3196109a6a008f28d5
#消息体 json
{"data":{"for":"bar"},"requestId":"1c408a05-32d0-4919-aebf-d8aa21a63991","timestamp":1668158845,"msgType":"IN_ORDER","appKey":"yc_u8VtWSYfwX4SCDeHsIcndKm7c"}
  • 签名逻辑
Authorization :MD5(消息体+appSecret)  32位[小]
  • 响应
{
    "state": "000001",
    "msg": "接收成功"
}
状态码描述
000001成功
000400请求失败
000500程序内部错误
  • 重试
    系统会根据未正常返回000001的响应做重试,重试次数10次

  • 唯一性
    requestId 作为消息唯一

  • 详细接口说明
    参见接口 订阅 模块,可以通过签名推送测试,模拟测试消息推送。

开发信息
请求说明
数据返回结构
状态码
接口频率
订阅说明
Apifox当前文档由 Apifox 生成
举报