1. 订阅流程
智书合同API
  • 智书开放平台概述
  • 开发对接流程
  • 基本概念
    • 应用鉴权
    • 用户身份体系
  • 对接方式
    • 选择对接方式
    • 【识别用户身份】选择自建应用的方式快速对接
    • 智书开平与飞书开平对接差异
      • 智书合同新用户流程差异
      • 从飞书合同迁移到智书合同流程差异
  • API调用指南
    • API列表
    • 频控策略
    • 调用流程
      • 流程概述
      • 获取访问凭证
      • 调用API
  • 事件订阅
    • 事件概述
    • 事件列表
    • 订阅流程
      • 获取 Encrypt Key
      • 获取 Verification Token
      • 添加事件
      • 接收并处理事件
      • 配置订阅方式
  • 认证及授权
    • 获取访问凭证
      • 获取 tenant_access_token
  • 智书合同
    • 合同类型
      • 查询合同类型目录
    • 模版管理
      • 查看模板列表
      • 创建模版实例
      • 查看模版详情
    • 文件管理
      • 上传合同相关文件
      • 下载合同相关文件
    • 合同管理
      • 事件
        • 协商事件
        • 合同信息变更
        • 合同状态变更
        • 合同分享事件
        • 取消合同分享事件
      • form表单、币种、国家说明
        • 合同创建Form组件说明
        • 币种说明
        • 国家地区编码
      • 创建合同
      • 删除草稿合同
      • 提交合同
      • 重新提交合同
      • 更新合同
      • 更新合同字段信息
      • 查看合同详情
      • 搜索合同
      • 根据合同编号查询
      • 合同协商操作记录信息查询
      • 合同电子签转纸质签
      • 查询合同分享记录
    • 付款
      • 事件
        • 合同新建付款
      • 创建付款申请
      • 更新付款信息
      • 查看付款信息
      • 查询付款申请列表
    • 付款计划
      • 同步付款记录
      • 搜索付款计划
    • 付款记录
      • 创建付款记录
      • 更新付款记录
      • 查询付款记录详情
      • 根据付款计划id查询付款记录
    • 审批管理
      • 发起流程审批
      • 查询审批实例详情
    • 合同权限管理
      • 授予合同权限
      • 合同分享
    • 文件
      • 生成合同打印文件
    • 合同协商
      • 查询合同协商邀请链接
    • 电子签
      • 获取个人认证&授权页面链接
      • 获取机构认证&授权页面链接
    • 审批事件
      • 审批-待办任务变更
      • 审批-抄送、知会状态变更
    • 事件ip
      • 获取事件出口IP
    • 审批矩阵
      • 矩阵-预发布规则表配置
      • 矩阵-发布规则表配置
      • 矩阵-查询规则表列表
      • 矩阵-查询规则表列头信息
      • 矩阵-创建规则表行
      • 矩阵-删除规则表行
      • 矩阵-修改规则表行
      • 矩阵-根据行ID查询规则表单行信息
      • 矩阵-根据筛选条件查询规则表行信息列表
      • 矩阵-查询规则表行信息列表
  • 智书主数据
    • 固定汇率
      • 更新固定汇率
      • 查询固定汇率
    • 交易方
      • 事件
        • 交易方-基础信息变更
        • 交易方-公司视图变更
        • 交易方-联系人变更
        • 交易方-经营地址变更
        • 交易方-银行账户变更
      • 创建交易方
      • 更新交易方
      • 获取交易方
      • 获取单个交易方信息
      • 获取交易方全量数据
      • 根据证件id精确查询交易方
      • 字段配置查询
    • 法人实体
      • 创建法人实体
      • 更新法人实体信息
      • 获取法人实体
      • 获取单个法人实体信息
      • 获取法人实体全量数据
    • 文件
      • 下载主数据附件
  • 第三方系统相关配置
    • 关联单据
      • 关联前置单据
    • 外部数据回填
      • 表单字段回填
      • 审批人回填
    • 外部校验
      • 外部校验
  1. 订阅流程

获取 Encrypt Key

功能简介#

如果和客户选择加密事件回调,则需要联系智书客服询问 Encrypt Key ,获取到 Encrypt Key后,开放平台将向
配置订阅方式 推送加密后的事件。加密推送能够让用户数据更加安全,建议用户选择配置 Encrypt Key。加密推送的事件示例如下所示:
{
    "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=" 
}
应用的服务端接收到加密事件后,需要进行解密处理,解密后的事件示例如下所示。有关解密方法的详细介绍,请参考接收并处理事件接收并处理事件。
{
    "schema": "2.0",
    "header": {
        "event_id": "5e3702a84e847582be8db7fb73283c02",
        "event_type": "im.message.receive_v1",
        "create_time": "1608725989000",
        "token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
        "app_id": "cli_9f5343c580712544",
        "tenant_key": "2ca1d211f64f6438"
    },
     "event": {
        "sender": {
            "sender_id": {
                "union_id": "on_8ed6aa67826108097d9ee143816345",
                "user_id": "e33ggbyz",
                "open_id": "ou_84aad35d084aa403a838cf73ee18467"
            },
            "sender_type": "user"
        },
        "message": {
            "message_id": "om_5ce6d572455d361153b7cb51da133945",
            "root_id": "om_5ce6d572455d361153b7cb5xxfsdfsdfdsf",
            "parent_id": "om_5ce6d572455d361153b7cb5xxfsdfsdfdsf",
            "create_time": "1609073151345",
            "chat_id": "oc_5ce6d572455d361153b7xx51da133945",
            "chat_type": "group",
            "message_type": "text",
            "content": "{"text":"@_user_1 hello"}",
            "mentions": [
                {
                    "key": "@_user_1",
                    "id": {
                        "union_id": "on_8ed6aa67826108097d9ee143816345",
                        "user_id": "e33ggbyz",
                        "open_id": "ou_84aad35d084aa403a838cf73ee18467"
                    },
                    "name": "Tom"
                }
            ]
        }
    }
}

适用场景#

加密推送适用于如下应用场景:
应用校验收到的事件推送是来自开放平台, 而非伪造。
应用防止被重放攻击。
重放攻击是指开放平台推送给应用的事件被第三方截获,然后再把事件原封不动的多次发送给应用。这样可能会对应用造成数据安全隐患,也可能会影响应用服务器的性能。
配置 Encrypt Key 后,应用服务端可以基于 Encrypt Key 进行签名校验,以保证应用接收到的都是开放平台推送的合法事件。有关签名校验的详细介绍,请参考接收并处理事件接收并处理事件。
修改于 2025-11-11 07:18:39
上一页
事件列表
下一页
获取 Verification Token
Built with