Wordにテキスト透かしを追加する - テキスト透かし API
PDF4me Wordにテキスト透かしを追加する 包括的なスタイル設定と位置制御により、カスタマイズ可能なテキスト透かしをWord文書に追加できます。 API このサービスは、Word ファイルを処理し、テキストの内容、フォントの種類、フォントサイズ、色、回転角度、方向のプリセット、透明度レベルを完全に制御してテキスト透かしを追加します。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全な送信のためのエンコード機能。セキュリティラベル、ブランディング要素、機密保持通知、ステータスマーカーに対応しており、文書セキュリティ、ブランド保護、ステータス表示ワークフローに最適です。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- テキスト透かしのサポート: 任意のカスタムテキストコンテンツを含むプロフェッショナルなテキスト透かし
- フォントのカスタマイズフォントファミリー、フォント名、フォントサイズを完全に制御できます。
- カラーオプション: 色名、16進数コード、RGB値、および3桁の16進数に対応
- 回転制御カスタム回転角度(0~360°)または事前定義された向きプリセット
- 透明性オプション半透明または完全に不透明な透かし効果
- 自動サイズ調整テキストの長さとフォントサイズに基づいたインテリジェントなサイズ調整
- 文書全体への適用:すべてのセクションとヘッダーに透かしが入っています
- テキスト配置の背後: 文書コンテンツの背後に透かしが入ります
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのテキスト透かし追加操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
office/ApiV2Word/AddTextWatermark
REST API パラメータ
Wordにテキスト透かしを追加する際のパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 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. | UEsDBBQABgAIAAAA... |
| isAsync | Optional | Process the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean. | |
| watermarkText | Required | The watermark text. Type: string. | CONFIDENTIAL |
| fontName | Optional | Font name. `fontFamily` is accepted as an alternative. Type: string. | Arial |
| fontSize | Optional | Font size in points. Type: number. | 72 |
| fontColor | Optional | Color name, hex (`#C00000`) or `RGB(192,0,0)`. Defaults to grey. Type: string. | #FF0000 |
| semiTransparent | Optional | Show the text at 50% opacity. Type: boolean. | true |
| orientation | Optional | Not case-sensitive. Type: string. | Diagonal |
| rotation | Optional | Rotation in degrees. Only used when `orientation` is not set. Type: number. | 45 |
テキストの向きのオプション
透かし文字の向きは、このパラメータの優先順位に従います。
- 方向 - 指定されている場合は、定義済みの方向角度を使用します
- 回転 - 方向が指定されていない場合は、カスタム回転角度を使用します。
- デフォルト - どちらも指定されていない場合は、0°(水平)を使用します。
事前定義された方向:
- 水平: 0°(デフォルト)
- 垂直: 90°
- 対角線: 45°
- 逆さまに: 180°
出力
の PDF4me Wordにテキスト透かしを追加する 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
}
回答欄:
- 書類 (文字列):テキスト透かしが適用されたWord文書をエンコードしたもの Base64
- ファイル名 (文字列):出力Wordファイル名
- 成功 (ブール値):操作が成功したかどうか
- エラーメッセージ (文字列): 成功が偽の場合のエラーメッセージ。それ以外の場合は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 エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています(
書類、ドキュメントコンテンツ、透かしテキスト) 透かしテキストnull、空、または空白のみにすることはできません- 無効 Base64 エンコーディング
ドキュメントコンテンツ - 無効または破損したWord文書
- 無効なフォントサイズです(1~1000の範囲で指定してください)
- 無効な回転角度
- 無効または欠落 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": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL"
}
高度な例(オプションフィールド付き):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL",
"orientation": "Diagonal",
"fontFamily": "Arial",
"fontSize": 72,
"fontColor": "#FF0000",
"semiTransparent": true,
"cultureName": "en-US"
}
カスタム回転の例:
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "DRAFT",
"fontFamily": "Times New Roman",
"fontSize": 48,
"fontColor": "Gray",
"rotation": 45,
"semiTransparent": true
}
コードサンプル
の PDF4me Wordにテキスト透かしを追加する REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
業界におけるユースケースとアプリケーション
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
法律・専門サービスにおけるユースケース
- 機密文書法的文書に「機密」の透かしを入れる
- 契約書案: 合意案には「草案 - 審査中」のステータスを付ける
- 特権ラベル「弁護士・依頼者間の秘匿特権」というテキスト透かしを適用する
- ステータスマーカー「承認済み」または「審査中」のステータスを示してください。
ビジネスおよび企業向けユースケース
- 価格表料金表に「機密価格」というテキスト透かしを追加する
- 提案: クライアント提案書に「© 2024 [会社名]」という透かしを入れる
- 内部報告書: 内部分析データには「内部使用のみ」と明記してください。
- 草稿資料「草稿 - 配布禁止」ステータスを示す
教育・研究における活用事例
- 患者データ患者記録に「HIPAA PROTECTED」というテキスト透かしを追加する
- 医療報告書検査結果に「機密医療情報」の透かしを入れる
- 研究データ「研究データ - 機密」というテキスト透かしを適用する
- 保険金請求保険書類に「プライバシー保護」ラベルを貼る
金融・銀行業務におけるユースケース
- 財務諸表のセキュリティ財務報告書に「機密」という透かしを入れる
- 予算案: 予算案文書に「DRAFT」ステータスの透かしを入れる
- 監査文書監査成果物に「監査コピー」というテキスト透かしを適用する
- 顧客レポート顧客向けレポートに「© 2024 [会社名]」というテキスト透かしを追加する