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

高亮文本

PDF → 高亮文本

此端点与 强调 邮差系列： POST /api/v2/HighlightText 身体 document， docContent， 和 textHighlightingAction （与 Postman 的原始版本具有相同的键和嵌套结构） JSON）。

尝试使用高亮文本 API​

:::备注 快速参考 小路： POST /api/v2/HighlightText （邮递员： https://api.pdf4me.com/api/v2/HighlightText）· 身体钥匙： document， docContent， textHighlightingAction · 标题： Content-Type: application/json， Authorization: Basic <api-key> :::

在线体验
  1. 文档： JSON 带有对象 Name （首都 N例如 { "Name": "Thiscar.pdf" }离开场地 空的 （删除所有文本）如果您不想…… document 根本没有房产。
  2. 文档内容： PDF 作为 Base64 （上传文件）。实际运行必须不为空（与 Postman 相同）。
  3. 文本高亮操作： JSON 带有对象 TextHighlightList：一个数组 { "Text": "…", "HighlightColor": "#RRGGBB" }.
Loading API Tester...

与 Postman 结构相同（原始主体）​

您导出的集合正是使用以下顶级属性：

{
 "document": {
 "Name": "Thiscar.pdf"
 },
 "docContent": "<base64: from Postman or from file upload here>",
 "textHighlightingAction": {
 "TextHighlightList": [
 { "Text": "Welcome", "HighlightColor": "#FF2C00" },
 { "Text": "promise", "HighlightColor": "#00FF00" }
 ]
 }
}

有 不 docName， async， 或者 IsAsync 该集合中仅包含以上三个键以及身份验证标头。

如果你看到 400： "Invalid File"​

这一回应来自 API 当 文件字节不被接受 （不是当 JSON 钥匙错误）。常见原因：

  1. 这不是真正的PDF文件。该操作需要一个 PDF请勿发送 Word 文档、图片或空白内容。参见 文件为空/无效文件。
  2. document.Name 与文件： 使用 document.Name 和 相同的基本文件名 作为 PDF 您已编码（包括） .pdf例如，如果您上传 invoice.pdf， 使用 { "Name": "invoice.pdf" }在某些环境下，不匹配可能会导致验证失败。
  3. Base64 从其他地方粘贴： 消除 换行符 在 Base64 字符串，且不包含 data:application/pdf;base64, 字段中的前缀（测试人员在发送时会删除两者，但损坏或截断的粘贴仍然会失败）。
  4. 上传而不是粘贴： 使用 上传文件 在 文档内容 因此，编码是一个连续的过程。 Base64 细绳。

其他 400 个原因​

  • JSON：末尾不加逗号； 文本高亮操作 必须包含一个非空元素 文本高亮列表。
  • 环境Postman 可能使用 api.pdf4me.com文档测试人员可能会使用 api-dev.pdf4me.com 或者代理人， JSON 主体部分应该仍然匹配。

概述、参数和用例​

字段 → JSON 映射​

每个身体参数名称都是 JSON 钥匙： document， docContent， textHighlightingAction与 查找和替换 风格测试员。

邮递员平价​

进口 Highlight.postman_collection 并进行比较 生的 身体与 cURL 在测试器中预览，上传后应该匹配。 PDF。

先决条件​

回复格式​

通常是高亮显示 PDF （二进制或 JSON 和 文档内容）。

获取帮助​

Get Your API KeyAPI DocumentationAPI Tester Home