|
@@ -0,0 +1,282 @@
|
|
|
|
|
+= 微校信息推送服务
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Version | Update Time | Status | Author | Description
|
|
|
|
|
+|0.0.1|2022-07-27 09:50:00|创建文档|binguo|初始化接口文档
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+== 推送项目设置
|
|
|
|
|
+=== 查询推送项目
|
|
|
|
|
+*URL:* http://192.168.161.34:8099/wx/push/queryPushProject
|
|
|
|
|
+
|
|
|
|
|
+*Type:* GET
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Content-Type:* application/x-www-form-urlencoded;charset=utf-8
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Request-example:*
|
|
|
|
|
+----
|
|
|
|
|
+curl -X GET -i http://192.168.161.34:8099/wx/push/queryPushProject
|
|
|
|
|
+----
|
|
|
|
|
+*Response-fields:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Field | Type|Description|Since
|
|
|
|
|
+|success|boolean|接口调用结果标识|-
|
|
|
|
|
+|message|string|接口调用结果信息|-
|
|
|
|
|
+|code|string|接口调用业务码|-
|
|
|
|
|
+|data|object|接口调用返回数据|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+*Response-example:*
|
|
|
|
|
+----
|
|
|
|
|
+{
|
|
|
|
|
+ "success": true,
|
|
|
|
|
+ "message": "success",
|
|
|
|
|
+ "code": "79076",
|
|
|
|
|
+ "data": {
|
|
|
|
|
+ "waring": "You may have used non-display generics."
|
|
|
|
|
+ }
|
|
|
|
|
+}
|
|
|
|
|
+----
|
|
|
|
|
+
|
|
|
|
|
+=== 添加推送项目
|
|
|
|
|
+*URL:* http://192.168.161.34:8099/wx/push/addPushProject
|
|
|
|
|
+
|
|
|
|
|
+*Type:* POST
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Content-Type:* application/x-www-form-urlencoded;charset=utf-8
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Query-parameters:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Parameter | Type|Description|Required|Since
|
|
|
|
|
+|url|string| 推送服务接口:post请求 json参数|false|-
|
|
|
|
|
+|project|string| 服务名称|false|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Request-example:*
|
|
|
|
|
+----
|
|
|
|
|
+curl -X POST -i http://192.168.161.34:8099/wx/push/addPushProject --data 'project=mv0yt3&url=www.xn---xn--9nz-d33pw339a.biz'
|
|
|
|
|
+----
|
|
|
|
|
+*Response-fields:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Field | Type|Description|Since
|
|
|
|
|
+|success|boolean|接口调用结果标识|-
|
|
|
|
|
+|message|string|接口调用结果信息|-
|
|
|
|
|
+|code|string|接口调用业务码|-
|
|
|
|
|
+|data|object|接口调用返回数据|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+*Response-example:*
|
|
|
|
|
+----
|
|
|
|
|
+{
|
|
|
|
|
+ "success": true,
|
|
|
|
|
+ "message": "success",
|
|
|
|
|
+ "code": "79076",
|
|
|
|
|
+ "data": {
|
|
|
|
|
+ "waring": "You may have used non-display generics."
|
|
|
|
|
+ }
|
|
|
|
|
+}
|
|
|
|
|
+----
|
|
|
|
|
+
|
|
|
|
|
+=== 修改推送项目
|
|
|
|
|
+*URL:* http://192.168.161.34:8099/wx/push/updatePushProject
|
|
|
|
|
+
|
|
|
|
|
+*Type:* PUT
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Content-Type:* application/json; charset=utf-8
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Body-parameters:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Parameter | Type|Description|Required|Since
|
|
|
|
|
+|id|int64|主键|false|-
|
|
|
|
|
+|url|string|推送地址|false|-
|
|
|
|
|
+|project|string|推送项目|false|-
|
|
|
|
|
+|statu|int32|状态 0(有效) 1(无效)|false|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+*Request-example:*
|
|
|
|
|
+----
|
|
|
|
|
+curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -i http://192.168.161.34:8099/wx/push/updatePushProject --data '{
|
|
|
|
|
+ "id": 657,
|
|
|
|
|
+ "url": "www.xn---xn--9nz-d33pw339a.biz",
|
|
|
|
|
+ "project": "eui823",
|
|
|
|
|
+ "statu": 965
|
|
|
|
|
+}'
|
|
|
|
|
+----
|
|
|
|
|
+*Response-fields:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Field | Type|Description|Since
|
|
|
|
|
+|success|boolean|接口调用结果标识|-
|
|
|
|
|
+|message|string|接口调用结果信息|-
|
|
|
|
|
+|code|string|接口调用业务码|-
|
|
|
|
|
+|data|object|接口调用返回数据|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+*Response-example:*
|
|
|
|
|
+----
|
|
|
|
|
+{
|
|
|
|
|
+ "success": true,
|
|
|
|
|
+ "message": "success",
|
|
|
|
|
+ "code": "79076",
|
|
|
|
|
+ "data": {
|
|
|
|
|
+ "waring": "You may have used non-display generics."
|
|
|
|
|
+ }
|
|
|
|
|
+}
|
|
|
|
|
+----
|
|
|
|
|
+
|
|
|
|
|
+=== 删除推送项目
|
|
|
|
|
+*URL:* http://192.168.161.34:8099/wx/push/deletePushProject
|
|
|
|
|
+
|
|
|
|
|
+*Type:* DELETE
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Content-Type:* application/x-www-form-urlencoded;charset=utf-8
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Query-parameters:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Parameter | Type|Description|Required|Since
|
|
|
|
|
+|id|int64|No comments found.|false|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Request-example:*
|
|
|
|
|
+----
|
|
|
|
|
+curl -X DELETE -i http://192.168.161.34:8099/wx/push/deletePushProject?id=828
|
|
|
|
|
+----
|
|
|
|
|
+*Response-fields:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Field | Type|Description|Since
|
|
|
|
|
+|success|boolean|接口调用结果标识|-
|
|
|
|
|
+|message|string|接口调用结果信息|-
|
|
|
|
|
+|code|string|接口调用业务码|-
|
|
|
|
|
+|data|object|接口调用返回数据|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+*Response-example:*
|
|
|
|
|
+----
|
|
|
|
|
+{
|
|
|
|
|
+ "success": true,
|
|
|
|
|
+ "message": "success",
|
|
|
|
|
+ "code": "79076",
|
|
|
|
|
+ "data": {
|
|
|
|
|
+ "waring": "You may have used non-display generics."
|
|
|
|
|
+ }
|
|
|
|
|
+}
|
|
|
|
|
+----
|
|
|
|
|
+
|
|
|
|
|
+== 微校推送服务
|
|
|
|
|
+=== 微校数据变更推送接口
|
|
|
|
|
+*URL:* http://192.168.161.34:8099/wx/wxc/receive
|
|
|
|
|
+
|
|
|
|
|
+*Type:* POST
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Content-Type:* application/json; charset=utf-8
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+*Body-parameters:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Parameter | Type|Description|Required|Since
|
|
|
|
|
+|app_key|string|应用appKey|false|-
|
|
|
|
|
+|school_code|string|学校主体代码|false|-
|
|
|
|
|
+|event|string|推送事件类型<br> addUser 新增用户信息事件<br> updateUser 修改用户信息事件<br> deleteUser 删除用户信息事件<br> addOrg 新增组织架构事件<br> updateOrg 修改组织架构事件<br> deleteOrg 删除组织架构事件|false|-
|
|
|
|
|
+|raw_data|string|推送加密后数据|false|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+*Request-example:*
|
|
|
|
|
+----
|
|
|
|
|
+curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://192.168.161.34:8099/wx/wxc/receive --data '{
|
|
|
|
|
+ "app_key": "tdatrw",
|
|
|
|
|
+ "school_code": "79076",
|
|
|
|
|
+ "event": "l2li4v",
|
|
|
|
|
+ "raw_data": "2wg8sh"
|
|
|
|
|
+}'
|
|
|
|
|
+----
|
|
|
|
|
+*Response-fields:*
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Field | Type|Description|Since
|
|
|
|
|
+|code|int32|响应代码|-
|
|
|
|
|
+|message|string|响应消息|-
|
|
|
|
|
+|====================
|
|
|
|
|
+
|
|
|
|
|
+*Response-example:*
|
|
|
|
|
+----
|
|
|
|
|
+{
|
|
|
|
|
+ "code": 473,
|
|
|
|
|
+ "message": "success"
|
|
|
|
|
+}
|
|
|
|
|
+----
|
|
|
|
|
+
|
|
|
|
|
+== 错误码列表
|
|
|
|
|
+
|
|
|
|
|
+[width="100%",options="header"]
|
|
|
|
|
+[stripes=even]
|
|
|
|
|
+|====================
|
|
|
|
|
+|Error code |Description
|
|
|
|
|
+|10000|系统未知异常
|
|
|
|
|
+|10001|请求方法不支持
|
|
|
|
|
+|10002|缺少必要的请求头
|
|
|
|
|
+|10003|无效的token
|
|
|
|
|
+|10004|token为空
|
|
|
|
|
+|10005|管理员登录失败
|
|
|
|
|
+|10006|权限不足
|
|
|
|
|
+|11001|参数格式校验失败
|
|
|
|
|
+|11002|body为空
|
|
|
|
|
+|11003|参数异常
|
|
|
|
|
+|11004|重复提交表单
|
|
|
|
|
+|11005|订单提交失败
|
|
|
|
|
+|11006|消费者消费异常
|
|
|
|
|
+|16000|数据已存在
|
|
|
|
|
+|16000|数据不存在
|
|
|
|
|
+|16006|临时文件不存在
|
|
|
|
|
+|16007|文件上传失败
|
|
|
|
|
+|16008|文件太大
|
|
|
|
|
+|16009|微校信息推送异常
|
|
|
|
|
+|====================
|
|
|
|
|
+
|