API列表
适用版本：
版本>=文档中心2024.0807
通过文件ID获取不落地文档下载地址
请求说明
请求地址： 配置域名+ /o/yunsec/secbase/open/filecontrol/v1/file/download/url
请求方法： GET
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间，示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考《签名说明》 |
| Authorization | 是 | Bearer access_token(用户授权获取的token) |
查询参数（Query）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 盘id |
| file_id | string | 是 | 文件id |
响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 软链生成请求返回 |
| ∟ download_url | string | 下载地址 |
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
响应体示例
json
{
"code": 20000000,
"msg": "success",
"data": {
"download_url": "/c/yunsec/secbase/file/download?file_key=w4tIHTczfGw1fTTLN%2BNcDVL79NtxKoSvLzsqIOm8WAekeY0U1Rv6rf7P3pKfu7wFrArzTL4n6wr1Xc3DcPa8t1%2BzWICAjrm8NppiAkPe%2BYO5LXd5GjcB3i3ubh%2BNnfyBONbHgUO8Kz7zUao1OQEr%2BQ%3D%3D"
}
}通过文件ID将不落地文档转普通文档
请求说明
请求地址： 配置域名+ /o/yunsec/secbase/open/filecontrol/v1/file/convert_normal
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间，示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考《签名说明》 |
| Authorization | 是 | Bearer access_token(用户授权获取的token) |
请求体（Body）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 盘id |
| file_id | string | 是 | 文件id |
请求体示例
json
{
"drive_id": "10",
"file_id": "1"
}响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
响应体示例
json
{
"code": 20000000,
"msg": "success"
}通过文件ID将普通文档转不落地文档
请求说明
请求地址： 配置域名+ /o/yunsec/secbase/open/filecontrol/v1/file/convert_secodc
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间，示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考《签名说明》 |
| Authorization | 是 | Bearer access_token(用户授权获取的token) |
请求体（Body）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 盘id |
| file_id | string | 是 | 文件id |
请求体示例
json
{
"drive_id": "10",
"file_id": "1"
}响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
响应体示例
json
{
"code": 20000000,
"msg": "success"
}通过文档id判断是否是不落地文档
请求说明
请求地址： 配置域名+ /o/yunsec/secbase/open/filecontrol/v1/file/is_secodc
请求方法： GET
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间，示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考《签名说明》 |
| Authorization | 是 | Bearer access_token(用户授权获取的token) |
查询参数（Query）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| file_id | string | 是 | 文件id |
响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 软链生成请求返回 |
| ∟ is_secdoc | boolean | 是否为不落地文件 |
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
响应体示例
json
{
"code": 20000000,
"msg": "success",
"data": {
"is_secdoc": true
}
}通过文件ID生成软链
请求说明
请求地址： 配置域名+ /o/yunsec/secbase/open/link/v1/generate
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间，示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考《签名说明》 |
| Authorization | 是 | Bearer access_token(用户授权获取的token) |
请求体（Body）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| file_id | string | 是 | 文件ID |
| link_type | string | 是 | 软链类型，例如“ylink”(默认普通文档)，“mb_link”（商密文档） |
请求体示例
json
{
"file_id": "261776010706944",
"link_type": "mb_link"
}响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 软链生成请求返回 |
| ∟ base_64_str | string | 软链信息 |
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
响应体示例
json
{
"code": 20000000,
"msg": "success",
"data": {
"base_64_str": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAd3BzX21ldGEuanNvbgTAwZKaMBgA4Hf5rzoV3ATBmT3UVQRhF0FA9BYCmMhgMSEY7PTd+/2FsRawBvOXAXNo6wnWEBOWSBKQoNDH9pDT5Ew2Tm610ZZzi2QC5lA/qJj6oa5gDQ6bCUXdHzx9pOmgPJv729kVXbmVrCqyErr/M+4zqr5CjKWDGJseY0lNq0vaSh/UeYfC4Bgv3Z546bHDnMQbLe6nIa+2+l7bzETJ/qKzt8LoE+ZAWU1bqTpYA+/K2XKIX+6U7bJM4Ff50tmjGYnF6eFDFAYjqCgf7/DrUkZ78xTL3zytutC+G0WeSbl8kbdlNChgbF9fVIrH6FkOGJHdVTueujzVwva/e2LL5HxjnW/f3B8zdpfGokGB5zXfYqic4hpuYuULHNULW656TrtnOllvEfsji4pbU+VJcvuEf/8DAAD//1BLBwgWNkfsOwEAAGsBAABQSwECFAAUAAgACAAAAAAAFjZH7DsBAABrAQAADQAAAAAAAAAAAAAAAAAAAAAAd3BzX21ldGEuanNvblBLBQYAAAAAAQABADsAAAB2AQAAAAA="
}
}解析软链并获取文件信息
请求说明
请求地址： 配置域名+ /o/yunsec/secbase/open/link/v1/parse
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间，示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考《签名说明》 |
| Authorization | 是 | Bearer access_token(用户授权获取的token) |
请求体（Body）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| base_64_str | string | 是 | 软链信息 |
请求体示例
json
{
"base_64_str": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAd3BzX21ldGEuanNvbgTAwZKaMBgA4Hf5rzoV3ATBmT3UVQRhF0FA9BYCmMhgMSEY7PTd+/2FsRawBvOXAXNo6wnWEBOWSBKQoNDH9pDT5Ew2Tm610ZZzi2QC5lA/qJj6oa5gDQ6bCUXdHzx9pOmgPJv729kVXbmVrCqyErr/M+4zqr5CjKWDGJseY0lNq0vaSh/UeYfC4Bgv3Z546bHDnMQbLe6nIa+2+l7bzETJ/qKzt8LoE+ZAWU1bqTpYA+/K2XKIX+6U7bJM4Ff50tmjGYnF6eFDFAYjqCgf7/DrUkZ78xTL3zytutC+G0WeSbl8kbdlNChgbF9fVIrH6FkOGJHdVTueujzVwva/e2LL5HxjnW/f3B8zdpfGokGB5zXfYqic4hpuYuULHNULW656TrtnOllvEfsji4pbU+VJcvuEf/8DAAD//1BLBwgWNkfsOwEAAGsBAABQSwECFAAUAAgACAAAAAAAFjZH7DsBAABrAQAADQAAAAAAAAAAAAAAAAAAAAAAd3BzX21ldGEuanNvblBLBQYAAAAAAQABADsAAAB2AQAAAAA="
}响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 软链生成请求返回 |
| ∟ fid | string | 文件id |
| ∟ ft | string | 文件类型 |
| ∟ linkId | string | 分享id |
| ∟ type | string | 软链类型 |
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
响应体示例
json
{
"code": 20000000,
"msg": "success",
"data": {
"fid": "261776010706944",
"ft": "docx",
"type": "mb_link",
"linkId": "sWq3LkTGVfvt0"
}
}解析软链并获得文件下载地址
请求说明
请求地址： 配置域名+ /o/yunsec/secbase/open/link/v1/download/url
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间，示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考《签名说明》 |
| Authorization | 是 | Bearer access_token(用户授权获取的token) |
请求体（Body）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| base_64_str | string | 是 | 软链信息 |
请求体示例
json
{
"base_64_str": "UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAd3BzX21ldGEuanNvbgTAwZKaMBgA4Hf5rzoV3ATBmT3UVQRhF0FA9BYCmMhgMSEY7PTd+/2FsRawBvOXAXNo6wnWEBOWSBKQoNDH9pDT5Ew2Tm610ZZzi2QC5lA/qJj6oa5gDQ6bCUXdHzx9pOmgPJv729kVXbmVrCqyErr/M+4zqr5CjKWDGJseY0lNq0vaSh/UeYfC4Bgv3Z546bHDnMQbLe6nIa+2+l7bzETJ/qKzt8LoE+ZAWU1bqTpYA+/K2XKIX+6U7bJM4Ff50tmjGYnF6eFDFAYjqCgf7/DrUkZ78xTL3zytutC+G0WeSbl8kbdlNChgbF9fVIrH6FkOGJHdVTueujzVwva/e2LL5HxjnW/f3B8zdpfGokGB5zXfYqic4hpuYuULHNULW656TrtnOllvEfsji4pbU+VJcvuEf/8DAAD//1BLBwgWNkfsOwEAAGsBAABQSwECFAAUAAgACAAAAAAAFjZH7DsBAABrAQAADQAAAAAAAAAAAAAAAAAAAAAAd3BzX21ldGEuanNvblBLBQYAAAAAAQABADsAAAB2AQAAAAA="
}响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 软链生成请求返回 |
| ∟ file_id | string | 文件id |
| ∟ download_url | string | 下载url |
| code | integer | 错误码，参照 《错误码说明》 |
| msg | string | 状态信息 |
响应体示例
json
{
"code": 20000000,
"msg": "success",
"data": {
"file_id": "261776010706944",
"download_url": "/c/yunsec/secbase/file/download?file_key=A1Q3TwYdGXsYknEEphf%2FtW3XMyjVYU4RhqEFMHGBVzQIZNNbnDY%2Bv1E916ntRfMlvS6qpAq9jVJTO%2FY%2B6bWcxcVUKwRg3%2BqG6%2B%2FkqwYpPFL7YjFapfyIVfPihmzOtSO3h7BBXIWTitKQ9fHLMZVg4g%3D%3D"
}
}