消息订阅说明

一、消息订阅介绍

  薪人薪事开放平台是企业内部系统与薪人薪事后台系统之间的桥梁。在业务接口对接的基础之上，为了构建更完善的系统间信息交流机制， 我们提供了消息订阅服务。开放平台将消息及时推送到企业系统，增强了业务流程的可感知性； 同时，完善了系统间数据交互的方式，提高了数据的准确性和可读性。

二、消息订阅时序图

消息订阅需要注意以下几点:

• 企业需提供一个接收消息的地址，我们会将您订阅的消息推送到这个URL。

• 订阅消息的链接需要支持post方式请求。

• 消息订阅的http请求的超时时间为3秒。

• 推送消息地址需要支持接口验证，接收到如下格式验证消息后需返回{"message":"success"}。

  {
    "messageId": "uuid",
    "type": "verify",
    "sendtime": "1515986177"
  }
  `
  

主动查询推送失败的消息

接收到消息之后，返回如下数据表示成功接收消息。

{"message":"success"}

除此之外，其他消息一律视为处理失败。消息推送失败之后，不会重试。

这些订阅失败的消息，可以通过失败消息接口查询。该接口只能查询最近7日的失败消息。

三、消息介绍

3.1 消息体

{
    "messageId": "uuid",
    "type": "department_create",
    "sendtime": 1515986177,
    ... //其他字段信息
}

3.2 消息类型

员工相关的消息

部门相关的消息

审批相关的消息

招聘相关的消息

绩效相关的消息

通知相关的消息

工资相关的消息

3.3 签名验证

为防止订阅的消息被篡改，推送消息时，会对消息数据进行签名计算。

签名信息以链接参数(链接问号后面的参数)的形式传递，消息数据以消息体的形式传递。

• 推送url样例:

   例如配置的消息推送的地址是 http://ip:端口/message
   则推送的url为 http://ip:端口/message?sign=123MJIB*%1231
  

一致性校验

接收到消息之后，需要对请求验签，即对消息进行签名计算。签名计算的结果如果与收到的签名值一致，则表示消息没有被篡改。

签名计算方式

• 假设需要消息为content
• 对content使用HmacSHA1算法进行加密。加密密钥为应用appSecret
• 将加密结果通过base64编码转换为加密后的字符串。

Java版demo

    /**
     * 薪人薪事消息签名计算
     *
     * @param content   签名明文
     * @param appSecret 应用密钥
     * @return 签名信息
     * @throws Exception
     */
    public static String hmacSha1Encrypt(String content, String appSecret) throws Exception {
        byte[] keyBytes = appSecret.getBytes(StandardCharsets.UTF_8);
        SecretKeySpec localSecretKeySpec = new SecretKeySpec(keyBytes, "HmacSHA1");
        Mac localMac = Mac.getInstance("HmacSHA1");
        localMac.init(localSecretKeySpec);
        byte[] contentBytes = content.getBytes(StandardCharsets.UTF_8);
        localMac.update(contentBytes);
        return Base64.encodeBase64String(localMac.doFinal());
    }