更新时间:2023-05-12 GMT+08:00
分享

接口调用说明

接口格式

OneAccess同步事件回调接口的请求方式为POST,数据编码为UTF-8,数据格式为JSON。 如果应用系统接收事件回调的URL为 https://{app_domain}/callback,当OneAccess的企业发生组织机构或用户变动时,OneAccess将发生变动的业务数据推送至该回调地址。

  • URL

    POST https://{app_domain}/callback

  • 请求头

    Authorization: Bearer {access_token},可参考表1中的安全令牌

  • 请求参数
    表1 请求参数

    参数

    参数类型

    描述

    nonce

    String

    随机数,与timestamp结合使用,用于防止请求重放攻击。

    timestamp

    Integer

    时间戳,与nonce结合使用,用于防止请求重放攻击。

    eventType

    String

    事件类型,参见事件类型列表。

    data

    String

    消息体,当未开启加密时,发送明文的消息体;当开启加密时,发送加密的消息体,需要解密得到消息内容,解密后有random、msg二个字段,其中msg即为明文消息内容。

    signature

    String

    消息签名,当未开启签名时,签名信息为空字符串;当开启签名时,生成签名信息,signature计算结合企业应用填写的签名密钥(signatureSaltValue)、请求中的timestamp、nonce、加密的消息体。

  • 响应参数
    表2 响应参数

    参数

    参数类型

    描述

    code

    String

    返回code码,200表示成功,失败错误码请参考公共返回码

    message

    String

    处理出错时的错误原因说明。

    data

    String

    返回的消息体。不同的业务回调要求返回不同内容,比如回复空串,或者要求的业务数据。

    • 当未开启加密时,返回明文的消息体。
    • 当开启加密时,返回加密的消息体,需要解密得到消息内容,解密后有random、msg二个字段,其中msg即为明文消息内容。
  • 请求示例
    • 未启用消息签名和加密的请求示例:
      {
      	"nonce": "123456",
      	"timestamp": 1783610513,
      	"eventType": "eventType",
      	"data": "明文的消息",
      	"signature": ""
      }
    • 启用消息签名和加密的请求示例:
      {
      	"nonce": "123456",
      	"timestamp": 1783610513,
      	"eventType": "eventType",
      	"data": "1ojvw2WPvW7LijxS8UvISr8pdDP+rXpPbcLGOmIBNbWetRg7IP0vdhkl",
      	"signature": "111108bb8e6dbce3c9671d6fdb69d15066227608"
      }
  • 响应示例

    状态码:200

    请求成功

    • 未启用消息签名和加密的响应示例:
      {
      	"code": "200",
      	"message": "success",
      	"data": "明文的消息"
      }
    • 启用消息签名和加密的响应示例:
      {
      	"code": "200",
      	"message": "success",
      	"data": "P+rXpWetRg7IP0vdhVgkVwSoZBJeQwY2zhROsJq/HJ+q6tp1qhl9L1+c"
      }

相关文档