テキストを画像に置き換える - 画像置換 API
PDF4me テキストを画像に置き換える 高度なページフィルタリングとサイズ制御オプションを使用して、Word 文書内の指定したテキストを画像に置き換えることができます。 API このサービスは、Word ファイルを処理し、正確なテキストマッチング、アスペクト比を維持したカスタマイズ可能なサイズ設定、ページ固有のターゲティング、柔軟なフィルタリングオプションを使用して、テキストプレースホルダーを画像に置き換えます。 API Word文書の内容と画像データを以下の方法で受信します。 REST API 通話を利用して Base64 安全な送信のためのエンコード機能。複数の画像フォーマットに対応し、置換動作を完全に制御できるため、文書自動化、テンプレート処理、動的コンテンツ挿入ワークフローに最適です。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- テキストから画像への置換: 文書全体で特定のテキスト文字列を画像に置き換える
- 正確なテキストマッチング大文字と小文字を区別するテキスト検索と置換
- 画像サイズコントロール: 幅と高さのパラメータを使用して画像のサイズをカスタマイズします
- アスペクト比の維持: サイズ変更時に画像の縦横比を維持する
- ページフィルタリング置換対象となる特定のページまたはページ範囲を指定します。
- 高度なフィルタリング最初のページをスキップする、奇数ページまたは偶数ページを対象とする、または正確なページ番号を指定する
- 複数の画像フォーマット: サポート PNG、 JPG、 JPEG、 BMP、 GIF フォーマット
- 柔軟な位置決め: 画像をWordの図形として正確な位置に挿入します
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのテキストから画像への置換操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
office/ApiV2Word/ReplaceTextWithImage
REST API パラメータ
テキストを画像に置き換えるためのパラメータの完全なリスト REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク(*)が付いているパラメータは必須項目です。詳細設定パラメータを使用すると、画像サイズやページフィルタリングを細かく制御できます。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| document | Required | Source file. `Name` must end in `.docx` or `.doc`. | { "Name": "document.docx" } |
| document.Name | Required | File name including its extension. Type: string. | { "Name": "document.docx" } |
| docContent | Required | The source file, base64-encoded. Type: string. | base64EncodedDocumentContent |
| isAsync | Optional | Process the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean. | |
| findText | Required | The text to replace. Not case-sensitive. Type: string. | "text to replace" |
| imageContent | Required | The image, base64-encoded. Type: string. | base64EncodedImageContent |
| width | Optional | Image width in points. Defaults to the image size. Type: number. | 200 |
| height | Optional | Image height in points. Defaults to the image size. Type: number. | 100 |
| maintainAspectRatio | Optional | Keep the image's proportions; `width` takes priority. Type: boolean. | true |
| applyTo | Optional | Which matching pages to replace on. Type: string. | |
| pageNumbers | Optional | Only replace on these pages, e.g. `"1,3,5-7"`. Type: string. | "1,2,3" |
| ignorePageNumbers | Optional | Never replace on these pages, e.g. `"2,4"`. Type: string. | |
| skipFirstPage | Optional | Never replace on page 1. Type: boolean. | false |
ページフィルタリング
の API 以下のパラメータによるページフィルタリングをサポートしています。
- skipFirstPage最初のページをスキップするかどうかを制御します
- ページ番号: 処理するページを指定します(空文字列はすべてのページを意味します)
- ページ番号を無視する除外するページ番号
対応画像フォーマット
テキストを画像に置き換える API 最大限の互換性を実現するために、さまざまな画像フォーマットをサポートしています。
| 形式 | 拡大 | 説明 |
|---|---|---|
| PNG | .png | ポータブルネットワークグラフィックス - ロゴや透明度のあるグラフィックに最適 |
| JPEG | .jpg、.jpeg | 合同写真専門家グループ - 写真や複雑な画像に最適 |
| BMP | .bmp | ビットマップ - 非圧縮形式、ファイルサイズが大きい |
| GIF | .gif | グラフィックス交換フォーマット - アニメーションと透明度をサポート |
出力
の PDF4me テキストを画像に置き換える REST API を返します JSON 応答 (ApiV2WordApiCallRes) 成功した場合、 API Word文書をとして返します Base64エンコードされた文字列 で document バイナリデータではなく、フィールドとして扱われます。
- Success Response
- Error Responses
- Response Format Details
成功時の対応
ステータスコード: 200 OK
コンテンツタイプ: application/json
応答本文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
回答欄:
- 書類 (string): テキストが画像に置き換えられた Word 文書、エンコード形式は Base64
- ファイル名 (string出力Wordファイル名
- 成功 (boolean手術が成功したかどうか
- エラーメッセージ (string): 成功が偽の場合はエラーメッセージ。それ以外の場合は null
使用方法:
- チェック
success; 真であれば、抽出しますdocumentからのフィールド JSON 応答 - 解読する Base64 バイナリ形式のWord文書データを取得する文字列
- 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
エラー応答
の API 標準を返します HTTP エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています(
書類、ドキュメントコンテンツ、findText、画像コンテンツ) - FindText nullまたは空です
- ImageContent nullまたは空です
- 無効 Base64 エンコーディング
ドキュメントコンテンツまたは画像コンテンツ - 無効または破損したWord文書
- 無効または破損した画像ファイル
- フィルタリング条件に一致するページはありません
- 無効または欠落 API 鍵
- API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
- ない
認証: 基本ヘッダー
- サーバー側処理エラー
- ワード文書の処理エラー
- テキスト置換に失敗しました
- 画像挿入失敗
エラー応答フォーマット:
{
"error": "Error message describing what went wrong"
}
回答形式の詳細
重要: の API 常に返される JSONバイナリ形式のワードデータを直接扱わないでください。
応答構造(ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": null
}
コンテンツタイプヘッダー:
- 成功:
application/json - Word文書は、 Base64 文字列内の JSON 応答
なぜ Base64?
- JSON-バイナリデータの安全なエンコード
- 簡単に伝達できます HTTP
- すべてのプログラミング言語に対応
- 直接埋め込むことができます JSON 問題から逃れることなく
デコード Base64 Word文書へ変換:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
業界におけるユースケースとアプリケーション
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
法律・専門サービスにおけるユースケース
- 契約処理署名プレースホルダーを承認済みの署名に置き換えてください。
- 法律文書の自動化法的文書に企業のロゴと透かしを挿入する
- クライアント文書のパーソナライゼーション: 法的文書に顧客固有の画像を追加する
- コンプライアンス文書書類にコンプライアンススタンプとシールを挿入する
ビジネスおよび企業向けユースケース
- 提案書の作成提案書に会社のロゴと製品画像を挿入する
- マーケティング資料の作成: プレースホルダーテキストをマーケティング画像に置き換えます
- クライアントプレゼンテーションの自動化: クライアント固有の画像をプレゼンテーションに挿入する
- 営業報告書の作成売上チャートやグラフをレポートに挿入する
教育・研究における活用事例
- 医療レポート作成医療チャートや図表をレポートに挿入する
- 患者文書処理: 患者文書に医療機関のロゴを挿入する
- 研究資料研究論文に研究図表を挿入する
- コンプライアンス文書: 医療コンプライアンススタンプを書類に挿入する
金融・銀行業務におけるユースケース
- 財務報告書の作成財務報告書にグラフや図表を挿入する
- 請求書処理ロゴのプレースホルダーを会社のロゴに置き換えてください。
- 監査文書監査報告書に監査印と署名を挿入する
- 予算レポートの自動化予算文書に予算チャートを挿入する