【经验分享】电商项目接口文档：搭建电商商城系统API接口

1. 电商管理后台 API 接口文档

1.1. API V1 接口说明

• 接口基准地址：http://127.0.0.1:8888/api/private/v1/
• 服务端已开启 CORS 跨域支持
• API V1 认证统一使用 Token 认证
• 需要授权的 API ，必须在请求头中使用 Authorization 字段提供 token 令牌
• 使用 HTTP Status Code 标识状态
• 数据返回格式统一使用 JSON

1.1.1. 支持的请求方法

• GET（SELECT）：从服务器取出资源（一项或多项）。
• POST（CREATE）：在服务器新建一个资源。
• PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
• PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
• DELETE（DELETE）：从服务器删除资源。
• HEAD：获取资源的元数据。
• OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

1.1.2参数说明

公共参数

请求地址: 电商API数据采集接口

名称	类型	必须	描述
key	String	是	调用key（必须以GET方式拼接在URL中）
secret	String	是	调用密钥
api_name	String	是	API接口名称（包括在请求地址中）[item_search,item_get,item_search_shop等]
cache	String	否	[yes,no]默认yes，将调用缓存的数据，速度比较快
result_type	String	否	[json,jsonu,xml,serialize,var_export]返回数据格式，默认为json，jsonu输出的内容中文可以直接阅读
lang	String	否	[cn,en,ru]翻译语言，默认cn简体中文
version	String	否	API版本

请求参数

请求参数：num_iid=10335871600

参数说明：num_iid:JD商品ID

响应参数

Version: Date:

名称	类型	必须	示例值	描述
item	item[]	0		获得JD商品详情

API的应用