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

用户身份体系

不同类型的用户 ID#

系统在不同的层次对用户身份做了隔离,以保证用户的数据安全。整体来说用户身份有以下几种类型:
用户在租户内的身份(xxx_user_id)
用户在同一应用服务商所开发的多个应用下的统一身份( xxx_union_id)
ID是否支持定义
user_id(与智书合同之外的三方系统对接,目前只能选这种方式)支持,需单独授权自建应用用户从飞书组织架构内获取的user_id
open_id不支持用户从飞书组织架构内获取的open_id,(在对接智书合同时)无意义,不能用
lark_user_id(限自建应用版智书合同)支持用户从飞书组织架构内获取的user_id。注意:仅限客户使用自建应用的智书合同时,而不是使用ISV应用的合同时
lark_open_id不支持用户从飞书组织架构内获取的open_id,(在对接智书合同时)无意义,不能用
lark_union_id(限智书内部)支持用户从飞书组织架构内获取的union_id。注意:仅限智书企飞ISV应用调用(如烽火CRM)
union_id(限与智书内部SaaS服务对接,比如:烽火)支持,需单独授权自建应用用户从飞书组织架构内获取的union_id
zs_user_id当前不支持,后续支持用户从智书组织架构内获取的zs_user_id
zs_open_id当前不支持,后续支持用户从智书组织架构内获取的zs_open_id
zs_union_id当前不支持,后续支持用户从智书组织架构内获取的zs_union_id

相关查询参数#

名称类型必填描述
user_id_typestring是用户ID类型 详情参考:用户身份体系。示例值:"user_id"。可选值有:
- user_id:标识一个用户在某个租户内的身份。同一个用户在租户A和租户B内的User ID是不同的。在同一个租户内,一个用户的User ID在所有应用(包括商店应用)中都保持一致。User ID主要用于在不同的应用间打通用户数据。
- union_id:标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的Union ID是相同的,在不同开发商下的应用中的Union ID是不同的。通过Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。
修改于 2025-11-12 05:55:56
上一页
应用鉴权
下一页
选择对接方式
Built with