网络引流系统前后端大数据交互接口设计.docx
- 文档编号:14888181
- 上传时间:2023-06-28
- 格式:DOCX
- 页数:75
- 大小:124.10KB
网络引流系统前后端大数据交互接口设计.docx
《网络引流系统前后端大数据交互接口设计.docx》由会员分享,可在线阅读,更多相关《网络引流系统前后端大数据交互接口设计.docx(75页珍藏版)》请在冰点文库上搜索。
网络引流系统前后端大数据交互接口设计
网络引流系统前后端数据交互接口设计
网络引流系统采用前后端完全解耦的方式进展写作开发,前端主要责任是实现跟用户之间的界面交互,后台的主要责任是进展业务逻辑的处理与业务数据的持久化,前后端通过协议进展数据交互实现系统的整体联动。
根据用户交互界面,前后端交互接口如下:
注:
接口引用中base_url为系统项目管理平台的部署入口URL。
登录
接口URL:
base_url/login
交互方式:
POSTJSON
交互参数:
单层JSON格式
参数名称
参数说明
备注
username
用户名
必须提供此参数
passwd
密码
必须提供此参数,前端对用户输入数据先进性MD5加密,传入的参数是MD5加密后的字符串
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
登录失败;1:
成功
‘msg’:
’xxxxxx’,//消息,失败原因,用户名密码错误或者是系统内部错误
‘username’:
’xxxxxx’//登录用户名
}
退出
接口URL:
base_url/logout
交互方式:
GET
交互参数:
无
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
登录失败;1:
成功
‘msg’:
’xxxxxx’//消息,失败原因,用户名密码错误或者是系统内部错误
}
加载渠道列表
接口URL:
base_url/channel/list
交互方式:
POSTJSON
交互参数:
单层JSON格式
参数名称
参数说明
备注
page
当前页
如未提供此参数,默认为0
pagesize
每页记录数
如未提供此参数,默认全部
name
渠道名称模糊查询条件
如未提供此参数,如此查询所有的数据,否如此模糊匹配符合条件的记录
sortcol
排序字段
如未提供此参数,默认用创建时间降序排序
descsort
降序排序
此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否如此降序排序,此参数值为true或者false
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{渠道数据}]//渠道数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
渠道数据中,需要一个额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:
名称、创建时间、状态
1编辑渠道
接口URL:
base_url/channel/edit
交互方式:
POSTJSON
交互参数:
复杂JSON格式
{
‘id’:
xxxx,//ID,新增渠道时,ID为空
‘code’:
xxxx,//代码
‘name’:
xxxx,//名称
‘remark’:
xxxx,//说明
‘level’:
xxxx,//等级
‘feature’:
xxxx,//特性
‘state’:
xxxx,//状态
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
‘props’:
[
{
‘id’:
xxxxx,//属性ID,新增的属性,ID为空
‘code’:
xxxx,//属性代码
‘name’:
xxxxx,//属性名称
‘value’:
xxxx,//属性值
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
},
……//其他属性
]
}
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
}
注:
渠道特性来源于属性模板表,属性模板表里的类别为“channel_feature_props_tmpl〞的属性列表即为渠道特性选项列表。
属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。
另外,有模板id的,如果模板上定义的属性是不可删除的,如此这条属性是不能删除的,界面上对应的属性不需要删除按钮与操作,后台也不能删除此属性,如果模板定义的属性是必填的,如此这条属性的值不能为空,前端后端就要进展验证。
加载渠道属性
接口URL:
base_url/channel/props/{id}
交互方式:
RESTFul
交互参数:
渠道记录ID,直接包含在URL中,{id}即为渠道记录ID,以get的方式交互
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{渠道属性数据}]//渠道属性数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
渠道属性数据中,需要额外的字段,可删除、必填,字段数据来源于属性模板表。
属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。
另外,有模板id的,如果是不可删除的,如此这条属性是不能删除的,界面上对应的属性不需要删除按钮与操作,后台也不能删除此属性,如果是必填的,如此这条属性的值不能为空,前端后端就要进展验证。
渠道属性模板的类别为channel_props_tmpl。
加载渠道营销活动
接口URL:
base_url/campaign/list/{id}
交互方式:
RESTFulPOSTJSON
交互参数:
渠道记录ID包含在URL中,{id}即为渠道记录ID,单层JSON格式
参数名称
参数说明
备注
page
当前页
如未提供此参数,默认为0
pagesize
每页记录数
如未提供此参数,默认全部
name
名称或关键字模糊查询条件
如未提供此参数,如此查询所有的数据,否如此模糊匹配符合条件的记录
sortcol
排序字段
如未提供此参数,默认用创建时间降序排序
descsort
降序排序
此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否如此降序排序,此参数值为true或者false
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{营销活动数据}]//营销活动数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
营销活动数据字段
字段
说明
来源
id
ID
营销活动表
channel_id
渠道ID
营销活动表
name
营销活动名称
营销活动表
keyword
营销活动关键字
营销活动表
price
营销活动价格
营销活动表
remark
营销活动说明
营销活动表
link_code
引流标识码
营销活动引流点对应表
cplink_state
状态,营销活动引流点对应关系状态
营销活动引流点对应表
customer_id
客户ID
客户信息表
customer_name
客户名称
客户信息表
linkpoint_id
引流点ID
引流点信息表
linkpoint_url
引流点URL,即客户入口URL
引流点信息表
created_date
创建时间
营销活动引流点对应表
creator_id
创建人ID
营销活动引流点对应表
creator_name
创建人某某
用户表
link_url
引流系统入口ULR
系统参数表
前端可排序字段:
名称、价格、关键字、创建时间
注:
引流URL=引流系统入口URL+/+引流标识码;
引流系统入口URL通过系统参数配置;
编辑营销活动
接口URL:
base_url/campaign/edit
交互方式:
POSTJSON
交互参数:
单层JSON格式
{
‘id’:
xxxx,//ID,新增营销活动时,ID为空
‘channel_id’//渠道id
‘keyword’:
xxxx,//关键字
‘name’:
xxxx,//名称
‘price’:
xxxx,//营销活动价格
‘remark’:
xxxxx,//营销活动说明
‘cplink_state’:
xxxx,//营销活动引流点对应关系状态
‘linkpoint_id’:
xxxx,//引流点ID
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
}
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’//消息,失败原因,参数错误或者是系统内部错误
‘link_url’:
’xxxxxx’,//引流系统入口ULR
‘link_code’:
’xxxxxx’//引流标识码
}
注:
引流标识码=MD5(渠道名称+制表符+营销活动名+制表符+营销活动关键字+制表符+客户名称+制表符+引流点URL);
引流URL=引流系统入口URL+/+引流标识码;
引流系统入口URL通过系统参数配置;
加载客户列表
接口URL:
base_url/customer/list
交互方式:
POSTJSON
交互参数:
单层JSON格式
参数名称
参数说明
备注
page
当前页
如未提供此参数,默认为0
pagesize
每页记录数
如未提供此参数,默认全部
name
客户名称模糊查询条件
如未提供此参数,如此查询所有的数据,否如此模糊匹配符合条件的记录
sortcol
排序字段
如未提供此参数,默认用创建时间降序排序
descsort
降序排序
此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否如此降序排序,此参数值为true或者false
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{客户数据}]//客户数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
客户数据中,需要一个额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:
名称、创建时间、状态
编辑客户
接口URL:
base_url/customer/edit
交互方式:
POSTJSON
交互参数:
复杂JSON格式
{
‘id’:
xxxx,//ID,新增客户时,ID为空
‘code’:
xxxx,//代码
‘name’:
xxxx,//名称
‘remark’:
xxxx,//说明
‘level’:
xxxx,//等级
‘state’:
xxxx,//状态
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
‘props’:
[
{
‘id’:
xxxxx,//属性ID,新增的属性,ID为空
‘code’:
xxxx,//属性代码
‘name’:
xxxxx,//属性名称
‘value’:
xxxx,//属性值
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
},
……//其他属性
]
}
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
}
注:
属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。
另外,有模板id的,如果模板上定义的属性是不可删除的,如此这条属性是不能删除的,界面上对应的属性不需要删除按钮与操作,后台也不能删除此属性,如果模板定义的属性是必填的,如此这条属性的值不能为空,前端后端就要进展验证。
加载客户属性
接口URL:
base_url/customer/props/{id}
交互方式:
RESTFul
交互参数:
客户记录ID,直接包含在URL中,{id}即为客户记录ID,以get的方式交互
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{客户属性数据}]//客户属性数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
客户属性数据中,需要额外的字段,可删除、必填,字段数据来源于属性模板表。
属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。
另外,有模板id的,如果是不可删除的,如此这条属性是不能删除的,界面上对应的属性不需要删除按钮与操作,后台也不能删除此属性,如果是必填的,如此这条属性的值不能为空,前端后端就要进展验证。
客户属性模板的类别为customer_props_tmpl。
客户信息导入
接口URL:
base_url/excel/customer_in
交互方式:
POSTformdata
交互参数:
excel文件,字段名:
excel_file
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;2:
有异常;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘success_count’:
x,//成功记录数,如失败或者未登录,如此不需要响应此数据
‘error_count’:
x,//失败记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{客户导入错误数据}]//客户导入错误数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
lead导入错误数据字段:
字段
说明
来源
row
Excel行号
msg
错误原因
注:
此接口暂时不用做实现
加载引流点列表
接口URL:
base_url/linkpoint/list/{id}
交互方式:
RESTFul
交互参数:
客户记录ID,直接包含在URL中,{id}即为客户记录ID,以get的方式交互
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{引流点数据}]//引流点数据列表,如失败或者未登录,如此不需要响应此数据
}
编辑引流点
接口URL:
base_url/linkpoint/edit
交互方式:
RESTFulPOSTJSON
交互参数:
单层JSON格式
{
‘id’:
xxxx,//ID,新增时,ID为空
‘name’:
xxxx,//名称
‘customer_id‘:
//客户id
‘url’:
//引流点url
‘state’:
//状态值
‘remark’:
//引流说明
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
}
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
}
加载供给商列表
接口URL:
base_url/vender/list
交互方式:
POSTJSON
交互参数:
单层JSON格式
参数名称
参数说明
备注
page
当前页
如未提供此参数,默认为0
pagesize
每页记录数
如未提供此参数,默认全部
name
供给商名称模糊查询条件
如未提供此参数,如此查询所有的数据,否如此模糊匹配符合条件的记录
sortcol
排序字段
如未提供此参数,默认用创建时间降序排序
descsort
降序排序
此参数结合sortcol参数使用,如未提供此参数,默认升序排序,否如此降序排序,此参数值为true或者false
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{供给商数据}]//供给商数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
客户数据中,需要额外的字段,创建人名称,此字段数据来源于用户表,前端可排序字段:
名称、创建时间、状态
编辑供给商
接口URL:
base_url/vender/edit
交互方式:
POSTJSON
交互参数:
复杂JSON格式
{
‘id’:
xxxx,//ID,新增供给商时,ID为空
‘code’:
xxxx,//代码
‘name’:
xxxx,//名称
‘remark’:
xxxx,//说明
‘level’:
xxxx,//等级
‘state’:
xxxx,//状态
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
‘props’:
[
{
‘id’:
xxxxx,//属性ID,新增的属性,ID为空
‘code’:
xxxx,//属性代码
‘name’:
xxxxx,//属性名称
‘value’:
xxxx,//属性值
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
},
……//其他属性
]
}
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
}
注:
属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。
另外,有模板id的,如果模板上定义的属性是不可删除的,如此这条属性是不能删除的,界面上对应的属性不需要删除按钮与操作,后台也不能删除此属性,如果模板定义的属性是必填的,如此这条属性的值不能为空,前端后端就要进展验证。
加载供给商属性
接口URL:
base_url/vender/props/{id}
交互方式:
RESTFul
交互参数:
供给商记录ID,直接包含在URL中,{id}即为供给商记录ID,以get的方式交互
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{供给商属性数据}]//供给商属性数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
供给商属性数据中,需要额外的字段,可删除、必填,字段数据来源于属性模板表。
属性那里,如果有模板id的,属性代码不可编辑,如果没有模板id,属性代码可编辑,没有模板id的说明是用户手工添加的属性。
另外,有模板id的,如果是不可删除的,如此这条属性是不能删除的,界面上对应的属性不需要删除按钮与操作,后台也不能删除此属性,如果是必填的,如此这条属性的值不能为空,前端后端就要进展验证。
客户属性模板的类别为customer_props_tmpl。
供给商信息导入
接口URL:
base_url/vender/import
交互方式:
POSTformdata
交互参数:
excel文件,字段名:
excel_file
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;2:
有异常;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘success_count’:
x,//成功记录数,如失败或者未登录,如此不需要响应此数据
‘error_count’:
x,//失败记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{供给商导入数据}]//供给商导入数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
供给商导入数据字段:
注:
此接口暂时不用做实现
加载统计报表列表
接口URL:
base_url/report/list
交互方式:
get
交互参数:
无
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘items’:
[{报表脚本数据}]//报表脚本数据列表,如失败或者未登录,如此不需要响应此数据
}
加载统计结果
接口URL:
base_url/report/result/{id}
交互方式:
RESTFul
交互参数:
报表脚本记录ID,直接包含在URL中,{id}即为报表脚本记录ID,以get的方式交互
交互参数:
单层JSON格式
参数名称
参数说明
备注
page
当前页
如未提供此参数,默认为0
pagesize
每页记录数
如未提供此参数,默认全部
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
‘total’:
x,//总记录数,如失败或者未登录,如此不需要响应此数据
‘titles’:
[‘xxxx’,……],//结果集字段数组,如失败或者未登录,如此不需要响应此数据
‘items’:
[{脚本执行结果数据}]//脚本执行结果数据列表,如失败或者未登录,如此不需要响应此数据
}
注:
交互参数的分页信息是针对统计脚本的分页信息,也就是在统计脚本的根底上增加分页功能。
titles是查询数据库返回的字段名称组成的数组
编辑统计报表
接口URL:
base_url/report/edit
交互方式:
POSTJSON
交互参数:
单层JSON格式
{
‘id’:
xxxx,//ID,新增时,ID为空
‘name’:
xxxx,//名称
‘script’:
xxxx,//统计语句
‘flag’:
xx//操作标志,-1:
删除;0:
编辑;1:
新增
}
响应数据格式:
JSON
{
‘flg’:
x,//状态,0:
失败;1:
成功;-1:
未登录
‘msg’:
’xxxxxx’,//消息,失败原因,参数错误或者是系统内部错误
}
加载分析数据列表
接口URL:
base_url/lead/list
交互方式:
POSTJSON
交互参数:
单层JSON格式
参数名称
参数说明
备注
page
当前页
如未提供此参数
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 网络 引流 系统 后端 数据 交互 接口 设计