Skip to main content

API 接入流程

本指南详细介绍了开放签 API 的接入流程，涵盖开发者注册、企业认证、印章与模板配置、业务线设置及签署流程示例，帮助开发者高效集成电子合同签署能力。

以劳动合同签署场景为例，整体流程如下：

1. 成为开发者​

使用开放签 API 的前提是成为企业开发者，并获取 appAuthToken 和私钥。

1.1 注册并成为企业用户​

步骤 1：注册个人账号​

开放签支持手机号+短信验证码快速注册。

若手机号未注册，登录时会自动创建账号，初始密码为 123456，请及时修改。

注册个人账号

步骤 2：企业实名认证​

注册后登录系统，进行企业认证。若已完成企业认证可跳过。
企业认证流程操作说明

1.2 企业用户升级为开发者​

使用 admin 账号登录开放签系统，进入运营管理后台。

运营管理后台

  • 升级为核心企业
    核心企业可发起/接收合同，普通企业仅可被动接收。
    升级核心企业

  • 创建开发者授权凭证
    新增凭证 凭证配置

    若使用支付宝开放平台密钥工具，加密算法请选择“RSA2”。

    获取密钥

2. 调用 API 前期准备​

2.1 制作企业印章​

登录开放签账号，切换企业身份，进入【企业管理后台】→ 印章管理。

印章管理入口 印章管理页面

印章管理操作说明

2.2 配置签署文件模板​

进入模板管理，新增/修改模板。

如无需模板或已配置模板可跳过。
模板配置说明

  • 上传模板并配置基本信息
    上传模板

  • 模板控件配置
    拖拽控件到正文区域，配置属性。
    控件配置

2.3 配置业务线​

进入业务线管理，新增/修改业务线。
业务线说明

业务线管理

劳动合同签署示例场景：

  1. 企业与员工签署劳动合同
  2. 员工填写姓名、身份证号，其余由企业填写
  3. 签署流程：发起签署 → 员工完善合同 → 企业自动盖章 → 员工签署 → 完成
  4. 合同签署链接可通过短信/邮箱或接口获取

步骤 1：业务线创建​

业务线创建

步骤 2：业务线配置​

  • 签署方设置
    选择“经办人发起时，按照预设流程发起并签署”，配置内部签署流程，添加个人接收方。
    签署方设置 内部签署流程 添加接收方

  • 签约文件设置
    选择劳动合同模板。
    选择模板 模板选择确认

  • 位置及参数设置
    拖拽签署控件到文档，设置参数填写方。
    位置及参数设置

  • 通知设置
    通知设置

步骤 3：启用业务线​

配置完成后，点击“启用”。
启用业务线

3. 创建签署流程（以劳动合同为例）​

签署流程：

  1. 通过接口发起签署
  2. 员工填写合同
  3. 发起方自动签署
  4. 员工签署
  5. 签署完成

3.1 通过接口发起签署​

根据接口参数要求，调用发起签署接口，成功后返回 contractId。

详细接口及参数见“发起签署”接口文档。

示例请求参数：

{  "appAuthToken": "***",
  //应用授权凭证
  "uniqueCode": "***",
  //流水号，用于标识某笔业务
  "signReId": "***",
  //业务线id
  "sn": "000001",
  //合同编号
  "expireDate": "2046-10-30",
  //签署截止日期
  "subject": "劳动合同",
  //合同主题
  "send": "1",
  //1 直接发起
  "operator": { //发起方企业经办人信息，该经办人已经加入到开发者对应的企业中，并拥有业务线的使用权限
    "name": "***",
    "contactType": "MOBILE",
    "contact": "***" //手机号
  },
  "signTemplateParamList": [ //发起方填写的模板参数值，；
    {
      "templateId": "***",
      //模板id，获取模板ID：在企业管理后台->模板管理列表中拷贝模板ID
      "templateName": "劳动合同",
      //模板名称
      "templateParamList": [ //模板参数集合，在企业管理后台中下载对应的模板参数，筛选出需要发起方填写的参数集合
        {
          "paramKey": "service_period",
          //服务期限（年）
          "paramValue": "5" 
        },
        {
          "paramKey": "probation_period",
          //试用期（月）
          "paramValue": "3" 
        },
        {
          "paramKey": "post",
          //岗位
          "paramValue": "市场运营总监" 
        },
        {
          "paramKey": "salary",
          //年薪（万）
          "paramValue": "40" 
        }]
    }],
  "signerList": [ //签署方信息
    {
      "signerType": "RECEIVER_PERSONAL",
      //发起方：SENDER；企业接收方：RECEIVER_ENT；个人接收方：RECEIVER_PERSONAL  
      "signerOrder": "2",
      //签署顺序（业务线设置的顺序）
      "receiver": { //signerType为个人时，必传，员工的信息
        "name": "***",
        "contactType": "MOBILE",
        "contact": "***"
      }
    }]
}「

发起签署

3.2 员工填写合同​

员工可通过以下方式获取合同填写链接：

  1. 通过短信/邮箱通知（需在业务线通知配置中开启） 短信通知 邮箱通知
  2. 调用“获取合同短链接”接口 获取短链接

员工填写页面示例：
填写页面

3.3 发起方自动完成签署​

员工填写完成后，发起方自动签署。可登录开放签系统查看进度。

查看进度

3.4 员工签署合同​

发起方签署后，员工可通过短信/邮箱或短链接完成签署。

员工短信通知 员工短链接 员工签署页面

3.5 下载签约文件​

签署完成后，可在开放签平台查看详情、下载文件和签署报告。

下载文件

也可通过“下载签约文件”接口获取合同文件。

接口下载

服务热线
15010993257