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

接入流程

OfficeSDK 提供了简单易用的接入流程,帮助开发者在最短时间内将文档预览与编辑功能集成到自己的系统中。

前提:本地安装 OfficeSDK 并上传许可证#

按照《快速上手-开始》章节的步骤 1-4,本地运行 OfficeSDK 程序后,访问控制后台,并注入您的许可证。
image.png

第 1 步:配置域名地址#

访问控制后台的「配置管理」页面,录入您访问 OfficeSDK 的域名地址。
image.png

第 2 步:实现回调服务#

为了让 OfficeSDK 正确获取并操作文档内容,您需要在服务端自行实现回调服务,并实现一组回调接口,用于完成与您现有文件存储系统之间的数据通信。
参考《在线预览编辑-服务端回调》章节 ,实现您的回调服务。

第 3 步:配置回调#

访问「回调配置」页面,配置回调网关地址,开始联调测试。您可以在线调试接口。
在控制台中点击【联调测试】按钮,自动发起模拟文档打开请求,检测回调接口是否正常;
查看返回信息,快速定位请求参数、接口响应、失败原因;
通过控制台日志或本地日志,调试接口逻辑,确保文件读取和保存流程畅通;
联调完成后,即可启用接口,并在前端集成 JS SDK,完成在线预览与编辑功能接入。
您必须实现所有必配接口后才能使用服务,否则可能导致功能不可用。
image.png

第 4 步:集成 JS SDK#

回调服务配置完成后,通过在您的前端页面集成 JS SDK 实现文档的初始化渲染。
参考《在线预览编辑-前端 SDK》章节 ,引入 JS SDK,在页面中加载并操作文档。

第 5 步:对接 JS API#

在引入并成功初始化 JS SDK 后,获取并初始化 Application 对象。通过 Application 对象对文档进行丰富的 API 调用,直接对文档的内容、格式等进行操作。
参考《在线预览编辑-JS API》章节 ,了解 JS API 的功能和使用方法。
修改于 2025-05-07 08:35:49
上一页
场景举例
下一页
概述
Built with