重构接口(暂存)
重构接口(暂存)
已经删除的接口
- /admin
- /admin/partner
- /custommanage/bill
- /admin/partner(只删除了 get 方法,由 /admin/partner/search 替代)
- /finance/index
/admin/partner/search -- 查询合伙人
接口名
/admin/partner/search
描述
查询合伙人
Method
GET
请求
data str O 管理员姓名、用户名
is_valid bool O 状态是否有效,不传的话代表“全部状态”
page int O 页数,缺省0
num int O 每页的数量,缺省20
响应
code M int 返回码,0表示成功,其他表示错误
msg M string 错误信息
station M dict 返回json数据
示例
request
http://localhost:8899/admin/partner/search?is_valid=1&num=20&data=菜头网络
response
{
"data": {
"data": {
"stations": {
"T845": {
"district_code": "371000",
"name": "WH-独立-小农女服务站",
"_id": "T845"
}
}
"partners": {
"1": {
"station": [
{
"id": "T002",
"district_code": "440300",
"name": "SZ-总仓-K10"
}
],
"description": "包括k10、阿米巴、K5、焖锅、虚拟站点",
"manager": 611,
"id": 1,
"is_valid": 1,
"name": "小农女加盟商(深圳)"
},
}
"cities": {
"120000": "天津市"
}
},
"count": 1
},
"code": 0,
"msg": "ok"
}
/custommanage/ (POST) -- 商户管理-店铺查询 (修改了接口名字)
接口名
/custommanage/
描述
商户管理页面、按照条件查询商户
Method
POST
请求
// session
user M string django user object
// post param
kid O string 商户公司账户id
customerName O string 店铺名
sid O string 店铺id
firstMenu O bigint 一级标签
secondMenu O bigint 二级标签
stationMenu O string 站点id
num O int 返回数据量,缺省值为20
page O int 页码,缺省值为1
city O int 城市district_code
crtManager O 开户经理
saleManager O 销售经理
saleMenu O 销售单id
export O 是否导出excel
响应
code M int 返回码、0:成功、其他:失败。
// code=0时候有下列字段
count M int 返回商户数量
data M dict list of map
whitelist M 是否白名单
create_employee_name M 开户经理
addr_detail M 餐馆地址
telephone M 电话
sales_employee_phone M 销售经理电话
create_employee_phone M 开户经理电话
name M 店铺联系人
create_time M 商户注册日期
KID M 商户账户
service_station M 从属站点列表
sales_employee_name M 销售经理
resname M 店铺名
area_l2 M 二级区域
cname M 公司名
area_l1 M 一级区域
username M 登录账号
SID M 店铺id
keycustomer M 是否重点客户
示例
request
http://localhost//custommanage/
post data
kid=&customerName=&sid=&firstMenu=0&secondMenu=0&stationMenu=0&num=20&city=0&crtManeger=0&saleManager=0&salemenu=0
response
{
"data": [
{
"whitelist": 0,
"create_employee_name": "超级管理员",
"addr_detail": "larry here, bite me, ha!",
"telephone": "18675535010",
"sales_employee_phone": "--",
"create_employee_phone": "--",
"name": "larry",
"create_time": "2016-09-29",
"KID": "K029554",
"service_station": [
"测试站点账号"
],
"sales_employee_name": "超级管理员",
"resname": "larry-test",
"area_l2": "测试二级标签",
"cname": "",
"area_l1": "测试一级标签",
"username": "22334455",
"SID": "S024156",
"keycustomer": 0
},
{
"whitelist": 0,
"create_employee_name": "超级管理员",
"addr_detail": "商城街",
"telephone": "18503003832",
"sales_employee_phone": "--",
"create_employee_phone": "--",
"name": "钟其灵",
"create_time": "2016-09-13",
"KID": "K029551",
"service_station": [
"HY-独立-农链农业服务站"
],
"sales_employee_name": "超级管理员",
"resname": "来开饭",
"area_l2": "上城街道办",
"cname": "",
"area_l1": "源城区",
"username": "18503003832",
"SID": "S024155",
"keycustomer": 0
}
],
"code": 0,
"count": 2
}
逻辑
公共逻辑 -- 见查询邀请码
校验view_customer权限
查询
export=1、查询返回excel、否则返回json。字段一致。
返回
/custommanage/bill/search -- 查询商户对账单
接口名
/custommanage/bill/search
描述
查询商户对账单
Method
GET
请求
// session部分
cityValue str O 城市ID,不传代表全部
saleEmployee int O 销售经理,不传代表全部
saleBoss int O 销售组长,不传代表全部
sid str O
name str O
station_id str O 站点ID,不传代表全部
type int M 1表示以「站点id」作为搜索条件,0表示以「销售经理等条件」作为搜索条件
export bool O 是否导出为excel,默认不导出
page int O 页数
num int O 每页条数
响应
code M int 错误码。0为成功、其他为错误。
cout M int 统计数据
data M int 返回信息
示例
request
http://localhost:8899/custommanage/bill/search?cityValue=440300&sid=S000001&station_id=0&type=1&export=0
response
{
"data": {
"data": {
"1": {
"payment_name": "--",
"sale_employee_name": "连腾飞",
"consignee_name": "麦冠裕",
"username": "13928484306",
"payment_telephone": "--",
"pay_method": 1,
"SID": "S000001",
"district_name": "深圳市",
"sale_employee_id": 769,
"district_code": "440300",
"boss_name": "--",
"addr_detail": "南山区桂庙新村69栋1楼(近深圳大学;近学府路、白石路)",
"resname": "煲友",
"early_lack": 22536,
"consignee_phone": "15323722887,18306615533",
"current_lack": 0,
"current_total": 0,
"KID": "K000020"
}
},
"count": 1
},
"msg": "ok",
"code": 0
}
/custommanage/bill/user_meta -- 提供商户对账单下拉菜单需要的数据
接口名
/custommanage/bill/dropdown
描述
提供商户对账单下拉菜单需要的数据
Method
GET
请求
// session部分
响应
sale_employee M dict 销售经理
sale_boss M dict 销售组长
district M list 权限区域信息
station M dict 权限站点信息
示例
request
http://localhost:8899/custommanage/bill/dropdown
response
{
"code": 0,
'data': {
sale_employee: {
"303": {
"name": "赵东涛",
"type": 0,
"district_code": "440300",
"boss_id": 0,
"boss_name": "--"
},
}
sale_boss: {
"8": {
"name": "观麦开放平台",
"district_code": "440300"
},
}
district: [{
"code": "440300",
"name": "深圳市"
}]
station: {
"T1428": {
"name": "分拣比赛专用",
"_id": "T1428",
"district_code": "440300"
},
}
"msg": "ok"
}
以下接口使用了和老接口完全一致的数据结构,返回数据由 HTML 改为 json(详细的字段待补充):
/admin
- /admin/department(只改动了 get 方法)
- /admin/partner/manager(只改动了 get 方法)
- /admin/role(只改动了 get 方法)
- /admin/user(只改动了 get 方法)
/custommanage
- /custommanage/edit(只改动了 get 方法)
- /custommanage/report(只改动了 get 方法)
- /custommanage/report/detail
- /custommanage/saleemployee
/management
- /management/code(只改动了 get 方法)
对接口的其他变动:
/ordermanage/^order$|^order/(search)$|^order/(edit\/PL\d{5,})$|^daily$
/ordermanage/^lkorder$|^lkorder/(search)$|^lkorder/(edit\/LK\d{5,})$
这两个接口的逻辑改动:
- 删除了「当 query 中没有参数的时候返回一个模板」的逻辑