接入指南

事件中心支持以webhook方式推送业务数据,支持verificationToken和signType方式,verificationToken即自定义token,客户系统只需要按照自己创建token的方式解析验证即可,signType方式支持RSA2,SM2,HMAC-SHA256算法进行加签,需要按照以上几种方式验签,另外可选对以上两种方式是否需要AES加密。

V1 数据定义

主要由schema版本号,header头部信息,event业务数据内容三部分组成,header头部信息包含 event_id唯一标识,event_type事件类型, event_time事件时间,tenant_id租户号,token自定义verificationToken方式

参数	类型	是否必填	最大长度	描述	示例值
schema	String	是	8	版本	1.0
header	Object	是		webhook事件头
event_id	String	是	16	事件id	5e3702a84e847582be8db7fb73283c02
event_type	String	是	64	事件类型	sys.dict.biz.create
event_time	String	是	16	创建时间	1608725989000
token	String	否	128	校验token 只有配置verificationToken才会存在	ZMNfAOGnIgAzTo9HLZjG6Oj1s7R4AW7WYdPT%2FDX3%2FCo%3
tenant_id	String	是	8	租户id	160948
event	String	是		event数据 json字符串格式	{"name":"优财云链科技有限公司","i18n_name":{"zh_cn":"labore dolore proident","en_us":"Duis"},"parent_organization_id":"98","order":10,"organization_code":"41","profit_center":"in sint","company_info":{"business_identifier_code":"70","country_code":"71","finance_person":"est","office_address":"海南省朔州市城步苗族自治县","i18n_registered_address":{"en_us":"杭州市滨江区","zh_cn":"Binjiang District, Hangzhou City"},"i18n_office_address":{"en_us":"杭州市滨江区","zh_cn":"Binjiang District, Hangzhou City"},"social_credit_code":"94","registered_address":"杭州市滨江区","institution_code":"16","standard_currency":"CNY"},"short_name":"优财","i18n_short_name":{"en_us":"优财","zh_cn":"yocyl"},"category":0,"remark":"Ut adipisicing eiusmod","organization_id":"80"}

请求体body

字段使用下划线分割
V1 1.0请求体body示例
verificationToken 认证方式 header字段token字段必填,其他认证方式无

未加密请求body示例

{
    "schema": "1.0",
    "header": {
        "event_id": "5e3702a84e847582be8db7fb73283c02",
        "event_type": "sys.organization.delete",
        "create_time": "1722998250789",
        "token": "ZMNfAOGnIgAzTo9HLZjG6Oj1s7R4AW7WYdPT%2FDX3%2FCo%3"
    },
    "event": {
        "name": "优财云链科技有限公司",
        "i18n_name": {
            "zh_cn": "labore dolore proident",
            "en_us": "Duis"
        },
        "parent_organization_id": "98",
        "order": 10,
        "organization_code": "41",
        "profit_center": "in sint",
        "company_info": {
            "business_identifier_code": "70",
            "country_code": "71",
            "finance_person": "est",
            "office_address": "海南省朔州市城步苗族自治县",
            "i18n_registered_address": {
                "en_us": "杭州市滨江区",
                "zh_cn": "Binjiang District, Hangzhou City"
            },
            "i18n_office_address": {
                "en_us": "杭州市滨江区",
                "zh_cn": "Binjiang District, Hangzhou City"
            },
            "social_credit_code": "94",
            "registered_address": "杭州市滨江区",
            "institution_code": "16",
            "standard_currency": "CNY"
        },
        "short_name": "优财",
        "i18n_short_name": {
            "en_us": "优财",
            "zh_cn": "yocyl"
        },
        "category": 0,
        "remark": "Ut adipisicing eiusmod",
        "organization_id": "80"
    }
}

请求body加密示例

请求体加密后，固定字段encrypt

{
"encrypt": "FIAfJPGRmFZWkaxPQ1XrJZVbv2JwdjfLk4jx0k/U1deAqYK3AXOZ5zcHt/cC4ZNTqYwWUW/EoL+b2hW/C4zoAQQ5CeMtbxX2zHjm+E4nX/Aww+FHUL6iuIMaeL2KLxqdtbHRC50vgC2YI7xohnb3KuCNBMUzLiPeNIpVdnYaeteCmSaESb+AZpJB9PExzTpRDzCRv+T6o5vlzaE8UgIneC1sYu85BnPBEMTSuj1ZZzfdQi7ZW992Z4dmJxn9e8FL2VArNm99f5Io3c2O4AcNsQENNKtfAAxVjCqc3mg5jF0nKabA+u/5vrUD76flX1UOF5fzJ0sApG2OEn9wfyPDRBsApn9o+fceF9hNrYBGsdtZrZYyGG387CGOtKsuj8e2E8SNp+Pn4E9oYejOTR+ZNLNi+twxaXVlJhr6l+RXYwEiMGQE9zGFBD6h2dOhKh3W84p1GEYnSRIz1+9/Hp66arjC7RCrhuW5OjCj4QFEQJiwgL45XryxHtiZ7JdAlPmjVsL03CxxFZarzxzffryrWUG3VkRdHRHbTsC34+ScoL5MTDU1QAWdqUC1T7xT0lCvQELaIhBTXAYrznJl6PlA83oqlMxpHh0gZBB1jFbfoUr7OQbBs1xqzpYK6Yjux6diwpQB1zlZErYJUfCqK7G/zI9yK/60b4HW0k3M+AvzMcw=" 
}

verificationToken 认证方式

verificationToken认证方式,默认请求体header字段携带token字段,token可由客户系统提供,event为业务数据,多个单子之间以下划线格式分割。

verificationToken未加密示例

请求url示例

HTTP请求默认约定POST Content-type application/json
可配置支持自定义url携带请求参数,例如携带一个access_token参数

https://{域名}/xxxx?access_token=xxxxx

验证方式
如果已加密,需要对加密数据进行解密,使用SDK解密方式对数据解密,得到json字符串,将json字符串反序列化得到未加密请求体示例

获取到请求体,header中token字段,使用客户自己的认证方式进行验证,验证成功,说明请求合法

signType 认证方式

signType 认证方式支持RSA2,SM2,HMAC-SHA256算法

RSA2,SM2

RSA2,SM2请求url示例

HTTP请求默认约定POST Content-type application/json

非必要参数 access_token, 可以是其他字段
必要参数 timestamp: 时间戳,参与验签,
必要参数 nonce: 唯一标识,可用于防重,
必要参数 sign: 签名,保证请求合法

https://{域名}/xxxx?access_token=xxxxx&timestamp=1732347572076&nonce=34c9bef54bee46d898fffd7d60bd5fbf&sign=xxxx

验证方式

RSA2,SM2 生成待签名文本示例

请求体body,时间戳timestamp,唯一标识nonce使用\n换行符分割得到待签名文本

nonce=34c9bef54bee46d898fffd7d60bd5fbf
requestBody={"schema":"1.0","header":{"event_id":"5e3702a84e847582be8db7fb73283c02","event_type":"sys.organization.delete","create_time":"1722998250789","token":"ZMNfAOGnIgAzTo9HLZjG6Oj1s7R4AW7WYdPT%2FDX3%2FCo%3"},"event":{"name":"优财云链科技有限公司","i18n_name":{"zh_cn":"labore dolore proident","en_us":"Duis"},"parent_organization_id":"98","order":10,"organization_code":"41","profit_center":"in sint","company_info":{"business_identifier_code":"70","country_code":"71","finance_person":"est","office_address":"海南省朔州市城步苗族自治县","i18n_registered_address":{"en_us":"杭州市滨江区","zh_cn":"Binjiang District, Hangzhou City"},"i18n_office_address":{"en_us":"杭州市滨江区","zh_cn":"Binjiang District, Hangzhou City"},"social_credit_code":"94","registered_address":"杭州市滨江区","institution_code":"16","standard_currency":"CNY"},"short_name":"优财","i18n_short_name":{"en_us":"优财","zh_cn":"yocyl"},"category":0,"remark":"Ut adipisicing eiusmod","organization_id":"80"}}
timestamp=1732347572076

参考SDK RSA2,SM2对待签名文本,使用公钥对Sign进行验签

HMAC-SHA256

HMAC-SHA256 请求url示例

HTTP请求默认约定POST Content-type application/json

非必要参数 access_token, 可以是其他字段
必要参数 timestamp: 时间戳,参与验签,
必要参数 sign: 签名,保证请求合法

https://{域名}/xxxx?access_token=xxxxx&timestamp=1732347572076&sign=xxxx

验证方式
如果已加密,需要对加密数据进行解密,使用SDK解密方式对数据解密,得到json字符串,将json字符串反序列化得到未加密请求体示例

HMAC-SHA256 生成待验签字符串

获取到时间戳timestamp,密钥secretKey,使用\n换行符生成待签名文本

1732349484755
SECa2b593a1786e6407deded83dde29a9b8d0b968011439fe008d6985e6c5fce8be

参考SDK RSA2,SM2对待签名文本,使用对Sign进行验签

webhook

接入指南#

V1 数据定义#

请求体body#

未加密请求body示例#

请求body加密示例#

verificationToken 认证方式#

verificationToken未加密示例#

signType 认证方式#

RSA2,SM2#

HMAC-SHA256#