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

テキスト置換 - テキスト置換 API

PDF4me テキストを置換 高度な検索オプションを使用して、Word 文書内のテキストを検索および置換できます。 API このサービスはWordファイルを処理し、大文字小文字を区別する一致と単語全体の一致による複数の置換操作を実行します。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能を搭載。単一のリクエストで複数の検索置換操作をサポートしているため、文書自動化、テンプレート処理、コンテンツ管理ワークフローに最適です。

関連ブログ記事
この機能に関するブログ記事はまだありません。近日公開予定です。
その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。
ブログをご覧ください →

認証 API リクエスト​

アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。

Get your api Key

主な機能​

  • 複数のテキスト置換複数の検索置換操作を1つのアクションで実行する
  • 詳細検索オプション大文字小文字を区別するマッチングと単語全体のマッチング
  • 逐次処理: 複数の交換品は指定された順序で処理されます
  • 柔軟なマッチング: 完全一致、部分一致、または単語全体の一致
  • シンプルな構造使いやすい検索置換操作の配列

REST API 終点​

の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのテキスト置換操作は、単一のエンドポイントを介して実行されます。

  • 方法： POST
  • 終点： office/ApiV2Word/ReplaceText

REST API パラメータ​

テキスト置換のパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク(*)が付いているパラメータは必須です。 フレーズ 配列には少なくとも1つの置換フレーズが含まれている必要があります。

パラメータ必須その機能例
documentRequiredSource file. `Name` must end in `.docx` or `.doc`.{ "Name": "document.docx" }
document.NameRequiredFile name including its extension. Type: string.{ "Name": "document.docx" }
docContentRequiredThe source file, base64-encoded. Type: string.UEsDBBQABgAIAAAA...
isAsyncOptionalProcess the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean.
phrasesRequiredOne entry per replacement, applied in order. Type: array.See example below

テキスト置換オブジェクトの構造（フレーズ配列）​

各アイテム フレーズ 配列は、以下の構造を持つオブジェクトでなければなりません。

テキスト置換処理​

  • 各交換部品は指定された順序で順次処理されます
  • 同じ文書に対して複数の置換を実行できます。
  • 検索テキストのすべてのインスタンスが置換されます（単語全体一致を使用する場合を除く）。

出力​

の PDF4me テキストを置換 REST API 処理モードに基づいて異なる応答を返します。 API Word文書をとして返します Base64-エンコードされた文字列 JSON フォーマットバイナリデータとしてではなく。

同期処理（デフォルト）

の API リクエストを処理し、以下を返します。

ステータスコード: 200 OK

コンテンツタイプ: application/json

応答本文：

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

回答欄:

  • 書類 （string): テキスト置換が適用された Word 文書をエンコードしたもの Base64 弦
  • ファイル名 （string出力Wordファイル名
  • 成功 （boolean): リクエストが成功したかどうかを示します
  • エラーメッセージ （string または null): 成功が偽の場合のエラーの詳細

使用方法：

  1. 抽出する document からのフィールド JSON 応答 （Base64）
  2. 解読する Base64 バイナリ形式のWord文書データを取得する文字列
  3. 必要に応じてWordファイルを保存または処理する。

例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// 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",
 "phrases": [
 {
 "findText": "old text",
 "replaceText": "new text",
 "matchCase": false,
 "matchWholeWord": false
 }
 ],
 "cultureName": "en-US"
}

高度な例（複数置換）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "phrases": [
 {
 "findText": "[COMPANY_NAME]",
 "replaceText": "Acme Corporation",
 "matchCase": false,
 "matchWholeWord": false
 },
 {
 "findText": "[DATE]",
 "replaceText": "2024-01-15",
 "matchCase": false,
 "matchWholeWord": false
 },
 {
 "findText": "[CONTACT_EMAIL]",
 "replaceText": "[email protected]",
 "matchCase": false,
 "matchWholeWord": false
 }
 ],
 "cultureName": "en-US"
}

コードサンプル​

の PDF4me テキストを置換 REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C# （CSharpサンプル

完了 C# Word文書内のテキスト置換の実装例：

業界におけるユースケースとアプリケーション​

法律・専門サービスにおけるユースケース

  • 契約処理: プレースホルダーテキストをクライアント固有の情報に置き換えてください
  • 法律文書の自動化ケース番号、クライアント名、日付を更新する
  • テンプレートの標準化法律用語と書式を標準化する
  • クライアントとのコミュニケーション特定の顧客向けに法的文書をカスタマイズする

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started