文档变更
2022/01/11时，签署流程归档变为签署流程结束，以便开发者更容易理解，仅中文名称变更，其功能保持不变。
无特殊说明时，文档其他地方以及报错信息中的【归档】字样等同于【结束】。
接口描述
此接口用于结束签署流程，结束后的签署流程不允许再添加、删除签章区域，也不允许撤销签署流程。
注：
（1）签署流程中已添加签署方全部完成签章后才可以结束流程。
（2）结束签署流程后才允许调用【流程文档下载】接口下载已签章的文件。
（3）发起签署时 autoArchive 参数设置为true，全部签章完成时流程将自动结束，无需再调用此接口。
（4）发起签署时 autoArchive 参数设置为false，需要开发者主动调用此接口将签署流程状态变更为已结束。
接口地址
/v1/signflows/{flowId}/archive
请求方式
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/archive
响应示例
{
"code":0,
"message":"成功",
"data":null
}错误码
错误码 | 错误描述 | 解决方案 |
1437112 | 非开启状态不允许归档流程 | 不能归档状态不是签署中的流程 |
1437113 | 签署区没有全部完成 | 签署区没有全部完成签署, 不能归档 |
401 | 1.token过期了 2.header请求头不正确 3.apiurl和应用ID环境不对应，例如apiurl是模拟环境，应用ID是正式环境的 |
我要纠错