接口描述
流程结束后，查询签署完成的文件下载链接。
接口
/v1/signflows/{flowId}/documents
请求方式
GET
请求头
提供两种安全接入方式，开发者可选择其中一种方式进行对接，对应参数如何获取，参考文档【请点击】。
方式一：请求签名鉴权（优先推荐）
请求头入参示例如下：
参数名称 | 类型 | 必选 | 参数说明 |
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 | 否 | 业务信息 |
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | |
docs | array | 否 | 文档列表数据 | |
fileId | string | 否 | 文档id | |
fileName | string | 否 | 文档名称,默认文件名称 | |
fileUrl | string | 否 | 文档地址, 有效时间1小时； 该链接建议只用于下载，不要直接预览 | |
ctType | int | 否 | 合同类型（预留字段，开发者可忽略此字段） | |
ctRescindStatus | int | 否 | （预留字段，开发者可忽略此字段） | |
flowId | string | 否 | （预留字段，开发者可忽略此字段） | |
ctRescindProcessId | string | 否 | （预留字段，开发者可忽略此字段） | |
fileFlowRelationBeanList | string | 否 | （预留字段，开发者可忽略此字段） | |
请求示例
GET https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/documents
响应示例
{
"code": 0,
"message": "成功",
"data": {
"docs": [
{
"fileId": "c8b8d909bdbf4de3b6f99edbfc52b6xx",
"fileName": "xx劳动合同.pdf",
"fileUrl": "https://esignoss.esign.cn/1111563786/c0cb34d5-1f9a-4dab-b3a7-c3b528229f1d/xx%E5%8A%B3%E5%8A%A8%E5%90%88%E5%90%8C.pdf?Expires=xx&OSSAccessKeyId=xx&Signature=xx%xx%3D",
"ctType": null,
"ctRescindStatus": null,
"flowId": null,
"ctRescindProcessId": null,
"fileFlowRelationBeanList": null
}
]
}
}
我要纠错