跳到主要内容
PDF4me API集成知识库扩展API 测试员博客

用图片替换文本 - 图片替换 API

PDF4me 将文本替换为图像 此功能允许您在 Word 文档中用图像替换指定的文本，并提供高级页面筛选和大小控制选项。 API 该服务处理 Word 文件，并使用精确的文本匹配、可自定义尺寸（保持宽高比）、页面特定定位和灵活的筛选选项，将文本占位符替换为图像。 API 通过接收 Word 文档内容和图像数据 REST API 利用电话 Base64 采用编码技术实现安全传输。该解决方案支持多种图像格式，并可完全控制替换行为，是文档自动化、模板处理和动态内容插入工作流程的理想之选。

相关博客文章
目前尚无关于此功能的博客文章——敬请期待。
在此期间，您可以浏览 PDF4me 博客，查看适用于各平台的教程和工作流程。
访问博客 →

验证您的身份 API 要求​

要访问 PDF4me REST API每个请求都必须包含正确的身份验证凭据。身份验证可确保通信安全，并验证您作为授权用户的身份。 REST API。

Get your api Key

主要特点​

  • 文本转图像替换在文档中将特定文本字符串替换为图像。
  • 精确文本匹配区分大小写的文本搜索和替换
  • 图像尺寸控制：通过宽度和高度参数自定义图像尺寸
  • 保持宽高比调整图像大小时保持图像比例
  • 页面筛选：针对特定页面或页面范围进行替换
  • 高级筛选：跳过首页、指定奇数页/偶数页，或指定确切页码
  • 多种图像格式支持 PNG， JPG， JPEG， BMP， GIF 格式
  • 灵活定位以 Word 形状的形式插入图像，并精确定位

REST API 端点​

这 PDF4me REST API 使用标准 HTTP 与资源交互的方法。所有文本到图像的替换操作都通过单个端点执行：

  • 方法： POST
  • 终点： office/ApiV2Word/ReplaceTextWithImage

REST API 参数​

“将文本替换为图像”功能的完整参数列表 REST API参数按类别组织，以便更好地理解和实施。

重要的： 标有星号 (*) 的参数为必填项。高级参数可对图像大小和页面筛选进行更精细的控制。

必需参数​

范围类型描述例子
文档*Object文档描述符。必须包含 姓名 （string输出带有 .docx 扩展名的 Word 文件名{ "Name": "document.docx" }
文档内容*Base64Word文档内容编码 Base64本文档将进行文本替换。必须是有效的 Word 文档（.docx、.doc 格式）。base64EncodedDocumentContent
查找文本*String要在文档中搜索的文本字符串。区分大小写。所有匹配项都将被替换为图像。不能为空或为 null。示例："[LOGO]", "SIGN_HERE""text to replace"
图片内容*Base64替换图像文件内容编码 Base64必须是有效的图像（PNG， JPG， JPEG， BMP， GIF）base64EncodedImageContent

可选参数​

范围类型描述例子
宽度数字（双精度浮点数）图片宽度200
高度数字（双精度浮点数）图片高度100
保持宽高比Boolean调整图像大小时保持图像比例。默认值：truetrue
跳过第一页Boolean跳过第一页的替换步骤。 true 跳过第一页 false = 包含（默认）。适用于封面/标题页。false
适用于String替换目标范围-
页码String指定页码或页码范围（例如，“1,2,3”或“1,3,5-7”）。空白 = 所有页面"1,2,3"
忽略页码String排除在替换范围之外的页码-
文化名称String文化代码（例如“en-US”、“fr-FR”、“de-DE”）。默认值：空en-US

页面筛选​

这 API 支持通过以下参数进行页面筛选：

  • 跳过第一页控制是否跳过第一页
  • 页码：指定要处理的页面（空字符串 = 所有页面）
  • 忽略页码要排除的页码

支持的图像格式​

将文本替换为图像 API 支持多种图像格式，以实现最大兼容性：

格式扩大描述
PNG.png便携式网络图形 (PNG)——最适合用于带有透明度的徽标和图形
JPEG.jpg，.jpeg联合图像专家组 (JPEG)——最适合照片和复杂图像。
BMP.bmp位图 - 未压缩格式，文件较大
GIF.gif图形交换格式 (GIF) - 支持动画和透明度

输出​

这 PDF4me 将文本替换为图像 REST API 返回一个 JSON 回复 （ApiV2WordApiCallRes成功之后 API 返回 Word 文档。 Base64编码字符串 在 document 字段，而不是二进制数据。

成功响应

状态码： 200 OK

内容类型： application/json

回复正文：

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

回复字段：

  • 文档 （string）：将文本替换为图像的 Word 文档，编码为 Base64
  • 文件名 （string输出的 Word 文件名
  • 成功 （boolean手术是否成功
  • 错误信息 （string）：如果成功为假，则显示错误消息；否则为空

使用方法：

  1. 查看 success；如果为真，则提取 document 来自该领域的 JSON 回复
  2. 解码 Base64 获取二进制 Word 文档数据的字符串
  3. 使用以下命令保存或处理 Word 文件 fileName

示例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const wordBytes = atob(data.document);
// Save or process wordBytes

请求示例​

标题​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

笔记：

  • 获得你的 API 钥匙 PDF4me 仪表板
  • 这 API 关键必须是 Base64 编码后以“Basic”为前缀 Authorization 标题
  • 例如：如果你的 API 关键是 abc123将其编码为 Base64 并使用 Authorization: Basic YWJjMTIz

有效载荷​

基本示例（仅必填字段）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "findText": "text to replace",
 "imageContent": "base64EncodedImageContent",
 "cultureName": "en-US"
}

高级示例（含可选字段）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "findText": "text to replace",
 "imageContent": "base64EncodedImageContent",
 "width": 200,
 "height": 100,
 "maintainAspectRatio": true,
 "skipFirstPage": true,
 "pageNumbers": "1,2,3",
 "ignorePageNumbers": null,
 "cultureName": "en-US"
}

代码示例​

这 PDF4me 将文本替换为图像 REST API 提供多种编程语言的代码示例。请选择最适合您开发环境的语言：

C# （CSharp） 样本

完全的 C# 在 Word 文档中将文本替换为图像的实现方法：

行业应用案例及应用​

法律及专业服务用例

  • 合同处理：将签名占位符替换为授权签名
  • 法律文件自动化在法律文件中插入公司徽标和水印
  • 客户文档个性化在法律文件中添加客户专属图片
  • 合规文件在文件上插入合规印章和封条

获取帮助​

Get Your API KeyAPI SamplesGetting Started