接口描述
开启签署流程，签署任务会自动按照设置开始流转。
注意：
（1）签署流程开启后，不能删除流程已关联的文档。
（2）签署流程开启后，不能向流程再新添加文档。
（3）签署流程内 autoArchive 参数值设置true（自动结束）时，流程开启后，不能增加签署区。
（4）签署流程内 autoArchive 参数值设置false（非自动结束）时，流程开启后且未结束，允许增加签署区。
接口
/v1/signflows/{flowId}/start
请求方式
PUT
请求头
提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权（优先推荐）
请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
X-Tsign-Open-App-Id | string | 是 | 项目ID | |
Content-Type | string | 是 | application/json;charset=UTF-8 | |
X-Tsign-Open-Ca-Timestamp | string | 是 | API 调用者传递时间戳，值为当前时间的毫秒数，也就是从1970年1月1日起至今的时间转换为毫秒，时间戳有效时间为15分钟，为了防重放攻击 | |
Accept | string | 是 | 建议统一填写 */* | |
X-Tsign-Open-Ca-Signature | string | 是 | 签名字符串 | |
Content-MD5 | string | 否 | 当请求 Body 非 Form 表单时，可以计算 Body 的 MD5 值传递给云网关进行 Body MD5 校验。建议当请求 Body 非 Form 表单时，加上此请求头。 | |
X-Tsign-Open-Auth-Mode | string | 是 | 选择请求方式进行鉴权，固定值，Signature |
方式二：OAuth2.0鉴权（不推荐使用）
当安全接入选择OAuth2.0鉴权方式，请点击查阅详情，请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 项目ID |
X-Tsign-Open-Token | string | 是 | 通过获取鉴权Token接口返回 |
Content-Type | string | 是 | application/json; charset=UTF-8 |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 | 示例值 |
flowId | string | 是 | path | 流程id |
公共响应参数
参数名称 | 类型 | 必选 | 参数说明 | 示例值 |
code | int | 是 | 业务码，0表示成功 | |
message | string | 否 | 信息 | |
data | object | 否 | 业务信息 |
请求示例
PUT https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/start
响应示例
{
"code":0,
"message":"成功",
"data":null
}错误码
错误码 | 错误描述 | 解决方案 |
1437108 | 非草稿状态不允许开启流程 | 流程不是草稿状态, 已经发起或已经完结 |
1437109 | 流程没有文档不允许开启流程 | 流程没有添加签署文档, 不能开启流程 |
1437110 | 流程没有签署区不允许开启流程 | 签署流程自动结束场景下, 流程还没有添加签署区, 不能开启流程 |
1435404 | 机构账户中签署份数不足，请购买套餐后再操作 | 当前机构签署份数不足且当前操作用户是机构管理员 |
1435405 | 机构账户中签署份数不足，请联系管理员（%s，%s）购买套餐后再操作 | 当前机构签署份数不足且当前操作用户不是机构管理员 |
1435403 | 账户中签署份数不足，请购买套餐后再操作 | 当前个人账户签署份数不足 |
401 | 1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应，例如apiurl是模拟环境，应用ID是正式环境的 |
我要纠错