テキストの検索と置換 - コンテンツエディター API
PDF4me テキストの検索と置換 特定のテキストパターンを検索して置換できます PDF 文書。 API サービスプロセス PDF ファイルを検索し、指定されたページ上の新しいコンテンツに置き換えるテキストを探します。 API 受け取る PDF コンテンツと置換パラメータを通じて REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能を搭載。柔軟なページターゲティングとテキストパターンマッチングに対応しており、ドキュメントの更新やコンテンツ管理ワークフローに最適です。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- テキストパターンマッチング: 特定のテキストパターンを検索して置換します PDF 文書
- 柔軟なページターゲティング特定のページまたはドキュメント全体をカスタムページシーケンスで処理する
- ページシーケンスのサポート対象を個々のページ、ページ範囲、または複数のページの組み合わせに設定します。
- Base64 エンコーディング: 安全なファイルコンテンツ送信 Base64 エンコーディング
- 単純 API 統合: 安らかな API 自動化向けに設計されています PDF テキスト編集ワークフロー
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのテキスト検索および置換操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
/api/v2/FindAndReplace
REST API パラメータ
検索と置換テキストのパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| jobIdExt | Optional | Your own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string. | |
| integrations | Optional | Integration identifiers, forwarded unchanged with the job's notification settings. Type: array. | |
| isAsync | Optional | Set to `true` to process the action asynchronously and get a job to poll at `/api/v2/GetActionStatus`. Only honoured by actions that support asynchronous processing. Type: boolean. | true |
| docName | Optional | Source file name including its extension. Several actions dispatch on the extension, so it should always be set; when omitted a per-action default is used. Type: string. | output.pdf |
| docContent | Required | The source file. Accepts the base64-encoded file content, a `pdf4meblobid://<id>` reference to a previously uploaded blob, or an `https` URL to the source document. Required: an empty value fails with `File is empty`. Type: string. | JVBERi... |
| docContentBytes | Optional | Alternative raw byte payload for the source file. Type: string. | |
| callBackUrl | Optional | Optional URL notified when an asynchronous job completes. Type: string. | |
| oldText | Optional | Text to search for. Type: string. | This is some |
| newText | Optional | Text that replaces each match. Type: string. | Here is few |
| pageSequence | Optional | Pages to search, e.g. `1`, `1,3,5`, `2-5` or `1-` (1 to the last page). Type: string. | 1 |
出力
の PDF4me テキストの検索と置換 REST API 処理モードに基づいて異なる応答を返します。 API 返します PDF として バイナリデータ 同期処理用、またはポーリング機能を提供する URL 非同期処理のため。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
いつ async 設定されていないか、 false、 API リクエストを即座に処理します。
ステータスコード: 200 OK
コンテンツタイプ: application/pdf または application/octet-stream
応答本文:
の API 返します PDF ファイルをバイナリデータとして直接保存する( JSON)
使用方法:
- レスポンスボディにはバイナリが含まれています PDF データ
- 応答内容を直接保存 PDF ファイル
- いいえ Base64 バイナリ応答にはデコードが必要です
例(JavaScript):
const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly
非同期処理
いつ async: true 設定されている、 API リクエストを非同期的に処理します。
ステータスコード: 202 Accepted
レスポンスヘッダー:
Location: https://api.pdf4me.com/api/v2/FindAndReplace/poll/12345-abcde-67890
投票プロセス:
- 抽出する
Location202レスポンスのヘッダー - 投票する URL 使用 GET リクエスト
- 受信するまで投票を続けてください 200 OK 状態
- 最終応答にはバイナリが含まれています PDF データ
投票例:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const pdfBlob = await pollResponse.blob();
// Process binary PDF
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
エラー応答
| ステータスコード | 説明 | 回答例 |
|---|---|---|
| 400 Bad Request | 無効なリクエストパラメータ、または必須フィールドが欠落しています | {"error": "Missing required parameter: oldText"} |
| 401 Unauthorized | 無効または欠落 API 鍵 | {"error": "Unauthorized"} |
| 500 Internal Server Error | 処理中にサーバーエラーが発生しました。 | {"error": "Internal server error"} |
反応を理解する
- 同期(200): バイナリを返します PDF データを直接
- 非同期(202): ポーリング用のLocationヘッダーを返します。最終的な応答はバイナリです。 PDF
- いいえ JSON ラッパー: その API リターン PDF バイナリとして、ラップされていない JSON と Base64 エンコーディング
リクエスト例
ヘッダ
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
注記: の API キーは Base64 エンコードします。 API 鍵から PDF4me ダッシュボード
ペイロード
{
"docContent": "JVBERi...",
"docName": "output.pdf",
"oldText": "input_old_text",
"newText": "output_new_text",
"pageSequence": "1"
}
コードサンプル
の PDF4me テキストの検索と置換 REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
テキスト置換機能
テキストパターン処理
- 完全一致大文字小文字を区別するテキストパターンマッチングによる正確な識別
- パターン認識特定の単語、フレーズ、テキストパターンのサポート
- カスタムパターン特定のテキスト置換要件に対応した柔軟なパターン作成
- プロフェッショナルな成果: 正確なパターンマッチングによる信頼性の高いテキスト置換
- 高度な処理複雑なテキスト構造と書式設定のサポート
ページ処理
- ページターゲティング特定のページまたは文書全体のテキストを置換する
- ページシーケンスカスタムページ範囲と個別ページ選択のサポート
- フレキシブル処理: あらゆるページの組み合わせを精密に制御して処理します
- バッチ処理: 複数のページを効率的に処理 API 電話
- プロフェッショナルなレイアウト: 対象ページ全体で一貫したテキスト置換
高度な機能
- テキスト分析: 包括的なテキストパターン分析と識別
- コンテンツ管理高度なコンテンツ編集およびテキスト置換オプション
- プロフェッショナルな編集: 鮮明な視認性を備えた高品質なテキスト置換
- 柔軟なパターンあらゆるテキストパターンと置換要件に対応
業界におけるユースケースとアプリケーション
- Business & Enterprise
- Legal & Professional Services
- Finance & Banking
- Government & Compliance
ビジネスおよび企業向けユースケース
- 文書の更新複数のテキストコンテンツを自動的に更新する PDF 文書
- コンテンツ管理古い情報を最新のデータに置き換えてください PDF ファイル
- テンプレート処理: ドキュメントテンプレート内のプレースホルダーテキストを実際のコンテンツに更新する
- ブランドマネジメント: 企業名、ロゴ、ブランディング要素を更新します PDFs
法律・専門サービスにおけるユースケース
- 法律文書の編集: 法律文書中の特定の用語や条項を置き換える PDF 文書
- 契約内容の更新法的文書全体にわたる契約条件と条項を更新する
- コンプライアンスに関する最新情報: 文書内の規制情報とコンプライアンスデータを置き換える
- 法律文書の標準化文書全体で法律用語を標準化する
金融・銀行業務におけるユースケース
- レポート生成生成されたメトリクス、日付、データポイントを更新します PDF 報道
- 財務書類の更新: 財務情報を更新します PDF 文書
- コンプライアンスに関する最新情報: 財務書類中の規制情報を置き換える
- 財務報告の標準化レポート全体で財務用語を標準化する
政府およびコンプライアンス関連のユースケース
- コンプライアンスに関する最新情報: 文書内の規制情報とコンプライアンスデータを置き換える
- 規制関連文書政府文書の規制情報を更新する
- 文書の標準化文書コレクション全体で用語と書式を標準化する
- 公文書公的記録および政府文書の情報を更新する