签署流程归档

更新时间:2020/11/23 14:33:31

接口描述

手动归档签署流程,归档后所有资源均不可修改。归档前签署流程中的所有签署人必须都签署完成。如创建流程时设置了自动归档,则无需调用本接口,签署完成后系统会自动调用。

接口

/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该参数需放在请求地址里面,可以参考【请求示例】

公共响应参数

参数名称

类型

必选

参数说明

示例值

codeint

业务码,0表示成功

messagestring

信息

dataobject

业务信息

请求示例  

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是正式环境的