跳到主要内容

通过模板发起合同

流程图​

步骤1：在控制台配置模板，添加印章​

  • 模板管理 登录电子签控制台，模板管理模块，可以新增，编辑，预览模板。
  • 印章管理
  1. 登录电子签控制台，印章管理模板，可以创建和管理印章。
  2. 单击具体印章可以查看印章详情，使用情况，授权及授权人信息。

步骤2：获取模板信息​

通过查询模板 API 查询模板信息​

API 链接​

使用场景​

  • 当模板较多，或者模板中签署人配置，模板控件配置较多时，可通过该接口获取到模板的具体信息（名称，签署人配置信息，控件配置信息等）。
  • 当需要使用模板创建并发起签署流程时，可通过该接口便捷获取到模板的具体信息，用来完成后续通过模板创建合同的系列操作。

场景细化​

  • 查询指定模板信息
    参数名称必选参数类型参数描述
    Filters.N 否Array of Filter搜索条件，具体参考 Filter 结构体。
    本接口取值：
    template-id：按照模板唯一标识进行过滤。
    通过指定 Filters 的 key-value 键值来查询指定的模板信息。
  • 查询企业可用模板信息
  • 不指定 Filters 参数，可获取企业下全部模板信息。
  • 分页展示。

步骤3：通过模板创建签署流程​

API 链接​

使用场景​

基于选中的模板，基于模板配置创建签署流程。

  • 模板类型（单 B、单 C、B2C、B2B 和多方签署）。
  • 可以根据 步骤2 获取到的模板 recipients 判断是那种类型合同。

如何使用​

  • 基于 步骤2 获取到的模板信息，选择要使用的模板。

  • 根据选中要使用的模板构造签署人信息。

    参数名称必选参数类型参数描述
    Approvers.N是Array ofFlowCreateApprover签署流程参与者信息
    Operator是UserInfo操作人信息
    Agent否Agent应用相关信息
    Unordered否Boolean发送类型：
    true：无序签
    false：有序签
    注意：默认为 false（有序签），请和模板中的配置保持一致

  • 签署人信息：基于模板的 recipients 信息来构造。 构造签署人信息必须严格按照模板 recipients 顺序来构造。 

    -  由签署人信息的个数和类型来决定了合同属于那种类型（单 B、单 C、B2C、B2B 和多方签署）。
    -  签署人数目=1，签署人类型：企业，则发起单 B 签署合同。
    -  签署人数目=1，签署人类型：个人，则发起单 C 签署合同。
    -  签署人数目=2，签署人类型：企业+个人，则发起 B2C 合同。
    -  签署人数目=2，签署人类型：企业+企业，则发起 B2B 合同。
    -  依次规则，则可指定多方签署合同。

  • Unordered：基于模板定义的排序规则来构造。

如果使用静默签模板发起合同，必须保证静默签模板不能有填写控件。
  • 指定合同基本信息，完成签署流程创建。

执行结果​

获取到签署流程编号。

步骤4：创建签署流程电子文档​

API 链接​

使用场景​

为签署流程绑定电子文档并完成发起方控件填充。

如何使用​

参数名称必选参数类型参数描述
FlowId是String签署流程编号，由 CreateFlow 接口返回
TemplateId是String 用户上传的模板 ID
FileNames.N是Array of String 文件名列表，单个文件名最大长度200个字符
Operator是UserInfo无
Agent否Agent应用相关信息
FormFields.N否Array of FormField内容控件信息数组
NeedPreview否Boolean是否需要生成预览文件，默认不生成。
预览链接有效期300秒。
ClientToken否String客户端 Token，保持接口幂等性，最大长度64个字符
  • FlowId：步骤3 创建的签署流程编号。
  • TemplateId：步骤2 查询到并选择使用的模板 ID。
  • FormFields：步骤2 查询到并选择使用的模板的 Components 来构造。

    !

    • 这里的 FormFields 构建的是发起方的填写控件。
    • 签署方的填写控件无需在此处指定，在对应签署人去签署时，会要求先填写，后签署。

执行结果​

获取到签署流程电子文档编号。

步骤5：发起签署流程​

API 链接​

使用场景​

用来发起签署流程，发起后，签署人可以进行填写，签署。

如何使用​

参数名称必选参数类型参数描述
FlowId是String签署流程编号，由 CreateFlow 接口返回

FlowId：步骤3 创建的签署流程编号。

执行结果​

获取到发起的签署流程 ID，电子签控制台可看到合同信息。