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

【识别用户身份】选择自建应用的方式快速对接

为了识别用户身份,三方业务系统和智书合同对接时,目前按照飞书开放平台的设计,双方系统可以通过user_id 来识别企业员工的唯一身份,租户可以在“飞书开放平台”单独创建一个自建应用,配置在智书合同中,以便智书合同能获取到员工的 user_id,从而识别三方系统传入的 user_id 的身份。
如果选择自建应用的方式进行对接,可参考以下步骤创建自建应用。仅开通第一个开放平台应用时需要创建自建应用,后续再开通开放平台应用时,无需再次创建自建应用。

1. 进入飞书开发者后台#

https://open.feishu.cn/app

2. 创建自建应用#

image.png
图(1)
请注意, 应用的通讯录权限范围必须是全部成员 ,否则开放平台无法完成人员的自动匹配,请给应用的权限授权为全部成员。具体配置入口见图(2)图(3)所示。
image.png
图(2)
image.png
图(3)
若您的租户没有该页面参考右侧的图片
image.png
image.png
image.png

3. 开通自建应用相应的权限#

开通权限入口如图(4)或图(5)所示
序号分组编码名称等级版本应用场景举例目的
1事件订阅event:ip_list获取事件的出口IP普通1.0.0系统层面获取事件的出口IP后在回调服务的访问控制中配置IP白名单以便给事件回调服务设置IP白名单
2通讯录contact:contact.base:readonly获取通讯录基本信息普通1.0.0查询用户、部门基本信息-
3通讯录contact:department.base:readonly获取部门基础信息普通1.0.0获取:部门名称、部门状态-
4通讯录contact:department.organize:readonly获取通讯录部门组织架构信息高级1.0.0获取:部门直属成员数、部门在同级部门中的排序、部门负责人ID-
5通讯录contact:user.base:readonly获取用户基本信息普通1.0.0获取:用户名、用户英文名、用户头像-
6通讯录contact:user.employee_id:readonly获取用户user ID普通1.0.0获取:用户user_id-
7通讯录contact:user.department:readonly获取用户组织架构信息高级1.0.0获取:用户归属的部门ID 、用户的直属上级ID 、用户在其直属部门内的排序、用户多个部门间的排序-
8通讯录contact:user.department_path:readonly获取成员所在部门路径高级1.0.0获取用户的部门路径-
9通讯录contact:user.dotted_line_leader_info.read查看成员的虚线上级ID高级1.0.0便于根据虚线上级配置审批流程-
10通讯录contact:user.employee:readonly获取用户受雇信息高级1.0.0获取用户的status(状态)、employee_type(人员类型)-
11应用信息application:application:self_manage管理应用自身资源普通1.0.0获取应用被授权的通讯录范围-
12企业信息tenant:tenant:readonly获取企业信息普通1.0.0获取企业编号(display_id、F码)、tenant_key-
image.png
图(4)
image.png
图(5)
JSON:可直接将以下json导入自建应用

4. 飞书自建应用配置事件订阅地址#

配置飞书自建应用事件订阅地址,以便飞书组织架构和智书平台组织架构数据同步
【重要】在配置监听地址之前,Encrypt Key 必须保持未设置状态。如果已设置 Encrypt Key 可以先清空,配置完事件监听地址后再配置 Encrypt Key。
事件监听地址是一个url
https://contract.qfei.cn/api/public/feishu-event/{飞书自建应用的appid}/encrypted
配置事件监听地址后,开通以下通讯录事件监听权限。配置地址如图(6)所示
请注意:在订阅开放平台事件的时候如果想要进行加密传输数据,则需要先配置事件监听地址,然后再生成Encrypt Key。不然无法配置事件订阅地址,如果已经生成的 Encrypt Key 则需要先清空 Encrypt Key。
image.png
图(6)
需要开通的事件列表

5. 发布应用#

1. 保存并发布该飞书应用,即可开始调试智书开放平台相关接口。#

1、创建版本
image.png
2、填写信息
image.png
3、申请发布
image.png
应用审批人为租户管理员(即超级管理员),而非飞书管理员。请在应用发布后,找租户内管理员进行审批。只有审批通过后,应用或者应用的配置修改才能生效

2. 开通智书开放平台对接App ID和App Secret#

使用 https://ysi13ckdb9.feishu.cn/wiki/WP55wjUYPioY8xkvYoNc2ujrn3n 模版,在模版中填写该飞书自建应用的 app id 、 app secrect 、加密策略中的 Encrypt Key (可选)、 Verification Token 和本企业的租户名称和 F 码,并把文档发给到智书合同 CSM。智书合同CSM 会给接入方提供调用智书合同开放平台的 另一个App id 和 App secrect 【补充在您提供的文档中,方便给到开发方技术使用】。该appi和app secret用于获取智书合同接口授权token
说明示例是否必填字段英文名
租户名称xxx是tenant_name
租户的F码xxx是display_id
租户开通并且配置好授权的自建应用的App idcli_aaaaaaaaaaaa是app_id
租户开通并且配置好授权的租户开通的自建应用的App Secretxxx是app_secret
租户开通的自建应用的Encrypt Key(可选)xxx否encrypt_key
说明示例是否必填字段英文名
事件回调:开放平台应用需要的事件回调地址xxxxx是subscription_url

6. 视频demo#

点击查看:https://ysi13ckdb9.feishu.cn/wiki/TTpHwGfvwi3HC0kEun9chuwVnPp?from=from_copylink
修改于 2025-11-12 03:45:53
上一页
选择对接方式
下一页
智书合同新用户流程差异
Built with