网络引流系统前后端数据交互接口设计.docx

网络引流系统前后端数据交互接口设计.docx网络引流系统前后端数据交互接口设计
网络引流系统采用前后端完全解耦的方式进行写作开发，前端主要责任是实现跟用户之间的界面交
互，后台的主要责任是进行业务逻辑的处理及业务数据的持久化，前后端通过 http 协议进行数据交互实现系统的整体联动。
根据用户交互界面，前后端交互接口如下：
注：接口引用中 base_url 为系统项目管理平台的部署入口 URL。
1

登录
接口 URL：base_url/login
交互方式： POST JSON
交互参数：单层 JSON格式
参数名称 参数说明
username 用户名
passwd 密码

备注
必须提供此参数
必须提供此参数，前端对用户输入数据先进性
的参数是 MD5加密后的字符串

MD5加密，传入
响应数据格式：

JSON
{
‘flg ’:x,
‘msg’: ’xxxxxx ’,
‘username’: ’xxxxxx ’

// 状态， 0：登录失败； 1：成功
// 消息，失败原因，用户名密码错误或者是系统内部错误
// 登录用户名
}
2

退出
接口 URL：base_url/logout
交互方式： HTTP GET
交互参数：无
响应数据格式： JSON
{
‘flg ’:x,
‘msg’: ’xxxxxx ’

// 状态， 0：登录失败； 1：成功
// 消息，失败原因，用户名密码错误或者是系统内部错误
}
加载渠道列表
接口 URL:base_url/channel/list
交互方式： POST JSON
交互参数：单层
JSON格式
参数名称
参数说明
备注
page
当前页
如未提供此参数，默认为 0
pagesize
每页记录数
如未提供此参数，默认全部
name
渠道名称
模糊查询
如未提供此参数，则查询所有的数据，否则模糊匹配符合
条件
条件的记录
sortcol
排序字段
如未提供此参数，默认用创建时间降序排序
descsort
降序排序
此参数结合 sortcol 参数使用，如未提供此参数，默认升
序排序，否则降序排序，此参数值为true
或者 false
响应数据格式： JSON
{
‘flg ’:x,
‘msg’: ’xxxxxx ’,
‘total ’:x,
‘items ’:[{ 渠道数据

}]

// 状 ， 0：失 ； 1：成功； -1 ：未登
// 消息，失 原因，参数 或者是系 内部
// 数，如失 或者未登 ， 不需要响 此数据
// 渠道数据列表，如失 或者未登 ， 不需要响 此数据
}
注：渠道数据中，需要一个 外的字段， 建人名称，此字段数据来源于用 表，前端可排序字段：名称、 建 、状
渠道
接口 URL:base_url/channel/edit
交互方式： POST JSON
交互参数：复 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：新增
} ，
⋯⋯ // 其他属性
]