美文网首页
一网统管事件接收接口(协同网关)

一网统管事件接收接口(协同网关)

作者: 陆水手 | 来源:发表于2024-05-29 16:16 被阅读0次

推送事件数据

请求方式

POST

Content-Type

application/json

参数:

header

参数 参数类型 是否必填 说明
X-BG-HMAC-SIGNATURE String 签名,API输入参数签名结果,签名算法
X-BG-HMAC-ALGORITHM String 签名的摘要算法,当前仅支持hmac-sha256
X-BG-HMAC-ACCESS-KEY String 分配给应用的accessKey
X-BG-DATE-TIME String 时间戳,时区为GMT+8,格式为:Tue, 09 Nov 2021 08:49:20 GMT。API服务端允许客户端请求最大时间误差为100秒

body

参数名 参数类型 是否必填 说明
topicName String 网关接收主题,业务协同网关提供
content String 请求参数,jso字符串
--topicName String 一网统管接收主题,业务协同网关提供
--content String 请求参数,jso字符串
——innerEventId String 事件提供方的对事件的唯⼀标识
——areaCode String 事件消息所属区域编码 如:33010000000
——streetCode String 街道编码
——origin String 件消息来源部门名称例如:市应急局
——scence String 件消息所属场景编码:该场景编码由各提供方向指挥中心平台申请
——title String 事件消息标题
——content String 事件消息内容
——eventTime String 事件发生时间,格式为:yyyy-MM- dd HH:mm:
——eventCoordinate String 件发生地经纬度,格式为:经度,纬度
——msgType Integer 事件消息类型1:应急事件,2:不稳定事件预警,3: 智慧消防,4:火警信息,5:基 层 信息,6:火灾救助 , 7:抢 险救 援 , 8:社 会 救 助,20:其他。如果已定义的类型不满足条件,需要向指挥中心平台申请对应的事件类型
——msgTypeName String 事件类型名称
——eventUrl String 事件消息跳转路径
——superviseStatus Integer 事件当前处理状态,0:"未处理" 1:"处理中" 2:"已完成"
——eventCreator String 事件上报人
——eventCreatorTel String 事件上报人联系方式
——eventPlaceName String 事件发生地点名
——eventDuration Integer 事件持续时间,单位:秒
——executeType Integer 事件执行类型 1:流转 2:展示 3:提级
——remindStatus Integer 事件是否超时: 0 未超时 1 已超时
——cdcProviderId Integer 消息提供方id
——eventFile String 附件链接(多个逗号分隔)
——eventProcessor String 事件处置人
——applicationId String 对应应用ID
——plateNumber String 车牌号码
——plateColor String 车牌颜色

请求示例

{

"topicName":"eventsImport",

"content":"{"topicName":"eventsImportForWj","content":[{"innerEventId":"sptsj3CEH","areaCode":"330381000000","streetCode":"330381000000","origin":"测试部门","scence":"120cjsj","title":"测试事件","content":"测试事件。","eventTime":"2022-10-26 16:12:32","eventCoordinate":"120.61552503339489,27.70127169381555","msgType":42103,"eventUrl":"http://www.dd.com","superviseStatus":0,"eventCreatorTel":"17857072110","eventCreator":"测试","eventPlaceName":"测试地址","executeType":1,"remindStatus":0,"cdcProviderId":49}]}"}

推送事件进度数据

请求方式

POST

Content-Type

application/json

参数:

header

参数 参数类型 是否必填 说明
X-BG-HMAC-SIGNATURE String 签名,API输入参数签名结果,签名算法
X-BG-HMAC-ALGORITHM String 签名的摘要算法,当前仅支持hmac-sha256
X-BG-HMAC-ACCESS-KEY String 分配给应用的accessKey
X-BG-DATE-TIME String 时间戳,时区为GMT+8,格式为:Tue, 09 Nov 2021 08:49:20 GMT。API服务端允许客户端请求最大时间误差为100秒

body

参数名 参数类型 是否必填 说明
topicName String 网关接收主题,业务协同网关提供
content String 请求参数,json字符串
--topicName String 一网统管接收主题,业务协同网关提供
--content String 请求参数,json字符串
——innerEventId String 事件提供方的对事件的唯⼀标识
——detail String 事件进度描述
——url String 图⽚等多媒体⽂件链 接,多个以","相隔
——progressTime String 进度时间 格式为: yyyy-MM-dd HH:mm:ss
——eventProgressStatus String 事件当前进度状态,共 有以下⼏种状态 已办 结,代办结,待核实,办 理中,已受理,未受理。 推送已办结则⾃动修 改事件状态为已完 成,推送已受理则⾃ 动修改事件为处理中 。
——eventProgressExecut or String 事件当前进度执行人 名
——eventProgressExecut orId String 事件当前进度责任人ID
——eventProgressExecutorOrg String 事件当前进度执行人部门

请求示例

{

"topicName":"progressesImport","content":"{"topicName":"eventsImportForZhcg","content":[{"innerEventId":"DC6A8522102603432","detail":"结案","url":"","progressTime":"2022-10-27 10:00:43","eventProgressStatus":null,"eventProgressExecutorId":105867,"eventProgressExecutor":"市值班长17","eventProgressExecutorOrg":"市监督中心"}]}"}

签名生成方法

    /**
     * 构造http请求 header
     * @param url 请求url,全路径格式,比如:http://122.228.14.56:10005/service
     * @param requestMethod 请求方法,大写格式,如:GET, POST
     * @param accessKey 应用的 AK
     * @param secretKey 应用的 SK
     * @return
     */
    public static Map<String, String> generateHeader(String url,String requestMethod, String accessKey, String secretKey, String date) {
        Map<String, String> header = new HashMap<>();
        try {
            DateFormat dateFormat = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z", Locale.US);
            dateFormat.setTimeZone(TimeZone.getTimeZone("GMT"));
//            String date = dateFormat.format(new Date());
            URI uri = URI.create(url);
            String canonicalQueryString = getCanonicalQueryString(uri.getQuery());

            String message = requestMethod.toUpperCase() + "\n" + uri.getPath() + "\n" + canonicalQueryString + "\n"  + accessKey + "\n" + date + "\n";

            Mac hasher = Mac.getInstance("HmacSHA256");
            hasher.init(new SecretKeySpec(secretKey.getBytes(), "HmacSHA256"));

            byte[] hash = hasher.doFinal(message.getBytes());

            // to lowercase hexits
            DatatypeConverter.printHexBinary(hash);

            // to base64
            String sign = DatatypeConverter.printBase64Binary(hash);
            header.put("X-BG-HMAC-SIGNATURE", sign);
            header.put("X-BG-HMAC-ALGORITHM", "hmac-sha256");
            header.put("X-BG-HMAC-ACCESS-KEY", accessKey);
            header.put("X-BG-DATE-TIME", date);
        } catch (Exception e) {
            throw new RuntimeException("generate header error");
        }
        return header;
    }

    private static String getCanonicalQueryString(String query) {
        if (query == null || query.trim().length() == 0) {
            return "";
        }
        List<Pair<String, String>> queryParamList = new ArrayList<>();
        String[] params = query.split("&");
        for (String param : params) {
            String[] keyValue = param.split("=");
            Pair<String, String> pair = new Pair<String, String>(keyValue[0],keyValue.length > 1 ? keyValue[1] : "");
            queryParamList.add(pair);
        }

        List<Pair<String, String>> sortedParamList = queryParamList.stream().sorted(Comparator.comparing(param -> param.getKey() + "=" + Optional.ofNullable(param.getValue()).orElse(""))).collect(Collectors.toList());
        List<Pair<String, String>> encodeParamList = new ArrayList<>();
        sortedParamList.stream().forEach(param -> {
            try {
                String key = URLEncoder.encode(param.getKey(), "utf-8");
                String value = URLEncoder.encode(Optional.ofNullable(param.getValue()).orElse(""), "utf-8");
                encodeParamList.add(new Pair<>(key, value));
            } catch (UnsupportedEncodingException e) {
                throw new RuntimeException("encoding error");
            }
        });
        StringBuilder queryParamString = new StringBuilder(64);
        for (Pair<String, String> encodeParam : encodeParamList) {
            queryParamString.append(encodeParam.getKey()).append("=").append(Optional.ofNullable(encodeParam.getValue()).orElse(""));
            queryParamString.append("&");
        }

        return queryParamString.substring(0, queryParamString.length() - 1);
    }

事件接收接口规范

URL: 接收方提供

请求方式

POST

Content-Type

application/json

body参数:

参数 参数类型 是否必填 说明
data String 事件信息列表字符串,参见后续的参数实例及字段说明默认

data字段说明

参数 参数类型 是否必填 说明
receiveName String 接收方标识
innerEventId String 第三方案件号
areaCode String 事件所属区域编码
streetCode String 街道编码
origin String 消息来源部门名称例如:市应急局
scence String 消息场景编码
title String 消息标题
content String 事件详细内容
eventTime String 事件发生时间
eventCoordinate String 事件发生地经纬度,格式: 经度,纬度
msgType String 消息类型
eventUrl String 事件跳转平台链接
superviseStatus int 针对该事件处理状态 0:未处理 1:处理中 2:已完成
eventCreator String 事件消息上报人
eventCreatorTel String 事件消息上报人联系方式
eventPlaceName String 事件发生地名
eventDuration Long 事件持续时间
executeType int 事件执行类型 1:流转 2:展示
remindStatus int 事件是否超时: 0 未超时 1 已超时
cdcProviderId int 消息提供方id

示例:

{"data":"{"areaCode":"330302000000","eventCoordinate":"0.0,0.0","eventPlaceName":"1","eventTime":"2022-07-04 00:41:04","innerEventId":"6a9542b3498545209216ea0fbea414a7","origin":"温州市消防救援支队","receiveName":"lcshzlzxEvent","scence":"wzxfsj","streetCode":"330302027000","superviseStatus":1,"title":"火警报警:1"}"}

事件进度接收接口规范

URL: 接收方提供

请求方式

POST

Content-Type

application/json

body参数:

参数 参数类型 是否必填 说明
data String 进度信息列表字符串,参见后续的参数实例及字段说明默认

data字段说明

参数 参数类型 是否必填 说明
innerEventId String 第三方案件号
detail String 进度描述
url String 链接:图片等多媒体文件地址,多个用","隔开
progressTime Date 进度时间
eventProgressStatus String 事件当前进度状态 已办结,待办结,待核实,办理中,已受理,未受理;
eventProgressExecutorId String 事件当前进度执行人id
eventProgressExecutor String 事件当前进度执行人
eventProgressExecutorOrg String 事件当前进度执行人部门

示例:

{"data":"[{"detail":"该问题已处理完毕,请督查。","eventProgressExecutor":"五马中队","eventProgressExecutorId":"101059","innerEventId":"DC6A8521072110393","progressTime":"2022-07-04 00:41:04","url":""},{"detail":"","eventProgressExecutor":"市值班长27","eventProgressExecutorId":"105877","innerEventId":"DC6A8521072110393","progressTime":"2022-07-04 00:41:04","url":""}]"}

相关文章

  • spring-cloud微服务项目实战(7)- zuul构建微服

    目标 新建gateway网关,作为后期项目的统一网关服务 简介 zuul提供统一网关入口,屏蔽底层服务地址,规范入...

  • SpringCloud 之 Zuul(网关)

    概述 网关 Api(接口) Gateway(网关)--接口网关:接口是没有界面的 网关概念: 相当于客户端发送的请...

  • SSE(Server-Send Event) 服务器推送数据的

    Web API 接口: EventSource EventSource 接口用于接收服务器发送的事件。它通过HTT...

  • Django面试

    1.什么是wsgi,uwsgi,uWSGI? wsgi:web服务器网关接口,是一套协议,用于接收用户请求并将请求...

  • Netflix Zuul设置允许访问跨域

    zuul作为统一网关代理所有后台接口,对于代码发起的http请求自然无需在意跨域的问题,但是对于提供给前端访问的接...

  • NIOServerCnxn

    NIOServerCnxn 实现接口 Watcher(ZK客户端接收事件的,以callback)KeeperSta...

  • 推送MobPush-API说明

    1. 消息监听接口 MobPushReceiver:消息监听接口(包含接收自定义消息、通知消息、通知栏点击事件、别...

  • EventTarget

    EventTarget 定义 EventTarget 是一组由可以接收事件并且监听事件对象实现的接口; 常见的ev...

  • API网关之缓存篇

    构建企业级网关的时候与构建微服务网关的主要区别在于,往往需要将API网关用作统一网关,也就是意味着除了要接管微服务...

  • 调试接口网关互通

    链接接口网关:打开cmd 输入:ping +ip地址; 查看自己网关:ipconfig

网友评论

      本文标题:一网统管事件接收接口(协同网关)

      本文链接:https://www.haomeiwen.com/subject/gzclqjtx.html