文書分割 - 文書の分割 API
PDF4me ドキュメントを分割 柔軟な分割オプションと包括的な構成制御により、Word文書を複数の小さな文書に分割できます。 API このサービスは、Word ファイルを処理し、ページ、セクション、見出し、またはカスタムページ範囲で分割します。分割基準、ドキュメント名、出力構成を完全に制御できます。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全な送信のためのエンコード機能を搭載。ページ単位の分割、セクション単位の分割、見出し単位の分離、カスタムページ範囲の設定に対応しており、文書管理、コンテンツ配信、ワークフロー自動化に最適なソリューションです。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- 複数の分割タイプページ、セクション、見出し、またはカスタム範囲で分割
- ページ範囲のサポート特定のページ番号または範囲に基づいて分割する
- セクションベースの分割: Word セクションごとにドキュメントを分割します
- 見出しに基づく区分: 指定されたスタイルの見出しごとに文書を分割します(例:見出し1、見出し2)
- 柔軟な構成: splitConfig パラメータを使用したカスタム分割基準
- 固有のドキュメント名分割された各ドキュメントには、一意のGUIDファイル名が割り当てられます。
- フォーマットの保持: 元の文書の書式と構造を維持します
- 文化支援: 地域固有の文書処理
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのドキュメント分割操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
office/ApiV2Word/SplitDocument
REST API パラメータ
ドキュメント分割のパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク(*)が付いているパラメータは必須です。
splitConfigパラメータは、splitTypeは「array」、「numberofpages」、または「headings」です。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| 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. | |
| splitType | Optional | How to split. Not case-sensitive; spaces are ignored. `AllPages`: one part per page. `NumberOfPages`: parts of `splitConfig` pages each. `Array`: one part per page or range listed in `splitConfig` (e.g. `"1,2-6"`). `Section`: one part per section. `Headings`: a new part at each heading. Type: string. | "allpages" |
| splitConfig | Optional | Settings for the split type. Type: string. | "1-3,4,5-7"` or `"3"` or `"Heading 1" |
分割タイプオプション
の API 文書分割のためのさまざまな分割タイプを提供します。
| 分割タイプ | 説明 | splitConfigが必要です | 使用事例 |
|---|---|---|---|
| allpages | 個別のページに分割する(デフォルト) | いいえ | 各ページを個別のドキュメントとして抽出する |
| array | 明示的なページ範囲で分割されます。カンマで区切られた各範囲は1つのドキュメントになります(例:「1-3,4,5-7」→ 3つのドキュメント)。 | はい | 特定のページ範囲または単一ページからドキュメントを作成する |
| numberofpages | Nページごとに分割します。分割は順次行われ、Nページごとに1つのドキュメントが作成され、残りは最後のドキュメントになります。 | はい | 均等な大きさの塊に分割する(例:3ページごと、または5ページごと) |
| section | Word セクションごとにドキュメントを分割します | いいえ | セクションごとに1つの文書 |
| headings | 指定されたスタイルの見出し(例:「見出し1」)ごとに文書を分割します。 | はい | 見出しレベルで章または部分を抽出 |
分割構成例
分割設定を理解することで、文書分割ワークフローを最適化できます。
array:明示的なページ範囲
"1-3,4,5-7"→ 3つの文書:1~3ページ、4ページ、5~7ページ"1,3,5"→ 3つの文書:1ページ目、3ページ目、5ページ目"1-5,6-10"→ 2つの文書:1~5ページ、6~10ページ
numberofpages: Nページごとに分割
行動: Nページごとに順番に分割します。
設定: 必須、形式は単一の正の整数です(例: "3"、 "5")
例:
- 設定
"3"10ページの文書 → 4つの文書: 文書1:1~3ページ、文書2:4~6ページ、文書3:7~9ページ、文書4:10ページ - 設定
"5"12ページの文書 → 3つの文書: 文書1:1~5ページ、文書2:6~10ページ、文書3:11~12ページ
headings: 見出しごとに分割
"Heading 1"1つのブロックにつき1つの文書。ブロックは次の見出し1(または文書の末尾)で終了します。"Heading 2"1つのブロックにつき1つの文書。ブロックは次の見出し2(または文書の末尾)で終了します。- 大文字小文字を区別しないマッチング
section
設定は不要です。文書はWordのセクション区切りごとに分割され、各セクションが1つの文書になります。
出力
の PDF4me ドキュメントを分割 REST API 分割結果を返します JSON. API 応答には、標準の応答フィールドを持つ単一のドキュメント(最初の分割ドキュメント)が返されます。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
の API リクエストを処理し、最初の分割ドキュメントを返します。
ステータスコード: 200 OK
コンテンツタイプ: application/json
応答本文:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx",
"success": true,
"errorMessage": null
}
回答欄:
- 書類 (string): 最初の分割ドキュメントの内容は、次のようにエンコードされます。 Base64 弦
- ファイル名 (string): 分割されたドキュメントのファイル名を生成しました (GUID-ベース)
- 成功 (boolean): リクエストが成功したかどうかを示します
- エラーメッセージ (string または null): 成功が偽の場合のエラーの詳細
使用方法:
- 抽出する
documentからのフィールド JSON 応答 (Base64) - 解読する Base64 バイナリ形式のWord文書データを取得する文字列
- 使用する
fileName分割されたドキュメントを保存する
例(JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save with data.fileName or custom name
非同期処理
非同期動作 (202 Accepted ポーリングによる)は、リクエストボディパラメータではなく、サーバー構成によって制御されます。有効にすると、 API ポーリングで202ステータスを返す場合があります URL で Location ヘッダー。 URL と GET 200件のリクエストを受け取るまで OK 同じレスポンス形式(ドキュメント、ファイル名、成功、エラーメッセージ)を使用します。
エラー応答
の API 標準を返します HTTP エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています(
書類と名前、ドキュメントコンテンツ) - 無効な分割設定が指定されました
分割設定必要な場合分割タイプは「array」、「numberofpages」、または「headings」です。- 無効 Base64 エンコーディング
ドキュメントコンテンツ - 無効または破損したWord文書
- 文書内に見出しが見つかりませんでした(見出しに基づく分割の場合)
- 指定されたページ範囲が無効です(ページ番号が文書のページ数を超えています)。
- 無効な分割タイプ
- 無効または欠落 API 鍵
- API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
- ない
認証: 基本ヘッダー
- サーバー側処理エラー
- ワード文書の処理エラー
- ドキュメント分割エラー
- バイト列からのドキュメントの読み込みエラー
- ドキュメントをバイトに変換する際にエラーが発生しました。
エラー応答フォーマット:
{
"error": "Error message describing what went wrong"
}
回答形式の詳細
重要: の API 常に返される JSON 文書の配列を使用し、バイナリ形式のWordデータを直接使用してはいけません。
応答構造:
{
"document": "string", // Base64-encoded Word document content (first split)
"fileName": "string", // GUID-based filename (e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx")
"success": true,
"errorMessage": "string or null"
}
コンテンツタイプヘッダー:
- 成功:
application/json - 分割されたドキュメントは、 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
// Save with response.fileName or custom name
Python:
import base64
response_data = response.json()
word_bytes = base64.b64decode(response_data['document'])
filename = response_data['fileName']
with open(filename, '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",
"splitType": "allpages"
}
ページ範囲の例(配列):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "array",
"splitConfig": "1-3,4,5-7"
}
Nページごとに分割する例(ページ数):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "numberofpages",
"splitConfig": "3"
}
見出しベースの例(各見出しの後に分割):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "headings",
"splitConfig": "Heading 1",
"cultureName": "en-US"
}
セクションごとの例(各セクションごとに分割):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "section",
"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
法律・専門サービスにおけるユースケース
- 契約管理複数当事者間の契約を個別のセクションに分割する
- 事例記録事件ファイルから特定のページを抽出する
- コンプライアンスレポート関連するセクションを各部署に配布する
- 法律調査: 大規模な法律文書をトピックまたはセクションごとに分割する
ビジネスおよび企業向けユースケース
- レポート配信: さまざまな関係者向けにセクションごとにレポートを分割する
- 提案管理: 顧客固有の成果物用にセクションを抽出します
- 内部文書マニュアルをトピック別または部門別に分ける
- アーカイブ組織: 保存および取得のために論理的なドキュメントチャンクを作成する
教育・研究における活用事例
- カリキュラム教材教科書を章ごとに分割する
- 学生記録: 異なる学部ごとに特定のページを抽出する
- 研究論文: 査読のために大きな論文をセクションごとに分割する
- 医療および研究文書研究文書または臨床文書を方法論またはセクションごとに分割する
金融・銀行業務におけるユースケース
- 財務報告書特定のセクションをさまざまな関係者に配布する
- 監査文書: さまざまな監査領域に関連するページを抽出します
- 規制遵守: 規制の種類ごとにコンプライアンス文書を分割する
- リスクアセスメントリスクに関するセクションを適切なチームに配布する