メインコンテンツへスキップ
PDF4me API統合AIとSDK知識ベース拡張機能APIテスターブログ

テキストをハイライト表示

PDF → テキストをハイライト表示

このエンドポイントは ハイライト 郵便配達人コレクション： POST /api/v2/HighlightText 体と共に document、 docContent、 そして textHighlightingAction （Postmanのrawと同じキーとネスト構造） 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...

ポストマンと同じ構造（生身の体）​

エクスポートされたコレクションは、以下の最上位プロパティを正確に使用します。

{
 "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 そのコレクションには、上記の3つのキーと認証ヘッダーのみが含まれます。

もしあなたが見たら 400: "Invalid File"​

その回答は API その時 ファイルバイトは受け付けられません （ JSON キーが間違っている）。典型的な原因：

  1. 本物のPDFではありません: このアクションは、 PDFWordファイル、画像、または空のコンテンツは送信しないでください。 ファイルが空です / 無効なファイルです。
  2. document.Name vs ファイル： 使用 document.Name と共に 同じベースファイル名 として PDF エンコードしたもの（ .pdf)、例えばアップロードする場合 invoice.pdf、 使用 { "Name": "invoice.pdf" }不一致は、一部の環境において検証失敗の原因となる可能性があります。
  3. Base64 他の場所から貼り付けたもの： 取り除く 改行 で Base64 文字列を含めず data:application/pdf;base64, フィールド内の接頭辞（テスターは送信時に両方とも削除しますが、破損または切り詰められたペーストは依然として失敗します）。
  4. 貼り付けるのではなくアップロードしてください： 使用 ファイルのアップロード の上 ドキュメントコンテンツ エンコーディングは単一の連続的なものです Base64 弦。

その他の400の原因​

  • JSON末尾にカンマは不要です。 テキストハイライトアクション 空でない要素を含める必要があります テキストハイライトリスト。
  • 環境: 郵便配達員は使用する可能性があります 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