DEVELOPER GUIDE

API 开发文档

3 行代码快速接入,支持 Word/Excel/PPT/PDF/OFD/CAD 等 60+ 种格式在线预览-支持本地私有化部署

快速开始

更新时间:2026-04-25 v3.x REST API

无需安装 SDK 或插件,只需将文件地址拼接到预览 URL 上,即可在各类平台实现文档在线预览。

支持 Word、Excel、PPT、PDF、OFD、WPS、CAD、压缩包、图片等 60+ 种格式,兼容 PC、iOS、Android、微信小程序等所有主流平台。

三步完成接入

1

准备可访问的文件地址

确保文件可通过公网 URL 访问,如 https://moxudoc.com/file/USDOC动画课件在线演示.pptx

2

拼接预览地址

将文件地址作为 src 参数附加到预览接口后面

3

打开或嵌入即可预览

在浏览器中访问拼接后的地址,或将其嵌入 iframe / webview,即可看到预览效果

接口端点

REST
GET  https://view.moxudoc.cn/

# 最简示例:预览一个 PPT 动画课件
https://view.moxudoc.cn/?src=https://moxudoc.com/file/USDOC动画课件在线演示.pptx
ℹ️ 接口同时支持 HTTP 和 HTTPS,生产环境建议使用 HTTPS。测试文件大小建议不超过 100MB

接口参数

所有参数均通过 GET 方式传递,拼接在请求 URL 后面。

参数名类型必填说明
srcstring必填文件地址(URL),需为公网可访问的完整地址,支持 HTTP/HTTPS
mint可选预览模式:0=超清动画 | 1=极速 | 2=SVG | 3=图文 | 4=高清(默认)
ltint可选试读页数限制,lt=2 表示仅预览前2页
watermarkstring可选水印文字,叠加在预览页面上。支持中英文及符号
formatstring可选输出格式转换,format=pdf 将文件转换为 PDF 输出
wordsstring可选文本提取,words=all 以 JSON 格式返回文档全部文字

预览模式

通过 m 参数选择不同的渲染引擎,不同模式在效果、速度和适用场景上各有侧重。

默认高清模式

不传 m 或传 m=4。顶部工具栏(打印/全屏/下载/缩放),适合大多数场景。

查看示例 →
m=1极速模式

异步按需加载,解析速度快、延迟低,适合大文件或对响应速度要求高的场景,界面精简无工具栏。

查看示例 →
m=2图文 SVG 模式

纯 HTML+SVG 渲染,像素级还原文档排版,文字可复制,适合需要精确还原样式的场景。

查看示例 →
m=3动画模式(PPT)

专为 PPT 设计,完整呈现幻灯片动画效果,支持 GIF、音视频嵌入内容播放。

查看示例 →
m=0超清模式(高级)

高保真超清渲染,版面还原精细。属于高级功能,需联系客服开通后使用。

⚠️ 超清模式属于增值功能,请联系客服(QQ:3554853473)申请开通。

模式参数示例

URL
# 高清模式(默认,不传 m)
https://view.moxudoc.cn/?src=https://usdoc.cn/vw/demo.docx

# 极速模式
https://view.moxudoc.cn/?m=1&src=https://usdoc.cn/vw/demo.docx

# 图文 SVG 模式
https://view.moxudoc.cn/?m=2&src=https://usdoc.cn/vw/demo.docx

# PPT 动画模式
https://view.moxudoc.cn/?m=3&src=https://usdoc.cn/vw/demo.pptx

高级功能

预览水印

通过 watermark 参数叠加自定义水印文字,用于版权保护。

# watermark 参数值即为水印文字
https://view.moxudoc.cn/?watermark=仅供参考&src=https://usdoc.cn/vw/demo.docx
中文 ✓Word ✓PPT ✓Excel 暂不支持

试读页数控制

lt 参数限制预览页数,超出部分模糊处理,适用于付费阅读场景。

# 只允许预览前 2 页
https://view.moxudoc.cn/?lt=2&src=https://usdoc.cn/vw/demo.docx

转换输出 PDF

format=pdf 将 Word/PPT/Excel/OFD 等服务端转换为 PDF 返回。

# Word 转 PDF
https://view.moxudoc.cn/?format=pdf&src=https://usdoc.cn/vw/demo.docx

提取文本内容

words=all 以 JSON 格式返回文档全部文字内容,可用于全文检索、内容分析等场景。

# 提取文档中的全部文字(JSON 格式返回)
https://view.moxudoc.cn/?words=all&src=https://usdoc.cn/vw/demo.docx
ℹ️ 返回结果为 JSON 数组,每个段落作为一个字符串元素。

集成示例

根据技术栈选择合适的集成方式。

iframe 嵌入

将预览内容嵌入页面中展示,适合 OA 系统、企业内网等场景。

HTML
<iframe
  src="https://view.moxudoc.cn/?src=https://example.com/report.docx"
  width="100%"
  height="600px"
  allowfullscreen
></iframe>

JavaScript 跳转打开

function previewDoc(fileUrl) {
  const url = 'https://view.moxudoc.cn/?src='
             + encodeURIComponent(fileUrl);
  window.open(url, '_blank');
}
// methods
previewDoc(fileUrl) {
  const url = `https://view.moxudoc.cn/?src=${encodeURIComponent(fileUrl)}`;
  window.open(url, '_blank');
}
const previewDoc = (fileUrl) => {
  const url = `https://view.moxudoc.cn/?src=${encodeURIComponent(fileUrl)}`;
  window.open(url, '_blank');
};

// JSX
<button onClick={() => previewDoc(fileUrl)>预览</button>

微信小程序集成

使用 <web-view> 组件加载预览地址。

ℹ️ 需要在微信公众平台将 view.moxudoc.cn 添加到「业务域名」白名单中。
<!-- pages/preview/preview.wxml -->
<web-view src="{{previewUrl}}"></web-view>
// pages/preview/preview.js
Page({
  data: { previewUrl: '' },
  onLoad(options) {
    const file = decodeURIComponent(options.url);
    this.setData({
      previewUrl: 'https://view.moxudoc.cn/?src=' + encodeURIComponent(file)
    });
  }
});

// 跳转时携带文件地址
wx.navigateTo({
  url: `/pages/preview/preview?url=${encodeURIComponent(fileUrl)}`
});

支持的文件格式

分类支持格式备注
Word 文档.doc · .docx · .rtf · .dot · .wpt · .docm · .dotm高清/极速/SVG 多种模式
WPS 文档.wps与 Word 模式一致
演示文稿.ppt · .pptx · .pps · .dps支持动画模式、音视频、触发器高级动画
表格.xls · .xlsx · .csv · .et水印/转 PDF 暂不支持
PDF.pdf所有模式均支持
OFD 版式.ofd支持高清与 SVG 模式
图片.jpg · .jpeg · .png · .gif · .bmp · .webp· .emf · .wmf · .svg 直接渲染展示
压缩包.zip · .rar支持内部文件预览
文本.txt · .md · .json · .xml· .md(markdown) 代码高亮展示
图纸.dwg · .dxf · .plt高清预览,无极缩放

常见问题

文件地址需要满足什么条件?
如何选择预览模式?
预览链接可以设置有效期吗?
支持私有化部署吗?