商户平台对接接口文档
# 文档概述
本文档详细描述了电商平台与商户系统之间的接口规范,用于实现商品信息、订单数据、库存同步等功能。通过这些接口,商户可以实现以下核心功能:
- 商品管理:上传、更新、删除商品信息
- 库存管理:实时同步库存数据
- 订单管理:接收订单通知、更新订单状态
- 配送管理:管理骑手配送信息
# 接口规范
# 基本信息
- 基础URL:
https://api.example.com/v1 - 数据格式: 所有接口采用JSON格式进行数据交换
- 字符编码: UTF-8
- 请求方式: 主要使用POST和GET方法
- 状态码: 遵循HTTP标准状态码
# 认证方式
所有接口均需要进行身份验证,采用OAuth 2.0授权框架。
- 获取访问令牌
code
POST /oauth/token
请求参数:
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| client_id | String | 是 | 商户ID,平台分配 |
| client_secret | String | 是 | 商户密钥,平台分配 |
| grant_type | String | 是 | 固定值:"client_credentials" |
响应示例:
json
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 7200
}
- 使用访问令牌
在所有API请求的Header中添加:
code
Authorization: Bearer {access_token}
# 通用响应格式
json
{
"code": 200, // 状态码,200表示成功
"message": "success", // 状态描述
"data": { // 响应数据
// 具体数据内容
},
"timestamp": 1623123456789 // 时间戳
}
# 错误码说明
| 错误码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数错误 |
| 401 | 未授权或授权失败 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 500 | 服务器内部错误 |
| 1001 | 商品不存在 |
| 1002 | 库存不足 |
| 1003 | 订单状态错误 |