ドキュメントの最適化 - ドキュメントの最適化 API
PDF4me ドキュメントの最適化 3つの異なる圧縮レベルと包括的な最適化技術により、Word文書のサイズとパフォーマンスを最適化できます。 API このサービスは、Word ファイルを処理し、ファイルサイズを縮小し、画像を圧縮し、コンテンツをクリーンアップし、書式を正規化し、個人情報を削除します。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能を搭載。低、中、高の最適化レベルに対応し、ファイルサイズを0~90%削減できるため、文書作成、ストレージ最適化、パフォーマンス向上といったワークフローに最適です。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- 最大最適化ファイルサイズを最大に削減するための最大圧縮プロファイル
- ファイルサイズ削減最大最適化によりファイルサイズを80~90%削減
- 画像圧縮: 画質を維持しながらインテリジェントな画像最適化を実現
- コンテンツのクリーンアップ: 未使用のマクロ、コメント、および非表示コンテンツを削除します
- 書式設定の正規化: 重複した書式設定と未使用のスタイルを整理します
- 個人情報の削除著者、管理者、および会社情報を削除します。
- フォントの最適化フォントを正規化し、不要なフォントプロパティを削除します。
- 互換性の向上Word 2016との互換性を考慮してドキュメントを最適化する
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするための方法。すべてのドキュメント最適化操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
office/ApiV2Word/OptimizeDocument
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. | UEsDBBQABgAIAAAA... |
| isAsync | Optional | Process the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean. | |
| optimizationLevel | Optional | Not case-sensitive. Type: string. | "Max" |
最適化プロファイル
の マックス 最適化プロファイルは最大の圧縮率を提供します。
- ファイルサイズ削減: 80~90%
- 画質サイズを最適化
- 書式設定: 徹底的な清掃
- コメント: 削除済み
- 改訂: 削除済み
- 個人情報: 削除済み
- マクロ: 削除済み
- 未使用のスタイル: 削除済み
- 非公開コンテンツ: 削除済み
出力
の PDF4me ドキュメントの最適化 REST API 処理モードに基づいて異なる応答を返します。 API Word文書をとして返します Base64-エンコードされた文字列 JSON フォーマットバイナリデータとしてではなく。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
の API リクエストを処理し、以下を返します。
ステータスコード: 200 OK
コンテンツタイプ: application/json
応答本文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "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 エンコーディング
ドキュメントコンテンツ - 無効または破損したWord文書
- 無効な最適化レベル
- 無効または欠落 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
ペイロード
基本例(デフォルトの最大最適化):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max"
}
高度な例(オプションフィールド付き):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max",
"wordVersion": 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
法律・専門サービスにおけるユースケース
- 文書配布: 顧客への配布用に法的文書を最適化する
- 公開書類裁判所への提出書類を準備する
- アーカイブストレージ法的文書を長期保存用に最適化する
- コンプライアンス文書規制当局への提出書類を整理する
ビジネスおよび企業向けユースケース
- 提案書の配布顧客への納品に向けた提案を最適化する
- マーケティング資料の共有: 公開配布用のマーケティング資料を最適化する
- プレゼンテーションの最適化メール配信用にプレゼンテーションを最適化する
- クライアント向け成果物の準備: 顧客への納品用に文書を整理する
教育・研究における活用事例
- 患者レポート配信医療レポートを最適化して安全に共有できるようにする
- 研究資料研究論文を出版用に最適化する
- プロトコル共有部門別配布のための医療プロトコルの最適化
- コンプライアンス文書規制当局への提出書類を整理する
金融・銀行業務におけるユースケース
- 財務報告書の配布利害関係者への配布に適した財務報告書の最適化
- 監査文書外部共有用に監査文書を整理する
- 予算文書の共有部門別配布のための予算文書を最適化する
- 規制当局への届出規制当局への提出書類を作成する