流程文档下载

更新时间:2021/08/05 16:32:17

接口描述

流程归档后,查询和下载签署后的文件。

接口

/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小时;该链接建议只用于下载,不要直接预览


请求示例  

GET https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/documents

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "docs":[
            {
                "fileId":"01e50a9cedb74493a2d320b4f4732a29",
                "fileName":"第一份合同.pdf",
                "fileUrl":"https://esignoss.oss-cn-hangzhou.aliyuncs.com/1111563786/4a68f87e-9a65-4dbc-84f4-8880da388aa4/%E5%8A%B3%E5%8A%A8%E5%90%88%E5%90%8C%E4%B9%A6.pdf?Expires=1560774752&OSSAccessKeyId=LTAIdvHfiVrzDKbE&Signature=rxDqsTOGuRA6NwKvneYlqKDFnS4%3D"
            }
        ]
    }
}

错误码

错误码

错误描述

解决方案