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

创建附件预览

开发中
POST
/v1/thirdparty/files/{file_id}/assets/create-file
当用户点击附件预览时,SDK 会回调接入方该接口,为这个附件资源动态创建一个逻辑上的文件实体,之后会使用改文件的 file_id 来触发预览流程

请求参数

Path 参数

Header 参数

Body 参数application/json必填

示例
{
    "object_name": "/media/annual_report.docx"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/thirdparty/files//assets/create-file' \
--header 'X-OfficeSdk-Token: {{token}}' \
--header 'X-Request-Id;' \
--header 'X-User-Query;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "object_name": "/media/annual_report.docx"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "data": {
        "id": "f053ff55fd064c66",
        "size": 202742,
        "user_query": {
            //建议增加一个标识,说明当前预览文件是附件
            "from_attanchment": true
        }
    }
}
🟢200失败
修改于 2025-11-10 06:37:21
上一页
获取水印信息
下一页
获取内容上传地址
Built with