快速开始
USDOC 文档在线预览服务提供简洁的 REST API,无需安装任何 SDK 或插件,只需将文件地址拼接到预览 URL 上,即可在任意平台实现文档在线预览。
三步完成接入
准备可访问的文件地址
确保您的文件可通过公网 URL 访问,例如:https://example.com/files/report.docx
拼接预览地址
将文件地址作为 src 参数附加到预览接口后面。
打开或嵌入即可预览
在浏览器中访问拼接后的地址,或将其嵌入 iframe / webview,即可看到预览效果。
接口端点
GET https://vw.usdoc.cn/ # 最简示例:预览一个 Word 文件 https://vw.usdoc.cn/?src=https://usdoc.cn/vw/文件模板.docx
接口参数
所有参数均通过 GET 方式传递,拼接在请求 URL 后面。
| 参数名 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| src | string | 必填 | 文件地址(URL),需为公网可访问的完整地址,支持 HTTP/HTTPS。如:https://usdoc.cn/vw/文件模板.docx |
| m | int | 可选 | 预览模式。0=超清 | 1=极速 | 2=图文SVG | 3=动画(PPT) | 4=高清(默认)。不传时默认高清模式。 |
| lt | int | 可选 | 试读页数限制。设为 lt=2 表示仅预览前 2 页,超出页数模糊或隐藏,用于付费阅读场景。 |
| watermark | string | 可选 | 水印文字,叠加在预览页面上。如:watermark=仅供参考。支持中英文及符号。 |
| format | string | 可选 | 输出格式转换。format=pdf 将文件转换为 PDF 后输出,适用于 Word/PPT/Excel/OFD 等格式。 |
| words | string | 可选 | 文本内容提取。words=all 以 JSON 格式返回文档中的所有文字内容,方便后端二次处理。 |
src 参数中的文件地址含有中文或特殊字符时,建议先进行 encodeURIComponent() 编码,避免请求解析异常。预览模式
通过 m 参数选择不同的预览渲染引擎,不同模式在效果、速度和适用场景上各有侧重。
模式参数示例
# 高清模式(默认,不传 m) https://vw.usdoc.cn/?src=https://usdoc.cn/vw/文件模板.docx # 极速模式 https://vw.usdoc.cn/?m=1&src=https://usdoc.cn/vw/文件模板.docx # 图文 SVG 模式 https://vw.usdoc.cn/?m=2&src=https://usdoc.cn/vw/文件模板.docx # PPT 动画模式 https://vw.usdoc.cn/?m=3&src=https://usdoc.cn/vw/PPT文件预览.pptx
效果截图
高清模式效果

极速模式效果

高级功能
预览加水印
通过 watermark 参数在文档预览页面上叠加自定义水印文字,用于版权保护或内容标注。
# watermark 参数值即为水印文字(支持中文) https://vw.usdoc.cn/?watermark=仅供参考&src=https://usdoc.cn/vw/文件模板.docx
支持中文 支持英文 Word ✓ PPT ✓ WPS ✓ OFD ✓ Excel 暂不支持
预览示例:查看水印效果 →
试读页数控制
通过 lt 参数限制预览的页数,超出页数的内容将被模糊处理,适用于付费阅读、文档试看等场景。
# 只允许预览前 2 页 https://vw.usdoc.cn/?lt=2&src=https://usdoc.cn/vw/文件模板.docx # 只允许预览第 1 页(PPT) https://vw.usdoc.cn/?lt=1&src=https://usdoc.cn/vw/PPT文件预览.pptx
预览示例:查看试读效果 →
转换输出 PDF
通过 format=pdf 参数,将 Word/PPT/Excel/OFD 等格式文件在服务端转换为 PDF 后返回,浏览器将自动触发下载或在线显示。
# Word 转 PDF https://vw.usdoc.cn/?format=pdf&src=https://usdoc.cn/vw/文件模板.docx # PPT 转 PDF https://vw.usdoc.cn/?format=pdf&src=https://usdoc.cn/vw/PPT文件预览.pptx # OFD 转 PDF https://vw.usdoc.cn/?format=pdf&src=https://usdoc.cn/vw/三好学生申请书v1.ofd
提取文本内容
通过 words=all 参数,服务端将解析文档并以 JSON 格式返回文档中的全部文字内容,可用于全文检索、内容分析等场景。
# 提取 Word 文档中的全部文字 https://vw.usdoc.cn/?words=all&src=https://usdoc.cn/vw/文件模板.docx
集成示例
根据您的技术栈,选择最适合的集成方式。
直接访问预览地址
最简单的方式,将拼接好的预览 URL 直接在浏览器中打开,或通过超链接跳转。
<a href="https://vw.usdoc.cn/?src=https://example.com/doc/report.docx" target="_blank" rel="noopener noreferrer"> 点击预览文档 </a>
iframe 嵌入
将预览内容嵌入页面中展示,适合 OA 系统、企业内网等场景。
<iframe src="https://vw.usdoc.cn/?src=https://example.com/doc/report.docx" width="100%" height="600px" frameborder="0" allowfullscreen ></iframe>
m=1)以隐藏工具栏,界面更简洁。JavaScript 新窗口打开
function previewDoc(fileUrl) { const url = 'https://vw.usdoc.cn/?src=' + encodeURIComponent(fileUrl); window.open(url, '_blank'); }
// methods previewDoc(fileUrl) { const url = `https://vw.usdoc.cn/?src=${encodeURIComponent(fileUrl)}`; window.open(url, '_blank'); }
const previewDoc = (fileUrl) => { const url = `https://vw.usdoc.cn/?src=${encodeURIComponent(fileUrl)}`; window.open(url, '_blank'); }; // JSX <button onClick={() => previewDoc(row.fileUrl)>预览</button>
微信小程序集成
在微信小程序中,使用 <web-view> 组件加载预览地址即可实现文档预览。
vw.usdoc.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://vw.usdoc.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 | 支持动画模式(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 | 代码高亮展示 |
常见问题
src 参数的值进行 URL 编码:encodeURIComponent('https://example.com/文件模板.docx')编码后再拼接到请求 URL 上即可解决。
m=1)即可隐藏顶部工具栏,界面更简洁,适合嵌入场景:https://vw.usdoc.cn/?m=1&src=YOUR_FILE_URLvw.usdoc.cn 添加到业务域名白名单。同时确保 src 参数中的文件服务域名也已添加。