契约锁 API
  1. 新手指南
契约锁 API
  • 平台简介
    • 平台简介
  • 新手指南
    • 接入流程
    • 名称解释
    • 接入示例
  • API协议
    • API协议
  • API文档
    • 合同管理
      • 合同管理-创建合同草稿
      • 合同管理-用文件添加合同文档
      • 合同管理-多文件添加合同文档
      • 合同管理-用模板添加合同文档
      • 合同管理-发起合同
      • 合同管理-抄送合同
      • 合同管理-修改签署方
      • 合同管理-添加签署方
      • 合同管理-浏览页面
      • 合同管理-合同详情
      • 合同管理-获取合同列表
      • 合同管理-下载合同与附属文件
      • 合同管理-下载合同文档
      • 合同管理-强制结束合同
      • 合同管理-上传强制结束附件
      • 合同管理-合同文档添加水印
      • 合同管理-合同延期
      • 合同管理-获取合同操作记录
      • 合同管理-获取合同与附属文件下载链接
    • 签署服务
      • 签署服务-公章签署
      • 签署服务-签署法人章
      • 签署服务-审批
      • 签署服务-合同催签
      • 签署服务-签署页面
      • 签署服务-预签署页面
      • 签署服务-获取短链接
      • 签署服务-撤回/作废合同
      • 签署服务-自定义文件作废合同
      • 签署服务-自定义模板文件作废合同
      • 签署服务-签署作废合同
      • 签署服务-签署个人签名
    • 组织架构
      • 组织架构-子公司列表
      • 组织架构-发送子公司邀请
      • 组织架构-移除子公司
      • 组织架构-对接方信息
      • 组织架构-公司详情
      • 组织架构-获取企业信息变更链接
      • 组织架构-员工列表
      • 组织架构-添加员工
      • 组织架构-更新员工
      • 组织架构-员工详情
      • 组织架构-管理员工角色
      • 组织架构-移除员工
    • 印章管理
      • 印章管理-印章列表
      • 印章管理-印章图片
      • 印章管理-创建印章
      • 印章管理-印章详情
      • 印章管理-编辑印章
      • 印章管理-创建图片印章
      • 印章管理-管理印章状态
      • 印章管理-删除印章
      • 印章管理-公司印章
    • 模板管理
      • 模板管理-模板列表
      • 模板管理-模板详情
      • 模板管理-模版预览页面
      • 模板管理-创建Word模板
      • 模板管理-编辑模板
      • 模板管理-管理模板状态
      • 模板管理-下载模板
      • 模板管理-删除模板
    • 业务分类
      • 业务分类-业务分类列表
      • 业务分类-业务分类详情
    • 个人认证
      • 个人认证-获取个人认证链接
      • 个人认证-查询个人认证状态
    • 企业认证
      • 企业认证-获取企业认证链接PC
      • 企业认证-获取企业认证链接H5
      • 企业认证-获取企业认证链接-带营业执照PC
      • 企业认证-获取企业认证链接-带营业执照H5
      • 企业认证-查询认证结果
    • 外部客户
      • 外部客户-新增外部客户
    • 授权管理
      • 授权管理-单点登录模块授权页面
      • 授权管理-个人签名授权页面
      • 授权管理-取消个人签名授权
      • 授权管理-查询个人静默签授权记录
    • 辅助工具
      • 辅助工具-文件验签
    • 信息校验
      • 信息校验-个人身份校验
      • 信息校验-企业身份校验
  • 单点登录集成
    • 集成流程说明
    • 单点登录
    • 单点登出
    • CAS验证接口规范
  • JS SDK文档
    • JS SDK简介
    • 集成方式说明
    • 对接方服务端接口说明
  • 公告
    • 关于开发平台控制台的说明
  • 小程序插件
    • 插件简介
    • 插件集成说明
    • 生成合同签署令牌
    • 生成个人认证令牌
    • 生成企业认证令牌
    • 生成企业认证令牌(带营业执照)
    • 插件更新记录
  • 常见问题
    • 认证问题
    • 配置问题
    • 接口问题
    • 其他问题
  1. 新手指南

名称解释

契约锁开放平台结合业务分类配置,实现合同的创建、签署流程。下面通过介绍合同的关键组成元素和业务分类相关配置,帮助用户深入理解合同创建流程。

1 合同#

合同是契约锁电子签章的基本单位,下图展示了合同的关键组成元素。
image.png

1.1 合同文档#

简介:合同文档是合同的必要组成部分,在发起合同前必须指定。
生成方式:
(1)自动生成:在业务分类中配置合同模板,调用接口“创建合同草稿”时,会自动把模板转换为合同文档;
(2)主动添加:在“创建合同草稿”后、“发起合同”前,调用接口“添加合同文档”生成合同文档;

1.2 签署方#

简介:签署合同的主体。按签署方属性分为公司和个人两种类型;按是否为发起方分为发起方和接收方两种类型。
生成方式:
调用接口“创建合同草稿”时传入签署方信息,生成签署方。

1.2.1 经办人#

简介:签署方的联系人。合同签署流程流转到签署方时,契约锁发送消息给经办人,经办人通知实际签署人签署合同。
(1)对于个人签署方,经办人即为签署方本人。
(2)对于公司签署方,发起方无需指定经办人(经办人即为合同发起人);接收方必须指定经办人,用于接收签署消息。
生成方式:
调用接口“创建合同草稿”时传入经办人信息。

1.2.2 签署动作#

简介:签署方需要对合同进行的操作。别名有 签署流程、签署要求、签署节点。
类型:签署公章、签署法人章、经办人签署、审批、个人签名。其中“个人签名”属于个人签署方,其他四个类型属于公司签署方。
生成方式:
(1)自动生成:在业务分类中“预设签署方”(发起方需要“预设内部流程”),调用接口“创建合同草稿”时,会匹配对应的签署动作(包括其下的印章、操作人、签署位置),自动生成。
(2)主动添加:在业务分类中“不预设签署方”(发起方“不预设内部流程”),调用接口“创建合同草稿”时,传入签署动作(包括操作人、印章和签署位置等),主动生成。
1.2.2.1 操作人#
简介:签署动作的执行人。只有“签署公章”、“审批”这两种签署动作可以设置操作人。所有签署动作均可登录契约锁平台执行。
以下针对不同类型签署动作,对操作人介绍:
(1)签署公章:如果指定操作人,则只有操作人可以签署合同。如果未指定操作人、指定了公章,则操作人是有公章权限的人。如果未指定操作人、未指定公章,则操作人是公章管理员。发起方可以通过接口签署公章。
(2)签署法人章:操作人是法人和有法人章使用权限的人。发起方可以通过接口签署法人章。
(3)经办人签署:操作人是经办人。
(4)审批:需要指定操作人。只有发起方可以指定此类型。发起方可以通过接口审批。
(5)个人签名:操作人是签署方本人。
1.2.2.2 印章、签署位置#
简介:操作人在签署合同时的两个必需元素。印章用于指定签署外观,签署位置用于定位签署的坐标。
(下面所说的个人签名、法人章、公章均指印章)
印章:
(1)公章:如果创建合同时指定了公章,签署时只能使用此公章,如果未指定,则操作人签署时可以签所有有权限的公章。
(2)个人签名:不能指定个人签名。
(3)法人章:不能指定法人章。法人章最多只有一个。
签署位置:
(1)如果签署合同前已指定签署位置,签署时默认使用指定的签署位置;如果未指定,用户自由拖动选择签署位置。
(2)发起方通过接口签署,如果指定签署位置,默认使用指定的签署位置;如果未指定,必须传签署位置参数。

2 业务分类#

2.1 配置流程#

(1)登录契约锁云平台(生产环境地址: https://cloud.qiyuesuo.com, 测试环境地址: https://cloud.qiyuesuo.cn)。
(2)进入左侧目录 “文件 -> 业务分类” ,新建业务分类。
(3)点击业务分类右上角的“高级配置”,进入配置页。

2.2 配置项介绍#

2.2.1 基础信息设置#

2.2.1.1 签署方#
配置签署方的签署动作以及签署顺序。
(1)预设签署方(选择“按预设方式添加签署方”):创建合同时,接口传入的签署方必须与配置的签署方一致(数量、类型一致),并且会使用配置的签署动作,接口无需传签署动作。
预设签署方的优点是可以使用配置的签署动作,以及其下的签署位置。
(2)非预设签署方(选择“经办人发合同时任意填写”):创建合同时,接口传入任意类型、数量的签署方,签署动作需要主动设置。
注:由于发起方可以设置印章和操作人,所以发起方的签署动作在 “2.2.2 签署流程设置” 中单独配置。
2.2.1.2 合同模板#
配置的合同模板,在接口创建合同时,将转换为合同文档。

2.2.2 签署流程设置#

2.2.2.1 内部流程设置#
配置发起方的签署动作。
(1)预设签署流程(选择“按预设流程”):创建合同时,发起方将使用配置的签署动作,以及其下的印章、操作人、签署位置。
(2)非预设签署流程(选择“按默认流程”):创建合同时, 需要主动传入签署动作。

2.2.3 指定签署位置#

配置签署动作的签署位置。
配置项“允许在指定位置之外签署”:选择是,则用户签署时可以自由拖动签署位置;选择否,则用户签署时只能使用指定的签署位置。
注:指定的签署位置生效的前提是:使用配置的签署动作,即预设签署方、预设签署流程。

2.2.4 参数设置#

指定模板参数由哪个签署方填写、指定模板参数是否必填。

2.2.5 回调设置#

合同在签署过程中,若发生签署、拒绝签署、撤回、退回等事件时,契约锁会回调通知对接方。
需要设置回调地址来实现此功能。
上一页
接入流程
下一页
接入示例
Built with