文書の結合 - 文書アセンブリ API
PDF4me ドキュメントを結合する 複数の Word 文書を高度な書式設定とコンプライアンス オプションを備えた単一の文書に結合することができます。 API このサービスは、複数の Word ファイルを処理し、柔軟な文書順序、カスタマイズ可能な書式設定モード、コンプライアンス レベル設定、タイムゾーン メタデータ、およびインテリジェントなスタイル処理を使用してそれらを結合します。 API ドキュメントの内容は以下を通じて受信されます REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能を搭載。無制限のドキュメント結合と結合動作の完全な制御に対応しており、ドキュメントの組み立て、レポートの統合、コンテンツ管理ワークフローに最適なソリューションです。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- 複数ドキュメントのサポート無制限の数のドキュメントを1つに結合します
- シンプルな配列構造使いやすい配列 Base64-エンコードされたドキュメントの内容
- 順序付きマージ: 配列に表示される順序でドキュメントがマージされます
- 基本文書のコンセプト最初のドキュメントがマージの基盤となる
- 複数フォーマット対応Word文書、PDF、およびその他の対応フォーマットを結合します。
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするための方法。すべてのドキュメントマージ操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
office/ApiV2Word/MergeDocuments
REST API パラメータ
ドキュメント結合のパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク(*)が付いているパラメータは必須です。 文書 配列には少なくとも1つのドキュメントが含まれている必要があります。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| documents | Required | The files to merge. Type: array. | [{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }] |
| mergeOptions | Optional | Object carrying this operation's settings. Its fields are the mergeOptions rows below. | {} |
| mergeOptions.timeZone | Optional | Saved as the custom document property `TimeZone`. Type: string. | |
| isAsync | Optional | Process the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean. | |
文書差し込み印刷順序
ドキュメントは、表示される順序でマージされます。 文書 配列:
- 配列の最初のドキュメントは 基本文書
- 以降のすべての文書は 添付 配列の順序でベースドキュメントに
出力
の PDF4me ドキュメントを結合する REST API 処理モードに基づいて異なる応答を返します。 API Word文書をとして返します Base64-エンコードされた文字列 JSON フォーマットバイナリデータとしてではなく。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
の API リクエストを処理し、以下を返します。
ステータスコード: 200 OK
コンテンツタイプ: application/json
応答本文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "merged-document.docx",
"success": true,
"errorMessage": null
}
回答欄:
- 書類 (文字列):すべての入力ドキュメントを含む結合された Word ドキュメント、エンコード形式は Base64 弦
- ファイル名 (文字列):出力Wordファイル名
- 成功 (ブール値):リクエストが成功したかどうかを示します。
- エラーメッセージ (文字列またはnull):成功がfalseの場合のエラーの詳細
使用方法:
- 抽出する
documentからのフィールド JSON 応答 (Base64) - 解読する Base64 バイナリ形式のWord文書データを取得する文字列
- 必要に応じてWordファイルを保存または処理する。
例(JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
非同期処理
非同期動作 (202 Accepted ポーリングによる)は、リクエストボディパラメータではなく、サーバー構成によって制御されます。有効にすると、 API ポーリングで202ステータスを返す場合があります URL で Location ヘッダー。 URL と GET 200件のリクエストを受け取るまで OK 同じレスポンス形式(ドキュメント、ファイル名、成功、エラーメッセージ)を使用します。
エラー応答
の API 標準を返します HTTP エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています(
文書配列) - マージするドキュメントがありません(ドキュメント配列が空です)
- 無効 Base64 ドキュメントコンテンツ内のエンコード
- 無効または破損した文書
- 無効または欠落 API 鍵
- API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
- ない
認証: 基本ヘッダー
- サーバー側処理エラー
- ワード文書の処理エラー
- 文書結合エラー
エラー応答フォーマット:
{
"error": "Error message describing what went wrong"
}
回答形式の詳細
重要: の API 常に返される JSONバイナリ形式のワードデータを直接扱わないでください。
応答構造:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or 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("output.docx", wordBytes);
リクエスト例
ヘッダ
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
注記:
- 手に入れよう API 鍵から PDF4me ダッシュボード
- の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
- 例: API 重要なのは
abc123エンコードして Base64 そして使用するAuthorization: Basic YWJjMTIz
ペイロード
基本的な例(2つの文書):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
]
}
高度な例(複数の文書を結合するオプション):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
{ "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
],
"mergeOptions": {}
}
コードサンプル
の PDF4me ドキュメントを結合する REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
業界におけるユースケースとアプリケーション
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
法律・専門サービスにおけるユースケース
- 契約組立契約書の各条項を組み合わせて、完全な法的文書を作成する。
- 法律文書の要約複数の簡潔なセクションを統合して、包括的な法律文書を作成する
- コンプライアンス文書規制当局への提出書類を統合する
- クライアント文書アセンブリ顧客固有のドキュメントを完全なパッケージにまとめる
ビジネスおよび企業向けユースケース
- 提案アセンブリ提案書の各セクションを組み合わせて、完全な顧客向け提案書を作成する
- マーケティング資料の統合キャンペーン用のマーケティング文書を統合する
- 販売プレゼンテーション資料作成プレゼンテーションの各セクションを組み合わせて、完全なプレゼンテーションを作成する
- クライアント向け成果物アセンブリ顧客固有の資料を統合する
教育・研究における活用事例
- 医療報告書の作成医療報告書の各セクションを組み合わせて、完全な患者報告書を作成します。
- プロトコル文書プロトコルの各セクションを統合して、包括的な医療プロトコルを作成する
- 研究資料研究報告書用の研究資料を統合する
- コンプライアンスマニュアルアセンブリ医療コンプライアンス文書を組み合わせる
金融・銀行業務におけるユースケース
- 財務報告書アセンブリ財務報告書の各セクションを統合して完全な報告書を作成する
- 監査文書包括的な監査報告書を作成するために、監査文書を統合する。
- 予算統合異なる部署の予算項目を統合する
- 規制当局への提出書類一式提出用の規制文書を統合する