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

外部校验

你在什么情况下能用到?#

当智书现有的表单校验无法满足业务校验场景时,可以请求外部业务系统的校验API来满足校验需求。
例如:采购单关联的中标供应商金额,是否小于预算余额。采购/预算等其他系统中的业务数据,智书合同侧无法判断,为了避免下游系统人工审阅业务数据,合同审批时被驳回,在提交合同时对提交的表单数据做校验,保证了合同关联的业务数据的有效性和审批效率。

可以帮你解决什么问题?#

请求外部系统的API
规定外部系统返回的响应,从响应体中取出报错信息和跳转链接

使用指南#

事前准备#

开发同学需根据「技术文档」一节的要求,开发相应API

入口#

image.png

配置API#

参考外部数据源的请求体,由流程配置的管理员进行配置
(后续会跟外部数据源请求配置保持一致)
image.png

API响应格式#

校验API响应的字段格式由智书合同侧定义,为固定格式

字段说明#

字段值类型示例说明
successBooleantrue/false是否通过校验
codeString500错误码,用于研发定位问题
errorMessageString采购单金额不能大于预算余额报错信息,呈现给表单提交人员
errorTitleString报错单据查看报错信息的跳转链接显示按钮
linkUrlStringhttp://srm.example.com/ticket?number=procument - 001aerrorTitle 关联的跳转链接,该链接的域名需要联系智书合同运维配置域名白名单
text1--(此处未提及具体信息,无明确说明)
text2--(此处未提及具体信息,无明确说明)
image.png

默认传递字段#

除页面上配置的字段外,还会额外传输一些默认字段。这里总结出来:

字段传输信息#

字段名称含义传输位置
contractId合同id请求体
contractNumber合同编号请求体
belongedDepartmentId合同所属部门id请求体
applier申请人id请求体
submitterUserId提交人id- 请求体
- query参数
- 路径参数
- header参数
submitterEmployeeCode提交人工号- 请求体
- query参数
- 路径参数
- header参数
示例:
修改于 2025-12-11 06:14:12
上一页
审批人回填
Built with