OfficeSDK 开发文档
  1. 文档预览
OfficeSDK 开发文档
  • ⭐️ 快速开始
    • 开始
    • 安装及部署
  • 💰 收费介绍
    • 定价
  • 📖 在线预览编辑服务
    • 原理概述
    • 支持格式
    • 场景举例
    • 接入流程
    • 服务端回调
      • 概述
      • 回调网关
      • 文档预览编辑
        • 文档预览接入流程
        • 文档编辑保存接入流程
        • 文档预览
          • 获取文件信息
            GET
          • 获取文件下载地址
            GET
          • 获取水印信息
            GET
        • 文档保存
          • 获取内容上传地址
          • 上传内容完成后,回调通知上传结果
        • 文档资源上传
          • 获取资源上传地址
          • 上传资源完成后,回调通知上传结果
        • 签发文档下载地址
          GET
        • 签发资源下载地址
          GET
      • 鉴权
        • 鉴权说明
        • 鉴权接口
      • 文档 AI
        • 文档 AI 启用流程
        • 获取 AI 配置
    • 前端 SDK
      • 概述
      • 接入流程
      • 实例对象
    • JS API
      • 调用方法
      • 总览
      • 公共
        • 文档内容(content)
      • 文字
        • 选区(selection)
        • 区域(range)
      • 表格
      • 幻灯片
      • PDF
        • 选区(selection)
        • 区域(range)
    • 后端 API
      • 文件下载
        • 创建下载任务
        • 获取下载进度
  • ⚙️ 控制后台
    • 概述
    • 后台管理
      • 系统管理
      • 回调配置
      • 字体管理
      • 日志管理
  • 📔 更新日志
    • V1.2
    • V1.1
  • ❓ 其他问题
    • 如何采集服务器机器码?
    • 如何实现集群部署?
  1. 文档预览

获取文件信息

开发中
GET
/v1/thirdparty/files/{file_id}
用于获取文件的基本信息,在文档打开以及编辑过程中,都需要这些基本信息作为文件的标识与展示,如文件 ID 需要在接入方系统中能唯一标识一份文档。
注意
1.
接口中请求中的 file_id 和 响应的 id 需保持一致,文件 ID 不一致有可能影响某些功能的正常使用。
2.
响应中的 from_sdk 字段,需要正确返回,否则会影响预览或编辑性能。

请求参数

Path 参数

Header 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/thirdparty/files/' \
--header 'X-OfficeSdk-Token;' \
--header 'X-Request-Id;' \
--header 'X-User-Query;'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "data": {
        "id": "wwljkQ_HeYz595V",
        "name": "hi.docx",
        "version": 91,
        "from_sdk": true,
        "create_time": 1760779587399,
        "creator_id": "5",
        "modifier_id": "7",
        "modify_time": 1726485555242
    }
}
🟢200失败
修改于 2025-04-28 06:44:33
上一页
文档编辑保存接入流程
下一页
获取文件下载地址
Built with