登录 | 注册

接口清单
调用流程
用户类接口
商户类接口
消费者接口
平台接口

接口清单

接口说明

我们只梳理了比较重要的接口协议，其他如果需要请自行查看代码梳理协议

接口清单

接口名称调用地址调用方式实现方式
用户注册https://api.Qshop.com/v1/User/POSTDjango DRF
用户查询https://api.Qshop.com/v1/User/GETDjango DRF
密码修改https://api.Qshop.com/v1/User/int:id/PUTDjango DRF
账号注销https://api.Qshop.com/v1/User/int:id/DELETEDjango DRF
用户详情注册https://api.Qshop.com/v1/UserInfo/POSTDjango DRF
用户详情修改https://api.Qshop.com/v1/UserInfo/PUTDjango DRF
用户详情查询https://api.Qshop.com/v1UserInfo/GETDjango DRF
用户登录https://api.Qshop.com//v1/Auth/POSTDjango DRF
用户退出https://api.Qshop.com/v1/Auth/GETDjango DRF
店铺注册https://api.Qshop.com/v1/Store/POSTDjango DRF
店铺注销https://api.Qshop.com/v1/Store/int:id/DELETEDjango DRF
店铺信息修改https://api.Qshop.com/v1/Store/int:id/PUTDjango DRF
店铺信息查询https://api.Qshop.com/v1/Store/GETDjango DRF
商品添加https://api.Qshop.com/v1/Goods/POSTDjango DRF
商品删除https://api.Qshop.com/v1/Goods/DELETEDjango DRF
商品下架https://api.Qshop.com/v1/Goods/PATCHDjango DRF
商品修改https://api.Qshop.com/v1/Goods/PUTDjango DRF
商品查询https://api.Qshop.com/v1/Goods/GETDjango DRF
店铺进货统计https://api.Qshop.com/v1/Statistics/Stock/GETDjango DRF
店铺盈利统计https://api.Qshop.com/v1/Statistics/Profit/GETDjango DRF
店铺热销统计https://api.Qshop.com/v1/Statistics/Hot/GETDjango DRF
店铺订单处理https://api.Qshop.com/v1/Order/PATCHDjango DRF
收货地址注册https://api.Qshop.com/v1/Address/POSTDjango DRF
收货地址删除https://api.Qshop.com/v1/Address/DELETEDjango DRF
收货地址修改https://api.Qshop.com/v1/Address/PUTDjango DRF
收货地址查询https://api.Qshop.com/v1/Address/GETDjango DRF
加入购物车https://api.Qshop.com/v1/Car/POSTDjango DRF
删除购物车https://api.Qshop.com/v1/Car/DELETEDjango DRF
修改购物车https://api.Qshop.com/v1/Car/PUTDjango DRF
查询购物车https://api.Qshop.com/v1/Car/GETDjango DRF
订单生成https://api.Qshop.com/v1/Order/POSTDjango DRF
订单查询https://api.Qshop.com/v1/Order/GETDjango DRF
订单修改https://api.Qshop.com/v1/Order/PUTDjango DRF
撤销订单https://api.Qshop.com/v1/Order/DELETEDjango DRF
发表商品评论https://api.Qshop.com/v1/Comment/POSTDjango DRF
删除商品评论https://api.Qshop.com/v1/Comment/DELETDjango DRF
修改商品评论https://api.Qshop.com/v1/Comment/PUTDjango DRF
查询商品评论https://api.Qshop.com/v1/Comment/GETDjango DRF
投诉建议https://api.Qshop.com/v1/Advise/POSTDjango DRF
回复投诉建议https://api.Qshop.com/v1/Advise/PUTDjango DRF
查询投诉建议https://api.Qshop.com/v1/Advise/GETDjango DRF
店铺注销审核https://api.Qshop.com/v1/Admin/StoreOrder/PATCHDjango DRF

调用流程

接口接入

1.登录易果开发者平台

登录易果开发者平台(https://develp.Qshop.com)，注册账号

2.创建应用，获取app_id

image-20200827113949712

image-20200827114006069

接口调用流程

1.接口网关

开发网关地址 （https://api.Qshop.com/v1/）

测试网关地址（https://api.Qshop.com/t/）

2.常用参数
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
3. 举例

URL POST https://api.Qshop.com/Auth/

pidfile=/opt/script/uwsgi.pid

http=192.168.2.69:8000 #指定IP端口

请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
	"username": "admin",
	"password": "123456"
}
响应报文
{
	"code": 200,
	"data": {
		"token": "kaflj32oicoac4lsms35alkf"
	}
}
4. 请求案例
import requests

url = "https://api.Qshop.com/v1/User/"

headers = {
	Content-Type: applicatiton/json
}

data = {
	"APP_ID": "8000418002",
	"REQ_TIME" "20201113225612",
	"SIGN":"aabdncdhdbd878sbdudn898",
	"username": "admin"
	"password": "123456"
}

response = requests.post(url = url,headers = headers,data = data)

result = reponse.json

 

用户类接口

说明

用户类结构一共包括：用户注册、用户查询、密码修改 、账号注销、用户详情注册、用户详情修改、用户详情查询 七个功能，负责整个项目的用户管理

用户注册

接口功能

用户注册

URL

https://api.Qshop.com/v1/User/

支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
username1string32用户名用户名不可以以数字开头
password1string32密码密码必须有大小写字母或者字母数字
返回数据

数据格式z

{
	"code": "200",
	"data": {
		"admin"
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
	"username": "admin",
	"password": "123456"
}
响应报文
{
	"code": 200,
	"data": {
		"token": "kaflj32oicoac4lsms35alkf"
	}
}

 

用户查询

接口功能

用户查询

URL
路由描述
https://api.Qshop.com/v1/User/查询所有用户
https://api.Qshop.com/v1/User/1/查询id为1的用户
https://api.Qshop.com/v1/User/?username=admin查询用户名为admin的用户
https://api.Qshop.com/v1/User/?username=admin&password=123456查询用户名为admin密码为123456的用户
支持格式

JSON

HTTP请求方式

GET

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string-校验数据平台下发
返回数据

数据格式

{
	"code": "200",
	"data": [
		{"uername": "admin"}
	]
}

 

状态码描述
200查询成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
token:aabdncdhdbd878sbdudn898
请求报文：
{
	"username": "admin",
	"password": "123456"
}
响应报文
{
	"code": 200,
	"data": [
		{"uername": "admin"}
	]
}

1

密码修改

接口功能

密码修改

URL
路由描述
https://api.Qshop.com/v1/User/1/修改id为1的用户的密码
支持格式

JSON

HTTP请求方式

PUT

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string-校验数据平台下发
password1string32修改的密码密码需要是数字字母或者大小写字母混合
返回数据

数据格式

{
	"code": "200",
	"data": {
		"uername": "admin"
	}
}

 

状态码描述
200修改成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
token:aabdncdhdbd878sbdudn898
请求报文：
{
	"token": "5qe6sd3dasdasdasd4a",
	"password": "123456"
}
响应报文
{
	"code": 200,
	"data": {"uername": "admin"}
}

账号注销

接口功能

退出登陆

URL
路由描述
https://api.Qshop.com/v1/User/1/id为1的用户退出登陆
支持格式

JSON

HTTP请求方式

DELETE

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string-校验数据平台下发
返回数据

数据格式

{
	"code": "200",
	"data": {
	}
}

 

状态码描述
200退出成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
token:aabdncdhdbd878sbdudn898
请求报文：
{
	"token": "5qe6sd3dasdasdasd4a",
}
响应报文
{
	"code": 200,
	"data": {}
}

用户详情注册

接口功能

完善用户详情

URL

https://api.Qshop.com/v1/UserInfo/1/

支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string32用户名用户名不可以以数字开头
nick_name1string32密码密码必须有大小写字母或者字母数字
gender1string32性别-
age1int18<=age年龄注册需要进行实名认真，所以需要age>=18
photo1filesize<5M头像头像大小必须小于5M
phone1string11电话中国手机号
email1string64邮件邮件格式必须正确
u_address1text-地址这里是用户的注册地址，和收货地址可以不一样
返回数据

数据格式

{
	"code": "200",
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
		"token": 5qe6sd3dasdasdasd4a"
	}
响应报文
{
	"code": 200,
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}

用户详情修改

接口功能

修改用户详情

URL

https://api.Qshop.com/v1/UserInfo/1/

支持格式

JSON

HTTP请求方式

PUT

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string32用户名用户名不可以以数字开头
nick_name1string32密码密码必须有大小写字母或者字母数字
gender1string32性别-
age1int18<=age年龄注册需要进行实名认真，所以需要age>=18
photo1filesize<5M头像头像大小必须小于5M
phone1string11电话中国手机号
email1string64邮件邮件格式必须正确
u_address1text-地址这里是用户的注册地址，和收货地址可以不一样
返回数据

数据格式

{
	"code": "200",
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
		"token": "5qe6sd3dasdasdasd4a"
	}
响应报文
{
	"code": 200,
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}

用户详情查询

接口功能

查询用户详情

URL
路由描述
https://api.Qshop.com/v1/UserInfo/查询所有用户的详情
https://api.Qshop.com/v1/UserInfo/1/查询id为1的用户的详情
https://api.Qshop.com/v1/UserInfo/?gender=男&phone=13331153360查询性别是男电话号为13331153360的用户详情
支持格式

JSON

HTTP请求方式

GET

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
token1string32用户名用户名不可以以数字开头
nick_name1string32密码密码必须有大小写字母或者字母数字
gender1string32性别-
age1int18<=age年龄注册需要进行实名认真，所以需要age>=18
photo1filesize<5M头像头像大小必须小于5M
phone1string11电话中国手机号
email1string64邮件邮件格式必须正确
u_address1text-地址这里是用户的注册地址，和收货地址可以不一样
返回数据

数据格式

{
	"code": "200",
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"nick_name": "管理员",
		"gender": "男",
		"age": 18,
		"photo": "1.jpg",
		"phone": "13331153360",
		"email": "admin@qq.com",
		"u_address": "北京市朝阳区五方桥"
	}
}

1

商户类接口

说明

商户类接口主要有店铺注册、店铺注销、店铺信息修改、店铺信息查询、商品添加、商品删除、商品下架、商品修改、商品查询、店铺进货统计、店铺盈利统计、店铺热销统计、店铺订单处理十三个功能组成，负责商户对店铺的管理和数据分析

店铺注册

接口功能

已经注册成为平台用户的账号申请店铺

URL

https://api.Qshop.com/v1/Store/

支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
s_name1String32店铺名称敏感词审核
参数名称约束类型长度描述取值说明
s_logo1file-店铺logo<= 5M
s_phone1String32店铺电话中国格式电话
s_address1Text-店铺地址-
s_description1Text-店铺描述-
s_user1Int-店铺用户-
token1String30校验必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"s_name": "辣条铺子",
		"s_logo": "2.jpg",
		"s_phone": 13331153360,
		"s_address": "北京昌平",
		"s_description": "做良心辣条",
		"s_user": 1,
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"s_name": "辣条铺子",
	"s_logo": "2.jpg",
	"s_phone": 13331153360,
	"s_address": "北京昌平",
	"s_description": "做良心辣条",
	"s_user": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"s_name": "辣条铺子",
		"s_logo": "2.jpg",
		"s_phone": 13331153360,
		"s_address": "北京昌平",
		"s_description": "做良心辣条",
		"s_user": 1
	}
}

店铺注销

接口功能

取消开店功能

URL

https://api.Qshop.com/v1/Store/1/

支持格式

JSON

HTTP请求方式

PATCH

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
Store_id1String32店铺名称敏感词审核
token1file-店铺logo<= 5M
返回数据

数据格式

{
	"code": "200",
	"data": {
		"result": "修改成功"
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"store_id": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"result": "修改成功"
	}
}

店铺信息修改

接口功能

修改店铺logo等详情

URL

https://api.Qshop.com/v1/Store/1/

支持格式

JSON

HTTP请求方式

PUT

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
s_name1String32店铺名称敏感词审核
s_logo1file-店铺logo<= 5M
s_phone1String32店铺电话中国格式电话
s_address1Text-店铺地址-
s_description1Text-店铺描述-
s_user1Int-店铺用户-
token1String30校验必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"s_name": "辣条铺子",
		"s_logo": "2.jpg",
		"s_phone": 13331153360,
		"s_address": "北京昌平",
		"s_description": "做良心辣条",
		"s_user": 1,
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"s_name": "辣条铺子",
	"s_logo": "2.jpg",
	"s_phone": 13331153360,
	"s_address": "北京昌平",
	"s_description": "做良心辣条",
	"s_user": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"s_name": "辣条铺子",
		"s_logo": "2.jpg",
		"s_phone": 13331153360,
		"s_address": "北京昌平",
		"s_description": "做良心辣条",
		"s_user": 1
	}
}

店铺信息查询

接口功能

店铺信息查询

URL
URL描述
https://api.Qshop.com/v1/Store/查询所有店铺
https://api.Qshop.com/v1/Store/1/查询id为1的店铺
https://api.Qshop.com/v1/Store/?s_address=北京查询所有地址在北京的店铺
支持格式

JSON

HTTP请求方式

GET

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
token1String30校验必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"s_name": "辣条铺子",
		"s_logo": "2.jpg",
		"s_phone": 13331153360,
		"s_address": "北京昌平",
		"s_description": "做良心辣条",
		"s_user": 1,
	}
}

 

状态码描述
200查询成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"s_name": "辣条铺子",
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"s_name": "辣条铺子",
		"s_logo": "2.jpg",
		"s_phone": 13331153360,
		"s_address": "北京昌平",
		"s_description": "做良心辣条",
		"s_user": 1
	}
}

 

商品添加

接口功能

店铺购进商品（必须是店主权限）

URL

https://api.Qshop.com/v1/Goods/

支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
token1String30校验必须校验通过才可以注册店铺
g_name1String32商品名称不得含有敏感词
price1Float-商品价格-
g_count1Int-商品数量-
g_picture1File-商品图片-
public_time1DataYYYY-MM-DD生产日期-
g_description1Text-商品描述-
g_introduce1Text-商品介绍-
g_address1Text-商品产地-
g_type1Int-商品类型外键 商品类型 id
g_store1Int-商品店铺外键 商品店铺 id
返回数据

数据格式

{
	"code": "200",
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
	}
}

 

状态码描述
200查询成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"g_name": "辣条",
	"price": 6.5,
	"g_count": 100,
	"g_picture": "1.jpg",
	"public_time": "2020-02-10",
	"g_description": "有点辣",
	"g_introduce": "超级辣",
	"g_address": "北京昌平",
	"g_type": 1,
	"g_store": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
	}
}

 

商品删除

接口功能

商品删除（从平台清空，不可再现）

URL

https://api.Qshop.com/v1/Goods/1/

支持格式

JSON

HTTP请求方式

DELETE

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
token1String30校验必须校验通过才可以注册店铺
g_id1Int-商品id-
返回数据

数据格式

{
	"code": "200",
	"data": {
	}
}

 

状态码描述
200查询成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"g_id": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
	}
}

 

商品下架

接口功能

商品下架（可再现）

URL

https://api.Qshop.com/v1/Goods/1/

支持格式

JSON

HTTP请求方式

PATCH

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
token1String30校验必须校验通过才可以注册店铺
g_id1Int-商品id-
返回数据

数据格式

{
	"code": "200",
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
		"statue": ”已经下架“
	}
}

 

状态码描述
200查询成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"g_id": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
		"statue": ”已经下架“
	}
}

商品修改

接口功能

店铺购进商品（必须是店主权限）

URL

https://api.Qshop.com/v1/Goods/1/

支持格式

JSON

HTTP请求方式

PUT

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
token1String30校验必须校验通过才可以注册店铺
g_name1String32商品名称不得含有敏感词
price1Float-商品价格-
g_count1Int-商品数量-
g_picture1File-商品图片-
public_time1DataYYYY-MM-DD生产日期-
g_description1Text-商品描述-
g_introduce1Text-商品介绍-
g_address1Text-商品产地-
g_type1Int-商品类型外键 商品类型 id
g_store1Int-商品店铺外键 商品店铺 id
返回数据

数据格式

{
	"code": "200",
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
	}
}

 

状态码描述
200查询成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"g_name": "辣条",
	"price": 6.5,
	"g_count": 100,
	"g_picture": "1.jpg",
	"public_time": "2020-02-10",
	"g_description": "有点辣",
	"g_introduce": "超级辣",
	"g_address": "北京昌平",
	"g_type": 1,
	"g_store": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
	}
}

商品查询

接口功能

店铺购进商品（必须是店主权限）

URL
URL描述
https://api.Qshop.com/v1/Goods/查询所有商品
https://api.Qshop.com/v1/Goods/1/查询id为1的商品
https://api.Qshop.com/v1/Goods/?g_price=11.5查询价格为11.5的商品
支持格式

JSON

HTTP请求方式

POST

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
token1String30校验必须校验通过才可以注册店铺
g_name1String32商品名称不得含有敏感词
price1Float-商品价格-
g_count1Int-商品数量-
g_picture1File-商品图片-
public_time1DataYYYY-MM-DD生产日期-
g_description1Text-商品描述-
g_introduce1Text-商品介绍-
g_address1Text-商品产地-
g_type1Int-商品类型外键 商品类型 id
g_store1Int-商品店铺外键 商品店铺 id
返回数据

数据格式

{
	"code": "200",
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
	}
}

 

状态码描述
200查询成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{		
	"g_name": "辣条",
	"price": 6.5,
	"g_count": 100,
	"g_picture": "1.jpg",
	"public_time": "2020-02-10",
	"g_description": "有点辣",
	"g_introduce": "超级辣",
	"g_address": "北京昌平",
	"g_type": 1,
	"g_store": 1,
    "token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"g_name": "辣条",
		"price": 6.5,
		"g_count": 100,
		"g_picture": "1.jpg",
		"public_time": "2020-02-10",
		"g_description": "有点辣",
		"g_introduce": "超级辣",
		"g_address": "北京昌平",
		"g_type": 1,
		"g_store": 1,
	}
}

消费者接口

说明

用户类结构一共包括：收货地址，购物车，订单，商品评论四个功能，负责整个项目的用户管理

收货地址

接口功能

用户注册

URL
URL请求方式描述
https://api.Qshop.com/v1/Address/GET获取所有地址
https://api.Qshop.com/v1/Address/?user_id=1GET获取用户1的地址
https://api.Qshop.com/v1/Address/1/GET获取id为1的地址
https://api.Qshop.com/v1/Address/POST注册地址
https://api.Qshop.com/v1/Address/1/PUT修改地址
https://api.Qshop.com/v1/Address/1/DELETE删除地址
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
address1String32地址用户名不可以以数字开头
recver1String32收货人密码必须有大小写字母或者字母数字
phone1String11电话中国电话
sender1Int-发送人外键
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"address":"北京市昌平区沙河镇",
		"recver":"老张",
		"phone":"13331153360",
		"sender":"老王",
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"address":"北京市昌平区沙河镇",
		"recver":"老张",
		"phone":"13331153360",
		"sender":"老王",
		"token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"address":"北京市昌平区沙河镇",
		"recver":"老张",
		"phone":"13331153360",
		"sender":"老王",
	}
}

 

购物车

接口功能

购物车功能

URL
URL请求方式描述
https://api.Qshop.com/v1/BuyCar/GET获取所有购物车信息
https://api.Qshop.com/v1/BuyCar/?user_id=1GET获取用户1的购物车信息
https://api.Qshop.com/v1/BuyCar/1/GET获取id为1的购物车信息
https://api.Qshop.com/v1/BuyCar/POST添加购物车信息
https://api.Qshop.com/v1/BuyCar/1/PUT修改购物车信息
https://api.Qshop.com/v1/BuyCar/1/DELETE删除购物车信息
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
goods_id1Int-商品id外键
goods_count1Int-商品数量>=0
goods_total1Float-价格-
goods_store1Int-商品店铺外键
car_user1Int-购物人外键
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"goods_id": 1,
		"goods_count": 22,
		"goods_total": 22.1,
		"goods_store": 1,
		"car_user":1,
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"goods_id": 1,
		"goods_count": 22,
		"goods_total": 22.1,
		"goods_store": 1,
		"car_user":1,
		"token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"goods_id": 1,
		"goods_count": 22,
		"goods_total": 22.1,
		"goods_store": 1,
		"car_user":1,
	}
}

 

订单处理

接口功能

购物车功能

URL
URL请求方式描述
https://api.Qshop.com/v1/Order/user_id/GET订单查询
https://api.Qshop.com/v1/Order/user_id/PUT修改订单
https://api.Qshop.com/v1/Order/user_id/GET删除订单
https://api.Qshop.com/v1/Order/user_id/POST提交订单
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
order_id1Int-商品id外键
order_count1Int-商品种类>=0
order_total1Float-订单总价-
freight_total1Float-运费可以为0
order_user1Int-购物人外键
token1String30校验身份必须校验通过才可以注册店铺

 

参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
goods_id1Int-商品id外键
goods_count1Int-订单商品数量>=0
goods_total1Float-订单总价-
freight1Float-运费可以为0
goods_store1Int-购物人外键
orders1Int 订单编号外键
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"order_id": 1,
		"order_count": 22,
		"order_total": 22.1,
		"freight_store": 1,
		"order_user":1,
		"order_info":[
			{
				"goods_id": 1,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			},
			{
				"goods_id": 2,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			},
			{
				"goods_id": 3,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			}
		]
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"order_id": 1,
		"order_count": 22,
		"order_total": 22.1,
		"freight_store": 1,
		"order_user":1,
		"order_info":[
			{
				"goods_id": 1,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			},
			{
				"goods_id": 2,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			},
			{
				"goods_id": 3,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			}
		]
	}
响应报文
{
	"code": "200",
	"data": {
		"order_id": 1,
		"order_count": 22,
		"order_total": 22.1,
		"freight_store": 1,
		"order_user":1,
		"order_info":[
			{
				"goods_id": 1,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			},
			{
				"goods_id": 2,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			},
			{
				"goods_id": 3,
				"goods_count": 20,
				"goods_total": 11.0,
				"freight": "0.5",
				"goods_store": 1
			}
		]
	}
}

评论

接口功能

商品功能

URL
URL请求方式描述
https://api.Qshop.com/v1/Comment/GET获取评论
https://api.Qshop.com/v1/Comment/PUT修改评论
https://api.Qshop.com/v1/Comment/DELETE删除评论
https://api.Qshop.com/v1/Comment/POST发表评论
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
comment_content1Text-评论文本
comment_time1DateTime-评论时间购买后可以发表评论
user_id1Int-用户id外键
goods_id1Int-商品id外键
store_id1Int-商品店铺外键
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"comment_content": "价格公道，服务良好",
		"comment_time": "1998-02-01 12:21:12",
		"user_id": 1,
		"goods_id": 1,
		"store_id":1,
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"comment_content": "价格公道，服务良好",
		"comment_time": "1998-02-01 12:21:12",
		"user_id": 1,
		"goods_id": 1,
		"store_id":1,
		"token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"comment_content": "价格公道，服务良好",
		"comment_time": "1998-02-01 12:21:12",
		"user_id": 1,
		"goods_id": 1,
		"store_id":1,
	}
}

 

平台接口

投诉建议

接口功能

商品功能

URL
URL请求方式描述
https://api.Qshop.com/v1/Advice/GET获取投诉
https://api.Qshop.com/v1/Advice/PUT回复投诉
https://api.Qshop.com/v1/Advice/DELETE撤销投诉
https://api.Qshop.com/v1/Advice/POST发起投诉
支持格式

JSON

请求参数header部分
参数名称参数值
content-Typeapplication/json
请求参数body部分
参数名称约束类型长度描述取值说明
app_id1String36应用ID通过添加应用生成
sign1String-签名请参考签名说明
req_time1String-请求时间YYYY-MM-DD
a_content1Text-投诉内容文本
a_time1DateTime-投诉时间购买后可以发表评论
user_id1Int-投诉人外键
goods_id1Int-投诉商品id外键 可以为空
store_id1Int-投诉店铺外键 可以为空
token1String30校验身份必须校验通过才可以注册店铺
返回数据

数据格式

{
	"code": "200",
	"data": {
		"a_content": "申请退款",
		"a_time": "1998-02-01 21:11:13",
		"user_id": 1,
		"goods_id": 1,
		"store_id":1,
	}
}

 

状态码描述
200注册成功
400数据没有找到
404请求路由没有找到
500视图逻辑错误
502视图数据库查询错误
举例
请求头信息：
Content-Type:application/json
APP_ID:8000418002
REQ_TIME:20201113225612
SIGN:aabdncdhdbd878sbdudn898
请求报文：
{
		"a_content": "申请退款",
		"a_time": "1998-02-01 21:11:13",
		"user_id": 1,
		"goods_id": 1,
		"store_id":1,
		"token": "5qe6sd3dasdasdasd4a"
}
响应报文
{
	"code": 200,
	"data": {
		"a_content": "申请退款",
		"a_time": "1998-02-01 21:11:13",
		"user_id": 1,
		"goods_id": 1,
		"store_id":1,
	}
}

服务电话:

Copyright©1999- 北京中公教育科技有限公司 .All Rights Reserved 京ICP备10218183号-88
京ICP证161188号 京公网安备11010802020723号 投诉建议：400-650-7353