メインコンテンツへスキップ
PDF4me API統合AIとSDK知識ベース拡張機能APIテスターブログ

ヘッダーとフッターの更新 - ヘッダー管理 API

PDF4me ヘッダーとフッターを更新する Word文書のヘッダーとフッターを包括的に追加または変更できます HTML コンテンツサポートとプロフェッショナルなスタイリングオプション。 API このサービスはWordファイルを処理し、最初のページ、偶数/奇数ページ、およびすべてのページを含むさまざまなページレイアウトにヘッダーとフッターを適用し、プロフェッショナルなデフォルトスタイルを自動的に適用します。 HTML コンテンツ処理、および柔軟なページ固有のフォーマット。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全な送信のためのエンコード。ページ番号フィールドのサポート付き（PAGE、 NUMPAGES、 SECTION、 SECTIONPAGES) HTML 書式設定や自動的なプロフェッショナルなスタイル設定機能を備えたこのソリューションは、文書のブランディング、ページ番号付け、プロフェッショナルな文書プレゼンテーションのワークフローに最適です。

関連ブログ記事
この機能に関するブログ記事はまだありません。近日公開予定です。
その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。
ブログをご覧ください →

認証 API リクエスト​

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

Get your api Key

主な機能​

  • 複数のページタイプ: 全ページ、最初のページ、偶数ページ/奇数ページに対応
  • HTML コンテンツサポート： リッチ HTML プロのスタイリングによるコンテンツ
  • 自動スタイリング: プレーンテキストコンテンツ用のプロフェッショナルなデフォルトスタイル
  • ページ番号フィールド: サポート PAGE、 NUMPAGES、 SECTION、 SECTIONPAGES
  • 柔軟なレイアウトページの種類ごとに異なるヘッダー/フッター
  • 文化支援: 地域固有の文書処理
  • フォーマットの保持: 元の文書構造を維持する
  • プロフェッショナルな外見: プロのスタイリングを自動適用

REST API 終点​

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

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

REST API パラメータ​

ヘッダーとフッターの更新に関するパラメータの完全なリスト REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク（*）が付いているパラメータは必須です。詳細設定パラメータを使用すると、ページ固有のヘッダーとフッターをきめ細かく制御できます。

パラメータ必須その機能例
documentRequiredSource file. `Name` must end in `.docx` or `.doc`.{ "Name": "document.docx" }
document.NameRequiredFile name including its extension. Type: string.{ "Name": "document.docx" }
docContentRequiredThe source file, base64-encoded. Type: string.base64EncodedDocumentContent
isAsyncOptionalProcess the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean.
allPagesHeaderHtmlOptionalFor all pages. Type: string."<div style='text-align: center;'>Company Name</div>"
allPagesFooterHtmlOptionalFor all pages. Type: string."Page PAGE of NUMPAGES"
firstPageHeaderHtmlOptionalA different one for the first page. Type: string."<div style='text-align: center;'>Title Page</div>"
firstPageFooterHtmlOptionalA different one for the first page. Type: string."<div style='text-align: center;'>Confidential</div>"
oddPagesHeaderHtmlOptionalA different one for odd pages. Type: string."<div style='text-align: left;'>Chapter Title</div>"
oddPagesFooterHtmlOptionalA different one for odd pages. Type: string."<div style='text-align: center;'>Page PAGE</div>"
evenPagesHeaderHtmlOptionalA different one for even pages. Type: string."<div style='text-align: right;'>Book Title</div>"
evenPagesFooterHtmlOptionalA different one for even pages. Type: string."<div style='text-align: center;'>Page PAGE</div>"

HTML コンテンツサポート​

の API サポート HTML ヘッダーとフッターのすべてのパラメータに含まれるコンテンツ:

  • HTML タグ： 標準 HTML タグ（div、span、p、b、i、uなど）
  • CSSスタイリング: 書式設定のためのインラインCSSスタイル
  • プレーンテキストプレーンテキストには自動的にプロフェッショナルなデフォルトスタイルが適用されます
  • 混合コンテンツ： 組み合わせる HTML 必要に応じてプレーンテキストも

プレーンテキストのデフォルトスタイル設定：

  • ヘッダー: 左揃え、下枠、フォントサイズ10px
  • フッター: 中央揃え、上枠、9pxフォント

ページレイアウトオプション​

の API ヘッダーとフッターに異なるページレイアウトをサポートしています。

レイアウトタイプ説明必須パラメータ
全ページすべてのページで同じヘッダー/フッターallPagesHeaderHtml、 allPagesFooterHtml （または入力された） allPagesHeader、 allPagesFooter）
最初のページ最初のページのヘッダー/フッターが異なるfirstPageHeaderHtml、 firstPageFooterHtml （または同等の表現）
偶数ページ／奇数ページ偶数ページと奇数ページで異なるヘッダー/フッターevenPagesHeaderHtml、 oddPagesHeaderHtml、 evenPagesFooterHtml、 oddPagesFooterHtml （または同等の表現）

出力​

の PDF4me ヘッダーとフッターを更新する REST API を返します JSON 応答。成功した場合 API Word文書をとして返します Base64エンコードされた文字列 で document 分野 （ApiV2WordApiCallResバイナリデータとしてではなく、

成功時の対応

ステータスコード: 200 OK

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

応答本文：

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

回答欄:

  • 書類 （string): ヘッダーとフッターが更新された Word 文書、エンコード形式は Base64
  • ファイル名 （string出力Wordファイル名
  • 成功 （boolean手術が成功したかどうか
  • エラーメッセージ （string): 成功が偽の場合はエラーメッセージ。それ以外の場合は null

使用方法：

  1. チェック success; 真であれば、抽出します document からのフィールド JSON 応答
  2. 解読する Base64 バイナリ形式のWord文書データを取得する文字列
  3. Word ファイルを保存または処理するには、 fileName

例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const base64 = data.document;
const binary = atob(base64);
const blob = new Blob([binary], { type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = data.fileName;
a.click();

リクエスト例​

ヘッダ​

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",
 "allPagesHeaderHtml": "<div style='text-align: center;'>Company Name</div>",
 "allPagesFooterHtml": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

高度な例（最初のページ＋偶数ページ／奇数ページ）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "firstPageHeaderHtml": "<div style='text-align: center;'>Title Page</div>",
 "firstPageFooterHtml": "<div style='text-align: center;'>Confidential</div>",
 "oddPagesHeaderHtml": "<div style='text-align: left;'>Chapter Title</div>",
 "evenPagesHeaderHtml": "<div style='text-align: right;'>Book Title</div>",
 "oddPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "evenPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
 "cultureName": "en-US"
}

HTMLコンテンツの例：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center; color: #333; font-size: 12px; border-bottom: 1px solid #ccc; padding-bottom: 5px;'>Company Name | Department</div>",
 "allPagesFooterHtml": "<div style='text-align: center; color: #666; font-size: 9px; border-top: 1px solid #ccc; padding-top: 5px;'>Page PAGE of NUMPAGES | © 2024 Company Name</div>",
 "cultureName": "en-US"
}

プレーンテキストの例（ヘッダーコンテンツ/フッターコンテンツ）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "headerContent": "Company Name",
 "footerContent": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

コードサンプル​

の PDF4me ヘッダーとフッターを更新する REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C# （CSharpサンプル

完了 C# Word文書のヘッダーとフッターを更新するための実装例：

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

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

  • 契約ヘッダー機密保持に関する通知と法的免責事項を追加する
  • 裁判所文書事件番号と提出情報を含める
  • 法律概要弁護士情報と事件の詳細を追加する
  • コンプライアンスレポート規制情報と日付を含める

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started