快速开始
墨序文档提供 REST API 接口,无需安装 SDK,仅需将文件地址拼接到预览地址后即可实现跨平台文档在线预览。
支持 Word、Excel、PPT、PDF、OFD、WPS、压缩包、图片、音视频等 60+ 种格式,覆盖 PC、iOS、Android、微信小程序及公众号全平台。
三步完成接入
准备可访问的文件地址
文件需可通过公网 URL 访问,例如:https://example.com/files/report.docx
拼接预览地址
将文件 URL 作为 src 参数拼接到预览接口地址后即可。
打开或嵌入即可预览
在浏览器中直接打开,或嵌入 iframe / WebView 即可完成预览。
接口地址
https://view.moxudoc.cn/
接口同时支持 HTTP 和 HTTPS,建议在生产环境使用 HTTPS 以保证安全性。
最简单的调用方式:将文件地址作为 src 参数传入即可,示例:
https://view.moxudoc.cn/?src=https://view.moxudoc.com/vw/文件模板.docx
测试文件建议不超过 2MB,以免影响加载速度。
接口参数
所有参数通过 GET 方式在 URL 中传递:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
src | string | 必填 | 文件地址,需为公网可访问的 HTTP/HTTPS 链接 |
m | int | 可选 | 预览模式:0=超清 1=极速 2=图文SVG 3=动画(PPT) 4=高清(默认) |
lt | int | 可选 | 试读页数,如 lt=2 表示仅可预览前 2 页 |
watermark | string | 可选 | 水印文字内容,将在预览页面上叠加显示 |
format | string | 可选 | 转换输出格式,如 format=pdf 将文档转为 PDF |
words | string | 可选 | 提取文本内容,words=all 返回全文 JSON 数组 |
src 参数中的文件地址含有中文或特殊字符时,建议先进行 encodeURIComponent() 编码后再拼接。
src · 文件地址
文件地址必须是公网可访问的 HTTP/HTTPS 链接。建议使用 OSS、COS 等对象存储服务托管文件,确保访问速度和稳定性。含中文或特殊字符的地址需先进行 URL 编码。
m · 预览模式
通过 m 参数指定预览模式,不同模式在渲染质量、加载速度和功能上有所侧重。具体效果参见下方「预览模式」章节。
lt · 试读限制
限制用户仅可预览文档的前 N 页,超出部分模糊处理。lt=2 表示仅可查看前 2 页。适用于付费阅读、文档试读等业务场景。
watermark · 水印
自定义水印文字,支持中英文。水印将叠加在预览页面上,有效防止截图泄露。支持的格式:Word、PPT、WPS、OFD;暂不支持 Excel。
format · 转换输出
将文档转换为指定格式输出。当前支持 format=pdf,可将 Word、PPT、Excel、OFD 转为 PDF 后浏览器自动下载或展示。
words · 内容提取
提取文档中的文本内容,返回 JSON 数组,每个段落作为一个字符串元素。适用于全文检索、内容分析等场景。
预览模式
通过 m 参数控制,不同模式在质量、速度和功能上有所侧重。
高清模式(默认)
无需传 m 参数或 m=4。顶部有工具栏,支持打印、全屏、下载、缩放等操作,适用于大多数场景。
https://view.moxudoc.cn/?src=https://view.moxudoc.com/vw/文件模板.docx
极速模式 m=1
异步按需加载,解析速度最快,内容准确。无工具栏,适合大文件或对加载速度要求较高的场景。
https://view.moxudoc.cn/?m=1&src=https://view.moxudoc.com/vw/文件模板.docx
图文 SVG 模式 m=2
纯 HTML+SVG 渲染,像素级还原文档排版,文字不失真、可选中复制,适合需要精确排版还原的场景。
https://view.moxudoc.cn/?m=2&src=https://view.moxudoc.com/vw/文件模板.docx
动画模式(PPT 专用)m=3
专为 PPT 设计,完整保留幻灯片中的动画效果与切换特效,支持 GIF、音频、视频播放。
https://view.moxudoc.cn/?m=3&src=https://view.moxudoc.com/vw/PPT文件预览.pptx
超清模式 m=0
最高渲染精度,像素级保真,为增值功能。需联系客服(QQ:3554853473)申请开通后使用。
https://view.moxudoc.cn/?m=0&src=https://view.moxudoc.com/vw/文件模板.docx
高清 / 极速预览效果
图文 SVG / 动画预览效果
高级功能
预览加水印
通过 watermark 参数添加自定义水印文字,支持中英文。适用于 Word、PPT、WPS、OFD 格式。暂不支持 Excel。
https://view.moxudoc.cn/?watermark=仅供参考&src=https://view.moxudoc.com/vw/文件模板.docx
试读页数控制
通过 lt 参数限制可预览页数,超出部分模糊处理。适用于付费阅读、文档试读等场景。lt=1 试读第 1 页,lt=2 试读前 2 页。
https://view.moxudoc.cn/?lt=2&src=https://view.moxudoc.com/vw/文件模板.docx
转换输出 PDF
设置 format=pdf 将文档服务端转换为 PDF 输出,浏览器自动下载或展示。支持 Word、PPT、Excel、OFD 转 PDF。
https://view.moxudoc.cn/?format=pdf&src=https://view.moxudoc.com/vw/文件模板.docx
提取文本内容
设置 words=all 返回文档全文文本,JSON 数组格式,每个段落作为一个字符串元素。可用于全文检索、内容分析等。OFD 格式暂不支持文本提取,如需此功能请联系客服。
https://view.moxudoc.cn/?words=all&src=https://view.moxudoc.com/vw/文件模板.docx
集成示例
直接访问预览地址
最简单的方式——将预览链接作为超链接直接打开:
<a href="https://view.moxudoc.cn/?src=https://example.com/doc/report.docx" target="_blank" rel="noopener noreferrer"> 点击预览文档 </a>
iframe 嵌入
适用于 OA 系统、企业内网等场景,将预览页面嵌入现有页面中:
<iframe src="https://view.moxudoc.cn/?src=https://example.com/doc/report.docx" width="100%" height="600px" frameborder="0" allowfullscreen ></iframe>
建议宿主页面与预览服务均使用 HTTPS,以避免浏览器混合内容拦截。如需隐藏工具栏,可使用极速模式(m=1)。
JavaScript 新窗口打开
function previewDoc(fileUrl) {
const url = 'https://view.moxudoc.cn/?src='
+ encodeURIComponent(fileUrl);
window.open(url, '_blank');
}
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');
};
// <button onClick={() => previewDoc(row.fileUrl)}>预览</button>
微信小程序集成
使用微信小程序的 <web-view> 组件加载预览页面。需在小程序管理后台将 view.moxudoc.cn 添加为业务域名。
<web-view src="{{previewUrl}}"></web-view>
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 | 支持多种预览模式 |
| WPS 文档 | .wps | 同 Word 系列 |
| 演示文稿 | .ppt · .pptx · .pps · .dps | 支持动画模式 (m=3) |
| 表格 | .xls · .xlsx · .csv · .et | 暂不支持水印/PDF 转换 |
| 支持多种预览模式 | ||
| OFD 国产 | .ofd | 含电子发票、OFD 转 PDF |
| 压缩包 | .zip · .rar · .tar · .7z | 浏览压缩包内文件列表 |
| 图片 | .jpg · .jpeg · .png · .gif · .bmp · .svg · .webp | — |
| 音视频 | .mp4 · .mp3 · .wma · .avi | 在线播放 |
| 文本/代码 | .txt · .xml · .json · .java · .html · .css · .js | 代码高亮 |
常见问题
文件地址含有中文,预览时报错怎么办?
encodeURIComponent() 对 src 参数值编码即可。内网文件(局域网地址)能预览吗?
预览时提示"文件格式不支持"怎么处理?
如何在 iframe 中预览不显示工具栏?
m=1)即可隐藏工具栏:https://view.moxudoc.cn/?m=1&src=YOUR_FILE_URL小程序中预览提示"域名不合法"?
view.moxudoc.cn 添加到业务域名白名单。同时需确保文件地址所属域名也已加入白名单。