e签宝

https://open.esign.cn/doc/opendoc/
Admin
e签宝是一个电子签名和实名认证开放平台，提供合同签署、身份认证、区块链存证等能力，帮助开发者快速接入电子签名服务。
Tokens:88,420
Snippets:283
Trust Score:9.2
Update:12 hours ago
Show doc for...
Tokens:
Raw
### GET /v3/sign-templates/detail

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/uir8r6eorxqxhb5n

查询流程模板详情。该接口用于获取指定流程模板的详细信息。

```APIDOC
## GET /v3/sign-templates/detail

### Description
查询流程模板详情。该接口用于获取指定流程模板的详细信息。

### Method
GET

### Endpoint
/v3/sign-templates/detail

### Error Codes
| code | message |
| --- | --- |
| 1451006 | 用户未授权:%s,%s |
| 1451026 | 流程模板不存在 |
| 1451043 | 模板不属于该企业，无法操作 |
```

--------------------------------

### GET /v3/sign-templates/permission

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/uir8r6eorxqxhb5n

查询用户在某企业下能否编辑或使用某流程模板。该接口用于校验用户对指定流程模板的编辑或使用权限。

```APIDOC
## GET /v3/sign-templates/permission

### Description
查询用户在某企业下能否编辑或使用某流程模板。该接口用于校验用户对指定流程模板的编辑或使用权限。

### Method
GET

### Endpoint
/v3/sign-templates/permission

### Error Codes
| code | message |
| --- | --- |
| 1451006 | 用户未授权:%s,%s |
| 1451026 | 流程模板不存在 |
| 1451043 | 模板不属于该企业，无法操作 |
```

--------------------------------

### GET /v3/sign-templates

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/uir8r6eorxqxhb5n

查询流程模板列表。该接口用于获取当前用户可用的流程模板列表。

```APIDOC
## GET /v3/sign-templates

### Description
查询流程模板列表。该接口用于获取当前用户可用的流程模板列表。

### Method
GET

### Endpoint
/v3/sign-templates

### Error Codes
| code | message |
| --- | --- |
| 1451006 | 用户未授权:%s,%s |
```

--------------------------------

### HTTPHelper class for sending HTTP requests

Source: https://open.esign.cn/doc/opendoc/dev-guide3/tggw2e

A Java class that provides HTTP request sending capabilities, likely including GET and POST methods. It uses slf4j for logging and includes imports for HTTPURLConnection, URL, and other networking classes. This is the HTTPHelper class referenced in the earlier GET request example.

```java
package esign.gateway.demo;

import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.UnknownHostException;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map.Entry;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HTTPHelper {
  // slf4j日志记录器
  private static final Logger LOG = LoggerFactory.getLogger(HTTPHelper.class);
```

--------------------------------

### POST /v3/sign-templates/enable

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/uir8r6eorxqxhb5n

开启流程模板。该接口用于启用一个流程模板，使其可以被使用。

```APIDOC
## POST /v3/sign-templates/enable

### Description
开启流程模板。该接口用于启用一个流程模板，使其可以被使用。

### Method
POST

### Endpoint
/v3/sign-templates/enable

### Error Codes
| code | message |
| --- | --- |
| 1451006 | 用户未授权:%s,%s |
| 1451021 | 当前操作人无权限操作模板 |
| 1451026 | 流程模板不存在 |
| 1451042 | 共享模板不支持该操作 |
| 1451043 | 模板不属于该企业，无法操作 |
```

--------------------------------

### Java HttpURLConnection 发送 GET 请求 (sendGET)

Source: https://open.esign.cn/doc/opendoc/dev-guide3/yx5a3g7og2962aqi

使用 HttpURLConnection 发送 GET 请求，设置请求头，处理响应状态码，并读取响应内容。包含异常处理和资源释放。

```java
      // 建立连接
      URL url = new URL(fullUrl.toString());
      httpURLConnection = (HttpURLConnection) url.openConnection();
      // 需要输出
      httpURLConnection.setDoOutput(true);
      // 需要输入
      httpURLConnection.setDoInput(true);
      // 不允许缓存
      httpURLConnection.setUseCaches(false);
      // HTTP请求方式
      httpURLConnection.setRequestMethod("GET");
      // 设置Headers
      if (null != headers) {
        for (String key : headers.keySet()) {
          httpURLConnection.setRequestProperty(key, headers.get(key));
        }
      }
      // 连接会话
      httpURLConnection.connect();
      // 获得响应状态(HTTP状态码)
      http_StatusCode = httpURLConnection.getResponseCode();
      // 获得响应消息(HTTP状态码描述)
      http_RespMessage = httpURLConnection.getResponseMessage();
      // 获得响应内容
      if (HttpURLConnection.HTTP_OK == http_StatusCode) {
        // 返回响应结果
        http_RespContent = getResponseContent(httpURLConnection);
      } else {
        // 返回非200状态时响应结果
        http_RespContent = getErrorResponseContent(httpURLConnection);
        String msg =
            MessageFormat.format("请求失败: Http状态码 = {0} , {1}", http_StatusCode, http_RespMessage);
        LOG.info(msg);
      }
    } catch (UnknownHostException e) {
      String message = MessageFormat.format("网络请求时发生异常: {0}", e.getMessage());
      Exception ex = new Exception(message);
      ex.initCause(e);
      throw ex;
    } catch (MalformedURLException e) {
      String message = MessageFormat.format("格式错误的URL: {0}", e.getMessage());
      Exception ex = new Exception(message);
      ex.initCause(e);
      throw ex;
    } catch (IOException e) {
      String message = MessageFormat.format("网络请求时发生异常: {0}", e.getMessage());
      Exception ex = new Exception(message);
      ex.initCause(e);
      throw ex;
    } catch (Exception e) {
      String message = MessageFormat.format("网络请求时发生异常: {0}", e.getMessage());
      Exception ex = new Exception(message);
      ex.initCause(e);
      throw ex;
    } finally {
      if (null != httpURLConnection) {
        httpURLConnection.disconnect();
      }
    }
    return http_RespContent;
  }
```

--------------------------------

### GET /v3/seals/org-authorized-seal-list

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/gqgb0gwznb2su405

查询被外部企业授权的印章列表，支持分页查询。需要提供企业ID（orgId）以及分页参数（pageNum、pageSize）。

```APIDOC
## GET /v3/seals/org-authorized-seal-list

### Description
查询被外部企业授权的印章列表，支持分页查询。

### Method
GET

### Endpoint
/v3/seals/org-authorized-seal-list

### Parameters
#### Query Parameters
- **orgId** (string) - Required - 企业ID
- **pageNum** (integer) - Required - 页码
- **pageSize** (integer) - Required - 每页大小

### Response
#### Success Response (200)
- 返回被授权印章列表（具体字段未在文档中说明）

#### Error Codes
| code | message |
| --- | --- |
| 1000000 | %s |
| 10000001 | 系统异常，请重试或联系e签宝服务人员 |
| 10000007 | 参数错误 :%s |
| 31410044 | 分页查询印章列表异常，请重试或联系e签宝服务人员 |
| 1499000 | 用户未授权： %s（用户id）, %s（scope） |
```

--------------------------------

### GET /v3/seals/psn-seal-info

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/gqgb0gwznb2su405

查询指定印章详情（个人）接口的错误码列表。

```APIDOC
## GET /v3/seals/psn-seal-info

### Description
查询指定印章详情（个人）。

### Method
GET

### Endpoint
/v3/seals/psn-seal-info?psnId=xx&sealId=xx

### Error Codes
| code | message |
| --- | --- |
| 1000000 | %s |
| 10000001 | 系统异常，请重试或联系e签宝服务人员 |
| 10000007 | 参数错误 :%s |
| 31400109 | 印章不属于该账号 |
| 1499000 | 用户未授权： %s（用户id）, %s（scope） |
```

--------------------------------

### POST /v3/sign-templates/sign-template-create-url

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/uir8r6eorxqxhb5n

获取《创建流程模板》页面链接。该接口用于获取创建流程模板的页面链接，以便用户跳转到页面进行模板创建。

```APIDOC
## POST /v3/sign-templates/sign-template-create-url

### Description
获取《创建流程模板》页面链接。该接口用于获取创建流程模板的页面链接，以便用户跳转到页面进行模板创建。

### Method
POST

### Endpoint
/v3/sign-templates/sign-template-create-url

### Error Codes
| code | message |
| --- | --- |
| 1451000 | 参数错误:%s |
| 1451002 | 服务异常 |
| 1451004 | 应用不存在 |
| 1451006 | 用户未授权:%s,%s |
| 1451029 | 成员不在该组织 |
| 1451021 | 当前操作人无权限操作模板 |
```

--------------------------------

### GET /v3/seals/psn-seal-list

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/gqgb0gwznb2su405

查询个人印章列表接口的错误码列表。

```APIDOC
## GET /v3/seals/psn-seal-list

### Description
查询个人印章列表。

### Method
GET

### Endpoint
/v3/seals/psn-seal-list?psnId=xx&pageNum=1&pageSize=20

### Error Codes
| code | message |
| --- | --- |
| 1000000 | %s |
| 10000001 | 系统异常，请重试或联系e签宝服务人员 |
| 10000007 | 参数错误 :%s |
| 31410044 | 分页查询印章列表异常，请重试或联系e签宝服务人员 |
| 1499000 | 用户未授权： %s（用户id）, %s（scope） |
```

--------------------------------

### GET /v3/seals/org-seal-info

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/gqgb0gwznb2su405

查询指定印章的详情（机构）。需要提供企业ID（orgId）和印章ID（sealId）。

```APIDOC
## GET /v3/seals/org-seal-info

### Description
查询指定印章的详情（机构）。

### Method
GET

### Endpoint
/v3/seals/org-seal-info

### Parameters
#### Query Parameters
- **orgId** (string) - Required - 企业ID
- **sealId** (string) - Required - 印章ID

### Response
#### Success Response (200)
- 返回印章详情（具体字段未在文档中说明）

#### Error Codes
| code | message |
| --- | --- |
| 1000000 | %s |
| 10000001 | 系统异常，请重试或联系e签宝服务人员 |
| 10000007 | 参数错误 :%s |
| 31400109 | 印章不属于该账号 |
| 1499000 | 用户未授权： %s（用户id）, %s（scope） |
```

--------------------------------

### POST /v3/sign-flow/create-by-sign-template

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/uir8r6eorxqxhb5n

通过流程模板创建合同拟定和签署流程。该接口用于发起一个新的签署流程，基于指定的流程模板，并设置参与方、控件等信息。

```APIDOC
## POST /v3/sign-flow/create-by-sign-template

### Description
通过流程模板创建合同拟定和签署流程。该接口用于发起一个新的签署流程，基于指定的流程模板，并设置参与方、控件等信息。

### Method
POST

### Endpoint
/v3/sign-flow/create-by-sign-template

### Error Codes
| code 错误码 | message 错误信息 |
| --- | --- |
| 1451000 | 参数错误: chargeMode无对应枚举值 |
| 1451000 | 参数错误: orderType无对应枚举值 |
| 1451000 | 参数错误: 签署方付费模式仅支持使用渠道套餐，请调整后重试 |
| 1451000 | 参数错误: 通知方式不支持 |
| 1451000 | 参数错误: 签署终端类型不支持 |
| 1451000 | 参数错误: 签署截止时间signFlowExpireTime不能超过发起后90天 |
| 1451000 | 参数错误: 流程过期时间signFlowExpireTime不能早于当前时间 |
| 1451000 | 参数错误: 同一个参与方，个人和机构不能同时为空或同时传值 |
| 1451000 | 参数错误: 个人参与方psnId、psnAccount不能同时传值或同时为空 |
| 1451000 | 参数错误: 个人参与方psnId、psnName不能同时传值 |
| 1451000 | 参数错误: 企业参与方orgId、orgName不能同时传值或同时为空 |
| 1451000 | 参数错误: 企业参与方经办人transactorPsnId、transactorPsnAccount不能同时传值或同时为空 |
| 1451000 | 参数错误: 企业参与方经办人transactorPsnAccount、transactorName必须同时传值 |
| 1451000 | 参数错误: 企业参与方经办人transactorPsnId、transactorName不能同时传值 |
| 1451000 | 参数错误: 企业参与方与经办人传入必须为orgId与transactorPsnId或orgName与transactorPsnAccount |
| 1451000 | 参数错误: 参与方participantId不能重复 |
| 1451000 | 参数错误: 参与方个人账号xxx姓名不统一 |
| 1451000 | 参数错误: copierPsnInfo不能为空 |
| 1451000 | 参数错误: 抄送人psnId、psnAccount不能同时传值或同时为空 |
| 1451000 | 参数错误: 机构抄送方orgId、orgName不能同时传值或同时为空 |
| 1451000 | 参数错误: 个人抄送方、机构抄送方必须都传id或者账号 |
| 1451000 | 参数错误: componentId和componentKey不能同时传值或同时为空 |
| 1451000 | 参数错误: 控件id或控件key不能重复 |
| 1451000 | 参数错误: 参与方未指定,participantId:xxx<br>（场景：指定参与方少传漏传） |
| 1451000 | 参数错误: 模板设定参与方类型不匹配,participantId:xxx<br>(场景：模板设定参与方为个人，传参指定为企业) |
| 1451000 | 参数错误: 模板存在参与方为发起人本人，不支持平台方发起 |
| 1451000 | 参数错误: 参与方信息无需指定 |
| 1451000 | 参数错误: 参与方信息未指定<br>（场景：指定参与方未传） |
| 1451000 | 参数错误: 使用模板指定参与方不存在,participantId:xxxx |
| 1451000 | 参数错误: 发起人必须为个人账号,xxx |
| 1451000 | 参数错误: 企业发起方必须为企业,xxx |
| 1451000 | 参数错误: 个人参与方必须为个人,xxx |
| 1451000 | 参数错误: 企业参与方经办人必须为个人,xxx |
| 1451000 | 参数错误: 企业参与方必须为企业,xxx |
| 1451000 | 参数错误: 抄送人必须为个人,xxx |
| 1451000 | 参数错误: 企业抄送方必须为企业,xxx |
| 1451056 | 当前使用的模板中不支持预填填写控件 |
| 1451005 | 附件ID重复：%s |
| 1451009 | 流程模板数据异常：流程模板拥有者不匹配<br>（场景：企业B使用企业A模板发起） |
| 1451009 | 流程模板校验使用权限未通过:企业成员不存在<br>（场景：非企业成员使用模板发起） |
| 1451009 | 流程模板校验使用权限未通过:发起方没有该模板的使用权限<br>（场景：企业内成员无使用权限发起） |
| 1451009 | 模板非启用状态,请先启用此模板<br>（场景：模板处于停用关闭状态不可以使用） |
| 1451009 | 模板已被删除，无法使用<br>（场景：模板已被删除，无法使用模板id不存在或删除） |
| 1451006 | 用户未授权:%s,%s |
| 1451008 | 账号不存在或已注销,xxx |
| 1451010 | 签署方付费模式不支持当前售卖方式，仅组合计费生效 |
| 1451010 | 暂不支持个人发起方付费 |
| 1451010 | 用户未授权: xxx,org\_initiate\_sign |
| 1451010 | 用户未授权: xxx,psn\_initiate\_sign |
| 1451010 | 用户未授权: xxx,use\_org\_order |
| 1451010 | 发起方账号xxx未实名 |
| 1451010 | 签署人账号未注册，signerAccountId:xxx |
| 1451010 | 签署主体账号未注册，authorizedAccountId:xxx |
| 1451010 | 企业账户中电子合同份数不足，请购买套餐后再操作 |
| 1451010 | 企业账户中电子合同份数不足，请联系管理员（xxx）购买套餐后再操作 |
| 1451011 | 签署方付费模式不支持当前售卖方式，仅组合计费生效 |
| 1451011 | 暂不支持个人发起方付费 |
| 1451011 | 用户未授权: xxx,org\_initiate\_sign |
| 1451011 | 用户未授权: xxx,psn\_initiate\_sign |
| 1451011 | 用户未授权: xxx,use\_org\_order |
| 1451011 | 发起方账号xxx未实名 |
| 1451011 | 签署人账号未注册，signerAccountId:xxx |
| 1451011 | 签署主体账号未注册，authorizedAccountId:xxx |
| 1451011 | 企业账户中电子合同份数不足，请购买套餐后再操作 |
| 1451011 | 企业账户中电子合同份数不足，请联系管理员（xxx）购买套餐后再操作 |
| 1451012 | 控件不属于此模板文件: 控件ID: xxx;文件ID:xxx |
| 1451012 | 预填写控件不存在：控件ID: xxx;文件ID:xxx |
| 1451012 | 填写内容不合规: 控件'日期'不符合预设日期格式: yyyy-MM-dd |
| 1451012 | 填写内容不合规: 控件'数字'不符合预设数字格式:0 |
| 1451012 | 存在不支持预填的控件类型，请核对后重试：控件ID: xxx;文件ID:xxx |
```

--------------------------------

### GET /v3/seals/org-seals/external-auth

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/gqgb0gwznb2su405

查询对外部企业授权详情。该接口用于查询机构印章对外部企业的授权详情，支持分页。

```APIDOC
## GET /v3/seals/org-seals/external-auth

### Description
查询对外部企业授权详情。

### Method
GET

### Endpoint
/v3/seals/org-seals/external-auth

### Parameters
#### Query Parameters
- **orgId** (string) - Required - 组织ID
- **pageNum** (integer) - Required - 页码
- **pageSize** (integer) - Required - 每页大小
- **sealId** (string) - Required - 印章ID

### Response
#### Success Response (200)
- 无明确响应字段说明

#### Error Codes
| code | message |
| --- | --- |
| 1000000 | %s |
| 10000001 | 系统异常，请重试或联系e签宝服务人员 |
| 10000007 | 参数错误 :%s |
| 31410001 | 获取用户信息异常，请重试或联系e签宝服务人员 |
| 1499000 | 用户未授权： %s（用户id）, %s（scope） |
| 31401001 | 当前操作人既不是管理员，也不是法人，无权操作 |
| 72000051 | 组织架构不存在. %s |

```

--------------------------------

### POST /v3/sign-templates/copy

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/uir8r6eorxqxhb5n

复制流程模板。该接口用于复制一个现有的流程模板，生成一个新的模板。

```APIDOC
## POST /v3/sign-templates/copy

### Description
复制流程模板。该接口用于复制一个现有的流程模板，生成一个新的模板。

### Method
POST

### Endpoint
/v3/sign-templates/copy

### Error Codes
| code | message |
| --- | --- |
| 1451006 | 用户未授权:%s,%s |
| 1451021 | 当前操作人无权限操作模板 |
| 1451026 | 流程模板不存在 |
| 1451042 | 共享模板不支持该操作 |
| 1451043 | 模板不属于该企业，无法操作 |
| 1451067 | 复制流程模板失败: %s |
```

--------------------------------

### GET /v3/seals/org-own-seal-list

Source: https://open.esign.cn/doc/opendoc/codemsg-v3/gqgb0gwznb2su405

查询企业内部印章列表，支持分页查询。需要提供企业ID（orgId）以及分页参数（pageNum、pageSize）。

```APIDOC
## GET /v3/seals/org-own-seal-list

### Description
查询企业内部印章列表，支持分页查询。

### Method
GET

### Endpoint
/v3/seals/org-own-seal-list

### Parameters
#### Query Parameters
- **orgId** (string) - Required - 企业ID
- **pageNum** (integer) - Required - 页码
- **pageSize** (integer) - Required - 每页大小

### Response
#### Success Response (200)
- 返回印章列表（具体字段未在文档中说明）

#### Error Codes
| code | message |
| --- | --- |
| 1000000 | %s |
| 10000001 | 系统异常，请重试或联系e签宝服务人员 |
| 10000007 | 参数错误 :%s |
| 31410044 | 分页查询印章列表异常，请重试或联系e签宝服务人员 |
| 1499000 | 用户未授权： %s（用户id）, %s（scope） |
```
Tokens:
Raw