Appearance
文档编辑链接
接口:POST /wenqu/api/v1/files/{appId}/{fileId}/url
说明:获取要打开指定文档类型的编辑链接,此链接集成前端 JSSDK 时作为 url 参数设置。
参数:
字段 | 位置 | 必须 | 类型 | 说明 |
---|---|---|---|---|
Content-Type | header | 必须 | String | 请求体为 json 格式,application/json |
appId | Path | 必须 | String | 分配给接入方应用 id |
fileId | Path | 必须 | String | 当前文档在接入方系统中的唯一 id,后续回调需要能识别 |
type | body | 必须 | String | 当前文档后缀扩展名,如 docx。接入方要保证文档的扩展类型正确否则可能导致开档失败 |
extParam | body | 非必须 | String | 扩展参数,hostname-以指定域名拼接响应 url |
callbackParams | body | 非必须 | String | 回调参数,接入方自定义在后续回调接入方时携带 |
请求体示例:
json
{
"type": "docx",
"extParam": {
"hostname": "http://192.168.0.1:8080"
},
"callbackParams": {
"key": "value"
}
}
返回值:
字段 | 必须 | 类型 | 说明 |
---|---|---|---|
url | 必须 | String | 文件开档的地址,集成前端 JSSDK 时作为 url 参数设置。 |
返回值示例:
json
{
"code": 0,
"msg": "",
"url": "hostname/wenqu/w/98d5b726a2254f8fa93c3a464126cc53"
}
code 错误码说明:
错误码 | 说明 |
---|---|
200001 | 文件类型不支持 |
200002 | appId 对应域名未配置 |