Appearance
2.1 接口约定
1、 所有接口遵循RESTful风格:
基于URI定位资源
通过http动词操作接口。
除获取Access Token请求以外,所有请求都要添加请求信息头,内容如下:
| name | 是否必须 | 描述 |
|---|---|---|
| Colipu-Token | 必须 | 通过获取access token或者刷新access token接口获取到的token |
- 接口所有返回数据都有一个字段requestId,内容如下:
| name | 描述 |
|---|---|
| requestId | 接口记录网络请求日志的唯一ID |
2、所有返回为Json格式数据,如下:
json
{
"success": 布尔类型,
"errorcode": "错误编码",
"requestId": "请求编号",
"errormsg": "错误描述",
"result": json或数组
}返回结果说明:
| 参数 | 是否必须 | 描述 |
|---|---|---|
| success | 必须 | true或者false,表示接口调用成功与否 |
| errorcode | 必须 | 操作结果返回代码 |
| errormsg | 非必须 | 错误描述,errorcode不为0时,必须 |
| requestId | 必须 | 请求编号,以便于双方排查问题 |
| result | 非必须 | 返回结果,如:[{"sku": 12345”, "price”: 1000},{"sku”: "11111”, price: "1200”}]或{"sku”: "12345”, "num” : 99, "area_id”: "1000000” }等 |