文書の比較 - 文書比較 API

PDF4me 文書を比較する 2 つの Word 文書を比較し、包括的な比較オプションを使用して変更履歴を追跡できます。 API このサービスは2つのWordファイルを処理し、詳細な変更履歴、カスタマイズ可能な比較設定、改訂管理、および専門的な比較レポートを備えた比較ドキュメントを生成します。 API ドキュメントの内容は両方とも受信されます REST API 通話を利用して Base64 安全な送信のためのエンコード機能。書式設定、大文字小文字の区別、コメント、表、フィールド、脚注、テキストボックス、ヘッダー/フッターなどを完全に制御できるため、文書レビュー、バージョン管理、共同編集ワークフローに最適です。

関連ブログ記事

この機能に関するブログ記事はまだありません。近日公開予定です。

その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。

ブログをご覧ください →

認証 API リクエスト

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

Get your api Key

主な機能

• 文書比較2つのWord文書を比較し、すべての相違点を特定する。
• 変更履歴を追跡する変更履歴を表示したドキュメントを生成する
• カスタマイズ可能なオプション追跡または無視する変更の種類を制御します
• 改訂管理比較前に既存の改訂を整理する
• 著者の帰属変更内容を特定の著者に割り当てて責任を明確にする
• プロフェッショナルな成果物: 改訂履歴を追跡できるクリーンな比較ドキュメントを生成します
• 複数フォーマット対応.docxファイルと.docファイルを比較する
• 高度なフィルタリング書式設定、大文字小文字の変更、コメント、表などを無視します

REST API 終点

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

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

REST API パラメータ

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

重要： アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。

パラメータ	必須	その機能	例
firstDocument	Required	Object carrying this operation's settings. Its fields are the firstDocument rows below.	{ "Name": "original.docx" }
firstDocument.Name	Required	File name including its extension. Type: string.
firstDocContent	Required	The original document, base64-encoded. Type: string.	UEsDBBQABgAIAAAA...
secondDocument	Required	Object carrying this operation's settings. Its fields are the secondDocument rows below.	{ "Name": "modified.docx" }
secondDocument.Name	Required	File name including its extension. Type: string.
secondDocContent	Required	The changed document, base64-encoded. Type: string.	UEsDBBQABgAIAAAA...
comparisonOptions	Required	Send `{}` to use the defaults.	{ "ignoreFormatting": false, "author": "John Doe" }
comparisonOptions.ignoreFormatting	Optional	Ignore formatting changes. Type: boolean.
comparisonOptions.ignoreCaseChanges	Optional	Ignore changes in upper/lower case. Type: boolean.
comparisonOptions.ignoreComments	Optional	Ignore comments. Type: boolean.
comparisonOptions.ignoreTables	Optional	Ignore table changes. Type: boolean.
comparisonOptions.ignoreFields	Optional	Ignore field changes. Type: boolean.
comparisonOptions.ignoreFootnotes	Optional	Ignore footnotes. Type: boolean.
comparisonOptions.ignoreTextboxes	Optional	Ignore text boxes. Type: boolean.
comparisonOptions.ignoreHeadersAndFooters	Optional	Ignore headers and footers. Type: boolean.
comparisonOptions.author	Optional	Author name shown on the tracked changes. 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.

比較オプション

の API 追跡する変更内容をきめ細かく制御できます。

コンテンツオプション:

• 書式設定を無視する: テキストコンテンツに注目し、スタイルの変更は無視してください
• 大文字小文字の変更を無視する大文字小文字を区別しない比較
• コメントを無視するコメントの変更を比較対象から除外する
• 無視テーブルテーブル構造と内容の変更は除外する
• 無視フィールドフィールドの更新（自動更新コンテンツ）を除外する

ドキュメント要素のオプション:

• 脚注を無視する脚注の変更を除外する
• テキストボックスを無視するテキストボックスの変更を除外する
• ヘッダーとフッターを無視するヘッダー/フッターの変更を除外する

帰属表示:

• 著者比較文書の変更履歴に、作成者名を設定します。

出力

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

Success Response

同期処理（デフォルト）

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

ステータスコード: 200 OK

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

応答本文：

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

回答欄:

• 書類 (文字列): 変更履歴付きで全ての差異を示す Word 文書、エンコード形式: Base64 弦
• ファイル名 （文字列）：比較結果を含む出力Wordファイル名
• 成功 （ブール値）：リクエストが成功したかどうかを示します。
• エラーメッセージ （文字列またはnull）：成功がfalseの場合のエラーの詳細

使用方法：

1. 抽出する document からのフィールド JSON 応答 （Base64）
2. 解読する Base64 バイナリ形式のWord文書データを取得する文字列
3. 変更履歴を確認するには、Wordでドキュメントを開いてください。
4. 必要に応じて変更を承認または拒否する

例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes - document contains tracked changes

Asynchronous Processing

非同期処理

非同期動作 (202 Accepted ポーリングによる）は、リクエストボディパラメータではなく、サーバー構成によって制御されます。有効にすると、 API ポーリングで202ステータスを返す場合があります URL で Location ヘッダー。 URL と GET 200件のリクエストを受け取るまで OK 同じレスポンス形式（ドキュメント、ファイル名、成功、エラーメッセージ）を使用します。

Error Responses

エラー応答

の API 標準を返します HTTP エラーコードとエラー詳細：

400 不正なリクエスト

• 無効なリクエストパラメータ
• 必須項目が欠落しています（最初のドキュメント と 名前、 firstDocContent、 2番目の文書 と 名前、 secondDocContent）
• 最初のドキュメントは空またはnullです
• 2番目のドキュメントは空またはnullです
• 無効 Base64 ドキュメントコンテンツ内のエンコード
• 無効または破損したWord文書

401 Unauthorized

• 無効または欠落 API 鍵
• API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
• ない 認証: 基本 ヘッダー

500 Internal Server Error

• サーバー側処理エラー
• ワード文書の処理エラー
• 文書比較エラー

エラー応答フォーマット:

{
"error": "Error message describing what went wrong"
}

Response Format Details

回答形式の詳細

重要： の API 常に返される JSONバイナリ形式のワードデータを直接扱わないでください。

応答構造：

{
"document": "string", // Base64-encoded Word document with tracked changes
"fileName": "string", // Output Word filename with comparison results
"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('comparison.docx', 'wb') as f:
f.write(word_bytes)

C#:

byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("comparison.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

ペイロード

基本的な例（必須項目のみ）：

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

高度な例（比較オプション付き）：

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "comparisonOptions": {
 "ignoreFormatting": false,
 "ignoreCaseChanges": false,
 "ignoreComments": true,
 "ignoreTables": false,
 "ignoreFields": true,
 "ignoreFootnotes": false,
 "ignoreTextboxes": false,
 "ignoreHeadersAndFooters": false,
 "author": "Legal Review System"
 }
}

コンテンツのみの比較例：

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "comparisonOptions": {
 "ignoreFormatting": true,
 "ignoreCaseChanges": true,
 "ignoreComments": true,
 "ignoreFields": true,
 "author": "Content Review"
 }
}

コードサンプル

の PDF4me 文書を比較する REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C#

C# (CSharp) サンプル

完了 C# Word文書を比較するための実装：

View C# Sample

Java

Java サンプル

Java 完全なエラー処理と応答処理を備えた実装：

View Java Sample

JavaScript

JavaScript サンプル

Node.js ブラウザ互換 JavaScript 実装：

View JavaScript Sample

Python

Python サンプル

Python requestsライブラリを使用した実装と JSON 処理:

View Python Sample

Salesforce

Salesforce サンプル

Salesforce Apex 実装 CRM 統合：

View Salesforce Sample

n8n

n8n サンプル

n8n 自動化のためのワークフロー実装：

View n8n Sample

Google Script

Google Script サンプル

Google Apps Script 実装 Google Workspace 統合：

View Google Script Sample

AWS Lambda

AWS Lambda サンプル

サーバーレス AWS Lambda 関数実装:

View AWS Lambda Sample

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

Legal & Professional Services

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

• 契約審査契約書のバージョンを比較して、変更点や修正点を特定する。
• 法的文書の更新法的文書、契約書、裁判所文書の変更を追跡する
• コンプライアンス監視: 規制遵守を確認するために、ポリシー文書を比較する
• クライアント文書レビュー顧客向け法律文書の変更履歴を追跡する

Business & Enterprise

ビジネスおよび企業向けユースケース

• 提案管理提案書のバージョンを比較して、クライアントの要件を追跡する
• マーケティング資料の更新マーケティング資料やキャンペーンの変更点を追跡する
• 価格設定文書の変更価格表と料金表を比較する
• 顧客向けプレゼンテーションの最新情報: クライアント向けプレゼンテーション資料の変更点を追跡する

Education & Research

教育・研究における活用事例

• 医療プロトコルの最新情報医療手順書とプロトコル文書を比較する
• 患者ケアガイドライン患者ケア記録の変更を追跡する
• 研究資料研究プロトコルと研究文書を比較する
• コンプライアンス文書医療コンプライアンス資料の変更を追跡する

Finance & Banking

金融・銀行業務におけるユースケース

• 財務報告の更新四半期および年次の財務報告書を比較する
• 予算文書の変更点予算案および報告書の変更点を追跡する
• 監査文書異なる期間の監査報告書を比較する
• 規制当局への提出書類規制当局への提出書類の変更を追跡する

ヘルプが必要な場合

Get Your API KeyAPI SamplesGetting Started