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

回调网关

在集成 OfficeSDK 时,回调网关是接收来自 OfficeSDK 服务端的请求的关键。回调接口将通过该网关与您的服务进行通信。为了确保正常的回调交互,接入方需要配置并提供回调网关地址。

格式要求#

为了确保回调请求能够成功发送并正确到达接入方的服务端,回调网关地址需要符合以下格式要求:
1. 协议要求
回调网关地址支持 HTTP 和 HTTPS 协议,可以根据需求选择适合的协议。
示例:
https://officesdk.com/
http://officesdk.com/callback
2. 地址类型
支持 合法域名 和 本地地址。对于本地开发环境,可以使用 localhost 或 127.0.0.1,但生产环境建议使用 OfficeSDK 服务端可访问的域名地址。
示例:
https://officesdk.com/callback
http://loacalhost:8080/api/callback
3. 路径要求
回调网关路径应简洁,遵循 RESTful 风格,且仅包含字母、数字、短横线(-)、下划线(_)等合法字符。
示例:
https://officesdk.com/api_callback
http://loacalhost:8080/api/callback
4. 端口号支持
回调网关可以包含端口号,推荐使用标准端口(如 443 对 HTTPS,80 对 HTTP)。如果使用自定义端口,请确保该端口在防火墙中开放,且可供外部访问。
示例:
https://officesdk.com:443/callback
http://localhost:8080/api/callback

配置回调网关#

访问「回调配置」页面,配置回调网关地址。
image.png
⚠️ 注意事项:
谨慎修改:每次修改回调网关地址时,都会影响到所有与该地址相关的文件操作请求(如文件读取、保存等),请谨慎操作;
联调测试:在配置完回调网关后,务必进行 联调测试。通过 OfficeSDK 控制台 提供的测试功能模拟回调请求,确保回调网关地址能够正常接收和响应请求;
格式正确:如果回调网关地址格式不正确(如使用 HTTP 协议而非 HTTPS,域名或路径不合法,端口号不对等),OfficeSDK 服务将无法成功发送请求到该网关;
端口访问:使用自定义端口时,确保端口对外开放,且没有防火墙或网络配置的阻拦。如果端口不可用,OfficeSDK 将无法访问回调网关,导致请求失败;
可用性:确保回调网关地址的服务器在配置后可以保持高可用性。如果回调网关因网络问题、服务器故障等原因不可用,可能导致文件操作失败,影响用户体验。
修改于 2025-04-08 02:49:16
上一页
概述
下一页
文档预览接入流程
Built with