通用
MP API系统目前仅支持订单、流量和警报等功能。
API请求
在所有API中,以下是常见的请求头及其描述:
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| Access-key | string | true | accessKey 为客户端应用身份,跟 secretKey 配套 |
| Content-Type | string | true | application/json |
生成签名
- 签名算法(sign)
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| timestamp | Long | true | 当前时间戳,10位数字 |
| data | Object | true | 参数 |
- 规则:
- 对数组的值按key排序 请求示例:
{"data": {"page": "1","limit": "10"},"timestamp": 1752833996}
- 生成url的形式
data%5Bpage%5D=1&data%5Blimit%5D=10×tamp=1752833996
- MD5算法加密生成sign: 字符串+私钥拼接
sign = md5('data%5Bpage%5D=1&data%5Blimit%5D=10×tamp=1752833996' + secret_key)
请求示例
{
"timestamp": 1752833996,
"data": {
"page": 1,
"limit": 10
},
"sign": "df0a31b6c4b5810c2d8e318247a9ad4f"
}
API响应响应通常遵循以下格式:
{
"code": 200,
"msg": "string",
"data": {}
}
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| code | int | true | 响应码200表示成功 |
| msg | string | true | 响应消息 |
| data | json or null | true | 响应数据 |
响应验证签名
响应的请求头返回签名计算所需的参数。具体步骤请参考:
HTTP code
| 名称 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 认证失败 |
| 403 | 拒绝访问 |
| 404 | 未找到 |
Business code
| 名称 | 描述 |
|---|---|
| 500 | 服务异常 |
| 60001 | 参数缺失 |
| 60002 | 非法参数 |
| 60003 | 数据不存在 |