金山文档开放平台主题
API 总览
用户信息
| API | 说明 |
|---|---|
获取用户信息 GET/api/v1/openapi/user/basic | 获取授权用户的 id，昵称，头像等信息 |
获取临时凭证 POST/api/v1/openapi/user/edit_token | 获取与当前用户关联的临时凭证信息 |
取消临时凭证 DELETE/api/v1/openapi/user/edit_token/:token | 取消用户临时凭证 |
个人文档
| API | 说明 |
|---|---|
获取文档列表 GET/api/v1/openapi/personal/files | 从用户我的文档根目录开始，按目录获取个人文档列表，支持翻页、按规则排序 |
获取文档列表（扁平） GET/api/v1/openapi/personal/files/flat | 获取个人文档列表，忽略目录结构，支持翻页、按规则排序 |
获取文档下载地址 GET/api/v1/openapi/personal/files/:file_token/download | 获取个人文档的临时下载地址，并携带文件大小，校验和信息 |
创建空白文档 POST/api/v1/openapi/personal/files | 在指定目录下创建文档，支持的类型见[类型说明](/server/personal/create-files#ftype) |
上传本地文档 POST/api/v1/openapi/personal/files/upload | 在指定目录下上传文档，支持的类型见[类型说明](/server/personal/upload-local-files#ftype) |
通过云盘文档创建 POST/api/v1/openapi/personal/files/cloud | 通过用户提供的云盘文档下载地址，下载该文档，创建到指定目录下，支持的类型见[类型说明](/server/personal/create-files#ftype) |
创建分享 POST/api/v1/openapi/personal/files/:file_token/links | 创建和修改某个文件的分享状态 |
获取分享信息 GET/api/v1/openapi/personal/files/:file_token/links | 获取文件的分享信息，如链接过期时间、链接地址、预览权限，编辑权限，评论权限 |
取消分享 DELETE/api/v1/openapi/personal/files/:file_token/links | 取消文件分享 |
添加协作用户 POST/api/v1/openapi/personal/files/:file_token/links/members | 添加协作用户到分享中 |
修改协作用户权限 PUT/api/v1/openapi/personal/files/:file_token/links/members/:user_id | 修改分享中协作用户的权限 |
移除协作用户 DELETE/api/v1/openapi/personal/files/:file_token/links/members/:user_id | 移除分享中的协作用户 |
搜索文档名 GET/api/v1/openapi/personal/files/search/name | 搜索文档名，只能在本应用文件夹内进行 |
搜索文档内容 GET/api/v1/openapi/personal/files/search/content | 搜索文档内容，只能在本应用文件夹内进行 |
获取文档简易信息 GET/api/v1/openapi/personal/files/:file_token/simple | 通过文档 ID 获取文档简易信息，可用于判断文档是否存在 |
文档重命名 PUT/api/v1/openapi/personal/files/:file_token/name | 文档重命名 |
创建文件夹 POST/api/v1/openapi/personal/files/folder | 创建文件夹 |
将文档移动到回收站 DELETE/api/v1/openapi/personal/files/:file_token | 将文档移动到回收站 |
查询回收站 GET/api/v1/openapi/personal/recycles | 查询回收站中文件列表 |
将文档从回收站恢复 POST/api/v1/openapi/personal/recycles/recover | 从回收站恢复指定文件，恢复后，可正常获取文件信息 |
将文档从回收站删除 POST/api/v1/openapi/personal/recycles/destroy | 删除回收站中的指定文件，删除后将无法正常恢复 |
带临时凭证的编辑地址 GET/api/v1/openapi/personal/files/:file_token/url/with_edit_token | 获取已携带临时凭证的编辑地址 |
带临时凭证的分享链接 GET/api/v1/openapi/personal/files/:file_token/links/with_edit_token | 获取已携带临时凭证的分享链接 |
批量复制文档 POST/api/v1/openapi/personal/tasks/files/copy | 批量复制（另存）文档到指定目录 |
批量移动文档 POST/api/v1/openapi/personal/tasks/files/move | 批量移动文档到指定目录 |
批量删除文档 POST/api/v1/openapi/personal/tasks/files/delete | 批量移动文档到回收站，移动至回收站的文件可再次恢复 |
查询批量任务结果 GET/api/v1/openapi/personal/tasks/:task_id | 大部分情况下对文档的批量任务会异步执行，开放平台返回异步任务的 task_id，可以通过该接口查询其执行结果 |
应用目录下的文档列表 GET/api/v1/openapi/personal/apps/files | 获取应用目录下的文档列表。 |
最近文档列表 GET/api/v1/openapi/personal/files/recent | 获取当前用户最近使用过的文档列表，包括接收到的其他用户分享的文档（即登录金山文档首页后，左侧 `最近` 功能）。 |
星标文档列表 GET/api/v1/openapi/personal/files/star | 获取当前用户星标文档列表（即登录金山文档首页后，左侧 `星标` 功能）。 |
应用文档
| API | 说明 |
|---|---|
创建空白文档 POST/api/v1/openapi/appspace/files | 创建空白的文档，可指定文档的名称和父目录 |
上传本地文档 POST/api/v1/openapi/appspace/files/upload | 上传本地文档至应用空间，可指定上传的父目录，若不指定则自动上传至根目录 |
创建目录 POST/api/v1/openapi/appspace/folders | 创建空目录，可指定目录的名称和父目录 |
获取文档信息 GET/api/v1/openapi/appspace/files/:file_token | 获取应用文档的基本信息，文档 ID、文档名、内容类型、文档大小、创建时间等 |
获取文档下载地址 GET/api/v1/openapi/appspace/files/:file_token/download | 获取应用空间内指定文档的下载地址 |
文档列表 GET/api/v1/openapi/appspace/files | 获取文档列表，可指定父目录获取，不指定时将获取根目录下的文档列表，可限制每批次获取文档的数量，默认为 10 个 |
获取文档历史版本列表 GET/api/v1/openapi/appspace/files/:file_token/versions | 获取应用文档的历史版本列表，可指定列表的偏移量和每批次的大小 |
获取文档指定版本 GET/api/v1/openapi/appspace/files/:file_token/versions/:version | 获取指定文档的指定版本，包含文档 id、文档大小、文档版本、内容类型、文档修改时间等 |
获取文档指定版本下载地址 GET/api/v1/openapi/appspace/files/:file_token/versions/:version/download | 获取应用文档指定版本的下载地址 |
回滚到指定版本 POST/api/v1/openapi/appspace/files/:file_token/versions/:version/revert | 回滚文档内容到指定版本，回滚操作在文档历史版本中体现为一个新的版本。 |
更新文档名 PUT/api/v1/openapi/appspace/files/:file_token/name | 更新指定文档的文档名称，可同时指定修改者 ID |
更新文档内容 PUT/api/v1/openapi/appspace/files/:file_token/content | 更新指定文档的文档内容，需要发送文件实体 |
复制文档 POST/api/v1/openapi/appspace/files/:file_token/copy | 复制文档到指定目录，可指定目标文档名 |
将文档移动到回收站 DELETE/api/v1/openapi/appspace/files/:file_token | 将应用文档移动至回收站 |
彻底删除文档 DELETE/api/v1/openapi/appspace/files/:file_token/destroy | 彻底删除文档，不经过回收站，无法通过回收站还原。 |
带临时凭证的编辑地址 GET/api/v1/openapi/appspace/files/:file_token/url/with_edit_token | 获取应用文档带临时凭证的编辑地址 |
异步上传文件 POST/api/v1/openapi/appspace/file/async/upload | 异步进行文件上传，需要指定上传的文件地址链接和上传的文件名 |
上传进度查询 GET/api/v1/openapi/appspace/file/async/upload/:task_id | 查询文档上传的进度，以及处理失败时的具体错误原因 |
批量复制文档 POST/api/v1/openapi/appspace/tasks/files/copy | 批量复制（另存）文档到指定目录 |
批量移动文档 POST/api/v1/openapi/appspace/tasks/files/move | 批量移动文档到指定目录 |
查询批量任务结果 GET/api/v1/openapi/appspace/tasks/:task_id | 查询批量任务的执行结果，可查看任务执行进度和是否执行完成 |
查询回收站 GET/api/v1/openapi/appspace/trash | 查询回收站内的文档列表。 |
还原回收站内文档 PUT/api/v1/openapi/appspace/trash/:file_token/put_back | 将文档从回收站还原。 |
删除回收站内文档 DELETE/api/v1/openapi/appspace/trash/:file_token | 删除回收站内的文档，无法还原。 |
批量删除回收站内文档 POST/api/v1/openapi/appspace/trash/destroy | 批量删除回收站内的文档，无法还原。 |
应用空间用量（alpha） GET/api/v1/openapi/appspace/volume/usage | 查询应用空间的用量情况。 |
在线文档
| API | 说明 |
|---|---|
导出结构化数据 POST/api/v1/openapi/outline/:file_token/export/full_json | 获取指定在线文档的结构化数据 |
WPS 表格
| API | 说明 |
|---|---|
获取sheet基本信息 GET/api/v1/openapi/et/:file_token/sheets | 获取表格内各 sheet 的名称、索引以及是否可见等信息 |
获取单元格选区数据 GET/api/v1/openapi/et/:file_token/sheets/:sheet_idx/cells | 获取指定工作表内的单元格选区数据 |
获取文档内图片下载地址 POST/api/v1/openapi/et/:file_token/pictures/urls | 获取文档内图片的下载地址，需要结合获取文档内数据接口使用，使用其中返回的图片 `pic_key` 和 `tag` 来查询图片的下载地址 |
在线表格（beta）
| API | 说明 |
|---|---|
(工作表)获取所有sheet的基本信息 GET/api/v1/openapi/ksheet/:file_token/sheets | 获取工作表中的所有 sheet 的基本信息 |
(工作表)获取单元格选区数据 GET/api/v1/openapi/ksheet/:file_token/sheets/:sheet_idx/cells | 获取指定工作表内的单元格选区数据 |
(工作表)更新单元格选区数据 POST/api/v1/openapi/ksheet/:file_token/sheets/:sheet_idx/cells | 更新指定工作表内的单元格选区数据 |
(数据表)获取文档 Schema 信息 GET/api/v1/openapi/ksheet/:file_token/schemas | 获取文档基础信息，包括数据表信息、字段信息和视图信息等 |
(数据表)创建数据表 POST/api/v1/openapi/ksheet/:file_token/sheets | 在指定文档（在线表格）内新建一个数据表，可同时指定表名、视图和字段等信息 |
(数据表)修改数据表名称 PUT/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id | 修改指定数据表名称 |
(数据表)删除数据表文档 DELETE/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id | 删除指定数据表 |
(数据表)创建视图 POST/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/views | 在指定文档指定数据表内创建视图 |
(数据表)更新视图名称 PUT/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/views/:view_id | 更新数据表内的指定视图，仅支持修改视图名 |
(数据表)删除视图 DELETE/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/views/:view_id | 删除数据表内的指定视图 |
(数据表)创建字段 POST/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/fields | 在指定文档的指定数据表内创建字段 |
(数据表)更新字段 PUT/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/fields | 在指定数据表内批量更新字段 |
(数据表)删除字段 DELETE/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/fields | 删除数据表内的指定字段 |
(数据表)创建记录 POST/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/records | 创建表记录，需要指定文件 ID 和 sheetId，可一次创建多条记录 |
(数据表)更新记录 PUT/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/records | 批量更新数据表内的记录 |
(数据表)遍历记录 GET/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/records | 遍历数据表内的记录 |
(数据表)遍历记录(复杂查询条件) POST/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/records/complex_query | 遍历数据表内的记录（复杂查询条件） |
(数据表)获取某条记录内容 GET/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/records/:record_id | 获取数据表内的指定记录详情 |
(数据表)删除记录 DELETE/api/v1/openapi/ksheet/:file_token/sheets/:sheet_id/records | 批量删除数据表内的记录 |
轻维表
| API | 说明 |
|---|---|
获取文档 Schema 信息 GET/api/v1/openapi/dbt/:file_token/schemas | 获取轻维表基础信息，包括数据表信息、字段信息和视图信息等 |
创建 DBSheet POST/api/v1/openapi/dbt/:file_token/sheets | 在指定文档（轻维表）内新建一个数据表，可同时指定表名、视图和字段等信息 |
修改 DBSheet 名称 PUT/api/v1/openapi/dbt/:file_token/sheets/:sheet_id | 修改指定数据表名称 |
删除 DBSheet 文档 DELETE/api/v1/openapi/dbt/:file_token/sheets/:sheet_id | 删除指定数据表 |
创建视图 POST/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/views | 在指定数据表内创建视图 |
更新视图名称 PUT/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/views/:view_id | 更新数据表内的指定视图，仅支持修改视图名 |
删除视图 DELETE/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/views/:view_id | 删除数据表内的指定视图 |
创建字段 POST/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/fields | 在指定数据表内创建字段 |
更新字段 PUT/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/fields | 在指定数据表内批量更新字段 |
删除字段 DELETE/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/fields | 删除数据表内的指定字段 |
创建记录 POST/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/records | 创建表记录，需要指定 sheetId，可一次创建多条记录 |
更新记录 PUT/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/records | 批量更新数据表内的记录 |
遍历记录 GET/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/records | 遍历数据表内的记录 |
遍历记录(复杂查询条件) POST/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/records/complex_query | 遍历数据表内的记录（复杂查询条件） |
获取某条记录内容 GET/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/records/:record_id | 获取数据表内的指定记录详情 |
删除记录 DELETE/api/v1/openapi/dbt/:file_token/sheets/:sheet_id/records | 批量删除数据表内的记录 |
获取文档内附件下载地址 POST/api/v1/openapi/dbt/:file_token/attachment/urls | 获取文档内附件的下载地址，需要结合[遍历记录](/server/dbt/records.html)接口使用，使用其中返回的附件 `source`、`type` 和 `uploadId` 来查询附件的下载地址。目前仅支持图片附件及云文档附件 |
Webhook 创建数据表 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/create | 订阅数据表的创建 |
Webhook 重命名数据表 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/rename | 订阅数据表名称的修改 |
Webhook 修改数据表说明 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/description | 订阅数据表的说明修改 |
Webhook 修改数据表图标 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/icon | 订阅数据表的图标修改 |
Webhook 删除数据表 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/remove | 订阅数据表的删除 |
Webhook 数据表整表修改 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/update | 订阅数据表整表的修改 |
Webhook 字段列单元格修改 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/cells/fields/update | 订阅数据表内的字段（fields）对应的列单元格修改 |
Webhook 记录行单元格修改 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/cells/records/update | 订阅数据表内的记录（records）对应的行单元格修改 |
Webhook 区域内单元格修改 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/cells/update | 订阅数据表内一个区域内的单元格修改，区域是由字段和记录两个属性共同确定的。 |
Webhook 创建视图 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/views/create | 订阅数据表内的视图创建 |
Webhook 重命名视图 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/views/:view_id/rename | 订阅数据表内的视图名称修改 |
Webhook 删除视图 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/views/:view_id/remove | 订阅数据表内的视图删除 |
Webhook 创建字段 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/fields/create | 订阅数据表内的字段创建 |
Webhook 修改字段 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/fields/:field_id/update | 订阅数据表内的字段修改 |
Webhook 删除字段 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/fields/:field_id/remove | 订阅数据表内的字段删除 |
Webhook 添加记录 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/records/create | 订阅数据表内的记录添加 |
Webhook 当前用户创建的 GET/api/v1/openapi/dbt/:file_token/webhook/mine | 查询由当前用户创建的 Webhook 记录 |
Webhook 删除记录 POST/api/v1/openapi/dbt/:file_token/webhook/sheets/:sheet_id/records/remove | 订阅数据表内的记录删除 |
Webhook 取消订阅 DELETE/api/v1/openapi/dbt/:file_token/webhook/:webhook_id | 取消指定的 Webhook 订阅 |
文档内容提取
| API | 说明 |
|---|---|
提取纯文本 POST/api/v1/openapi/office/extract/plaintext | 将文档内的纯文本内容提取出来 |
文档内容提取结果查询 GET/api/v1/openapi/office/tasks/:task_id | 查询文档内容提取结果 |
格式转换
| API | 说明 |
|---|---|
文档转换成jpg POST/api/v1/openapi/office/convert/files/to/jpg | 将文档格式转换成 jpg |
文档转换成png POST/api/v1/openapi/office/convert/files/to/png | 将文档格式转换成 png |
文档转换成txt POST/api/v1/openapi/office/convert/files/to/txt | 将文档格式转换成 txt |
文档转换成pdf POST/api/v1/openapi/office/convert/files/to/pdf | 将文档格式转换成 pdf |
表格文档转换成 xlsx POST/api/v1/openapi/office/convert/files/to/xlsx | 将表格文档格式转换成 xlsx 格式 |
演示文档转换成 pptx POST/api/v1/openapi/office/convert/files/to/pptx | 将演示文档格式转换成 pptx 格式 |
文字文档转换成 docx POST/api/v1/openapi/office/convert/files/to/docx | 将文字文档格式转换成 docx 格式 |
格式转换结果查询 GET/api/v1/openapi/office/tasks/:task_id | 查询文档格式转换结果 |
匿名预览
| API | 说明 |
|---|---|
匿名预览应用文档 POST/api/v1/openapi/anonymous/preview/appspace/with_token | 在已取得应用文档权限的情况下，对文档进行匿名预览 |
匿名预览云盘文档 POST/api/v1/openapi/anonymous/preview/cloud/with_token | 在已取得应用文档权限的情况下，对云盘文档进行匿名预览 |
匿名预览本地文档 POST/api/v1/openapi/anonymous/preview/local/with_token | 在已取得应用文档权限的情况下，对本地文档进行匿名预览 |
刷新匿名预览凭证 POST/api/v1/openapi/anonymous/token | 在当前使用的匿名凭证过期前，用当前凭证，换取一个新的凭证。 |
取消匿名预览凭证 DELETE/api/v1/openapi/anonymous/token/:token | / |
匿名任务结果查询 GET/api/v1/openapi/anonymous/tasks/:task_id | / |
AirScript
| API | 说明 |
|---|---|
创建并执行脚本 POST/api/v1/openapi/personal/files/:file_token/script | 通过该接口新建脚本的异步任务，利用 response 的 taskId 轮循[获取脚本执行状态](/server/server-script/query-script)来获取实时执行情况 |
获取脚本执行状态 GET/api/v1/openapi/personal/personal/script/status | 将[创建并执行脚本](/server/server-script/exec-script)接口返回的 task_id 进行 encodeURIComponent 编码之后，通过轮循该接口可以实时获取执行情况,已经获取过的日志信息不会重复获取 |
同步执行脚本 POST/api/v1/openapi/personal/files/:file_token/sync_script | 该接口是创建并执行脚本与获取脚本执行状态的两个接口的结合，请求参数同[创建并执行脚本](/server/server-script/exec-script)接口一致，返回值详情同[获取脚本执行状态](/server/server-script/query-script)一致 |
表单（alpha）
| API | 说明 |
|---|---|
获取表单列表 GET/api/v1/openapi/personal/forms | / |
创建表单 POST/api/v1/openapi/personal/forms | / |
修改表单 PUT/api/v1/openapi/personal/forms/:form_id | / |
获取表单信息 GET/api/v1/openapi/personal/forms/:form_id | / |
获取答卷列表 GET/api/v1/openapi/personal/forms/:form_id/participants | / |
获取答卷内容 GET/api/v1/openapi/personal/forms/:form_id/answers/:answer_id | / |
提交表单答卷 POST/api/v1/openapi/personal/forms/:form_id/answers | / |
通知
| API | 说明 |
|---|---|
金山协作 POST/api/v1/openapi/notification/woa | 发送金山协作自定义机器人消息 |
金山协作应用消息 POST/api/v1/openapi/notification/woa/app | 通过指定邮箱发送消息给金山协作指定用户 |
企业微信 POST/api/v1/openapi/notification/wecom | 发送企业微信群聊机器人消息 |
钉钉 POST/api/v1/openapi/notification/dingtalk | 发送钉钉群聊机器人消息 |