当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
2 Star 0 Fork 0

瀑布小石 / USR通知助手
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
developer.md 3.68 KB
一键复制 编辑 原始数据 按行查看 历史
瀑布小石 提交于 2019-12-14 14:27 . 优化

开发者对接说明

应用对接通知助手,需要注意三个格式要求

  1. 配置文件格式要求
  2. 登录的接口
  3. 获取数据的格式要求

数据收发规则如下:

  1. 发送和接受都是 json 格式
  2. 返回的格式要求如下
{"code":200,"info":"获取成功","data":[]}

格式说明:

  • code 业务成功返回200
  • code 业务失败返回 400
  • code 服务器错误返回 500
  • info 返回的提示信息
  • data 返回的数据

具体接口格式

1. 配置接口的返回格式要求

接收:

返回:

{
	"code": 200,
	"info": "获取成功",
	"data": [
                {
                    "app_name": "物联卡",
                    "app_login_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "app_news_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "news_header": ["工单ID", "平台", "星级", "主题", "负责人", "提交人", "更新日期"]
                }, {
                    "app_name": "OA",
                    "app_login_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "app_news_url": "https://sim.usr.cn/api/v1.Index/warnContent",
                    "news_header": ["工单ID1", "平台2", "星级", "主题", "负责人", "提交人", "更新日期"]
                }
            ]
}

字段说明:

  • app_name 应用名称,多个应用名称不能相同,应用数量不限

  • app_login_url 登录接口地址

  • app_news_url 通知消息获取接口地址

  • news_header 消息头数据

备注:

  • 超时时间10秒

  • 给用户提供这个订阅接口的时候,地址格式是 http://sim.usr.cn/api/test , 要带着http://

  • 为了对接多个应用,字段data是一个二维数据,开发者请注意

  • 用户使用这个软件填写好订阅地址(这个接口地址),以后只需要在设置里更新订阅列表就可以看到开发者提供的新应用。

2. 登录接口的格式要求

接收:

{
    "username" : "liuyexing",
    "password" : "123444"
}

字段说明:

  • username 用户名

  • password 密码

备注:

  • 超时时间5秒

返回:

{
	"code": 200,
	"info": "登录成功",
	"data": []
}

3. 通知消息接口的格式要求

接收:

{
    "username" : "liuyexing",
    "password" : "123444"
}

字段说明:

  • username 用户名

  • password 密码

返回:

{
	"code": 200,
	"info": "获取成功",
	"data": [
        {
            "url" : "https://www.baidu.com",
            "content" : [
                "123123",
                "123123",
                "123123",
                "123123",
                "123123"
            ]
        },
        {
            "url" : "https://www.baidu.com",
            "content" : [
                "123123",
                "123123",
                "123123",
                "123123",
                "123123"
            ]
        }
    ]
}

字段说明:

  • 字段 url 为 点击消息的弹出网页的url,若不需要点击弹出,字段内容为空字符串

  • 字段 content 为 一条提示消息的内容,数组的顺序为表头的顺序

备注:

  • 超时时间10秒

  • 通知助手每20秒轮询这个接口;

  • 如果code返回400 会在主界面显示"数据获取异常,请重新登录",如果接口超时或接口崩溃会显示"应用服务器错误";

  • 当用户没有未处理事项,则返回的data字段数据为空数组,code字段也需要返回200;

  • 有新的消息会有系统通知;

  • 只要用户的未处理事项列表中存在数据,系统的托盘图标就会闪烁,把未处理事项处理消失需要应用开发者自行实现。

JavaScript
1
https://gitee.com/waterlyx/notification_assistant.git
git@gitee.com:waterlyx/notification_assistant.git
waterlyx
notification_assistant
USR通知助手
master

搜索帮助