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

追加 HTML ヘッダー フッター PDF - ブランディング API

PDF4me 追加 HTML ヘッダー フッター PDF 追加できるようになります HTML ヘッダー、フッター、またはその両方としてコンテンツを表示 PDF 文書。 API サービスプロセス PDF ファイルを追加 HTML ドキュメントのブランディングと整理のために、正確な位置指定、カスタムマージン、ページターゲティングオプションを備えたコンテンツ。 API 受け取る PDF コンテンツと HTML データを通じて REST API 通話を利用して Base64 安全なエンコード PDF 送信。 HTML コンテンツ、柔軟な配置、カスタムマージン、ページターゲティング、最初のページ除外など、このソリューションはドキュメントブランディング、レポート生成、エンタープライズに最適です。 PDF ワークフロー。

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

認証 API リクエスト​

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

Get your api Key

主な機能​

  • HTML コンテンツサポート: リッチを追加 HTML ヘッダーとフッターとしてコンテンツを配置し、スタイル設定を完全にサポート
  • 柔軟な位置決めヘッダーとフッターの配置を、正確なマージン制御でコントロールします。
  • カスタムスタイリング： 満杯 HTML そして CSS プロフェッショナルな外見をサポートする
  • ページターゲティング特定のページまたは文書全体にヘッダーとフッターを適用する
  • 最初のページをスキップする最初のページからヘッダーとフッターを除外するオプション
  • プロフェッショナルな成果文書の構成とブランディングを強化するヘッダーとフッターを作成する
  • シームレス API 統合: REST API 自動化向けに設計されています PDF 編集ワークフローとエンタープライズシステム統合

REST API 終点​

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

  • 方法： POST
  • 終点： /api/v2/AddHtmlHeaderFooter

ヘッダーとフッターの機能​

HTML コンテンツサポート​

  • HTML コンテンツ: サポート HTML インラインコンテンツ CSS スタイリング
  • カスタムスタイリング: インラインを使用する CSS フォント、色、配置、および基本的なスタイル設定について
  • テキストと画像: サポート HTML テキストコンテンツと埋め込み画像
  • 無地 HTML 弦: HTML コンテンツはプレーンな文字列として提供する必要があります（ Base64 エンコード済み）

配置とレイアウト​

  • マージンコントロール: ピクセル単位の測定値（marginLeft、marginRight、marginTop、marginBottom）による正確な位置決め
  • ページターゲティングページオプションを使用して特定のページに適用します（すべてのページの場合は空の文字列、「1」、「1,3,5」、「2-5」、「1,3,7-10」、「2-」）
  • 最初のページをスキップする最初のページからヘッダーとフッターを除外するオプション
  • 場所の選択肢ヘッダー、フッター、またはその両方にコンテンツを追加する

高度な機能​

  • 非同期処理: 長時間実行される操作のためのポーリングによる非同期処理のサポート
  • プロフェッショナルな外見文書全体で一貫した書式設定とスタイル
  • 柔軟な位置決め: 正確なピクセル単位でヘッダーとフッターの位置を制御します

REST API パラメータ​

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

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

パラメータ必須その機能例
jobIdExtOptionalYour own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string.
integrationsOptionalIntegration identifiers, forwarded unchanged with the job's notification settings. Type: array.
isAsyncOptionalSet to `true` to process the action asynchronously and get a job to poll at `/api/v2/GetActionStatus`. Only honoured by actions that support asynchronous processing. Type: boolean.true
docNameOptionalSource file name including its extension. Several actions dispatch on the extension, so it should always be set; when omitted a per-action default is used. Type: string.output.pdf
docContentRequiredThe source file. Accepts the base64-encoded file content, a `pdf4meblobid://<id>` reference to a previously uploaded blob, or an `https` URL to the source document. Required: an empty value fails with `File is empty`. Type: string.JVBERi...
docContentBytesOptionalAlternative raw byte payload for the source file. Type: string.
callBackUrlOptionalOptional URL notified when an asynchronous job completes. Type: string.
HTMLContentOptionalRequired. HTML markup (plain text, not base64) to render as the header or footer. Type: string.<div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div>
locationOptionalAn unrecognised value is rejected with 400. Type: string.Header
skipFirstPageOptionalDo not add the header or footer to the first page. Type: boolean.false
marginLeftOptionalLeft margin of the header or footer area. Type: number.20.0
marginRightOptionalRight margin of the header or footer area. Type: number.20.0
marginBottomOptionalBottom margin of the header or footer area. Type: number.50.0
marginTopOptionalTop margin of the header or footer area. Type: number.50.0
pagesOptionalPages to add the header or footer to, e.g. `1`, `1,3,5`, `2-5` or `2-` (2 to the last page). Type: string.""` or `"1-3"

重要な注意事項： の htmlContent パラメータは 無地 HTML 弦、 ない Base64 エンコードされています。インラインで含めることができます CSS スタイリング内 HTML。

出力​

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

同期処理（デフォルト）

いつ async 設定されていないか、 false、 API リクエストを即座に処理します。

ステータスコード: 200 OK

Content-Type: application/json

応答本文：

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}

回答欄:

  • ドキュメント名 （文字列）：出力 PDF ファイル名
  • ドキュメントコンテンツ (文字列): PDF ファイル HTML ヘッダー/フッターが適用され、エンコードされます Base64 弦

使用方法：

  1. 抽出する docContent からのフィールド JSON 応答
  2. 解読する Base64 バイナリを取得する文字列 PDF データ
  3. 保存または処理 PDF 必要に応じてファイルする

例 （JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes

リクエスト例​

ヘッダ​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

注記：

  • 手に入れよう API 鍵から PDF4me ダッシュボード
  • の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
  • 例: API 重要なのは abc123エンコードして Base64 そして使用する Authorization: Basic YWJjMTIz

ペイロード​

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

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header"
}

高度な例（すべてのオプションフィールドを含む）：

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
  "location": "Header",
  "pages": "",
  "skipFirstPage": false,
  "marginLeft": 20.0,
  "marginRight": 20.0,
  "marginTop": 50.0,
  "marginBottom": 50.0,
  "async": true
}

重要： の htmlContent フィールドには以下が含まれている必要があります 無地 HTML 文字列として、 ない Base64 エンコードされています。インラインを使用できます CSS スタイリング内 HTML タグ。

コードサンプル​

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

C# (CSharp) サンプル

完了 C# ヘッダーとフッターを追加する実装 PDF:

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

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

  • 法的文書法的文書に法的免責事項と機密保持通知を適用する
  • 契約ヘッダー契約書や合意書にヘッダーとフッターを追加する
  • コンプライアンス文書: ヘッダーとフッターにコンプライアンスに関する通知を含める
  • クライアントドキュメントクライアント文書にプロフェッショナルなヘッダーとフッターを追加する

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started