获取文件下载信息
获取文件下载信息
请求说明
请求地址 | https://openapi.wps.cn/v7/drives/{drive_id}/files/{file_id}/download |
---|---|
请求方法 | GET |
签名方式 | KSO-1 |
权限要求 | 查询和管理文件(应用授权) kso.file.readwrite 查询文件(应用授权) kso.file.read 查询和管理文件(用户授权) kso.file.readwrite 查询文件(用户授权) kso.file.read |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 参数类型 | 说明 |
---|---|---|
drive_id | string | 驱动盘 id |
file_id | string | 文件 id |
查询参数(Query)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
with_hash | boolean | 否 | 是否返回校验值,对应响应里的 hashes |
internal | boolean | 否 | 是否返回内部下载地址,默认为 false 内部服务支持内网传输请优先走内网 |
storage_base_domain | string | 否 | wps.cn / kdocs.cn 签发的存储网关地址会根据 base_domain 优先匹配 *.wps.cn / *.kdocs.cn 。为空会根据请求的 host 优先选择关联的 base_domain (注意:目前有些旧文件未被存储网关托管,针对这些文件的下载此参数可能失效) |
请求地址示例
[GET] https://openapi.wps.cn/v7/drives/{drive_id}/files/{file_id}/download?with_hash={boolean}&internal={boolean}&storage_base_domain={string}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ hashes | array[object] | 哈希信息 |
∟ ∟ sum | string | 哈希结果 |
∟ ∟ type | string[enum] | 哈希类型 sha256 ;md5 ;sha1 ;s2s |
∟ url | string | 下载地址 公网环境下,当返回地址一级域名为金山办公管理域名( wps.cn 或 kdocs.cn )时,调用下载地址时需要带与调用此申请地址接口相同的登录凭据(wpssid 或 ksosid)和设备信息凭据(wpsua 或 kso 设备信息采集方案,若调用申请地址接口时未提供则无需提供),存储网关会进行校验。 |
more | object | 更多的错误信息 |
响应体示例
json
{
"data": {
"hashes": [
{
"sum": "string",
"type": "string[enum]"
}
],
"url": "string"
},
"msg": "string",
"code": 0
}