メインコンテンツへスキップ

ページ番号を追加 PDF - ページネーション API

PDF4me ページ番号を追加 PDF カスタマイズ可能なページ番号を追加できます PDF 位置、書式、スタイルを制御できるドキュメント。 API サービスプロセス PDF ファイルとページ番号をフォーマットプレースホルダーを使用して追加します。 # 現在のページ番号を表し、 {1} は総ページ数を表します。 API 受け取る PDF コンテンツを通じて REST API 通話を利用して Base64 安全な送信のためのエンコード。このソリューションは、文書整理、法的文書、学術論文、企業向け文書に最適です。 PDF ワークフロー。

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

認証 API リクエスト​

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

主な機能​

  • 柔軟なフォーマット: 複数のページ番号形式から選択してください # 現在のページと {1} 総ページ数 (例: "# 1", "ページ番号")
  • 精密な位置決め水平方向と垂直方向の配置をピクセル単位で正確に制御します。
  • カスタムスタイリングフォントサイズ、太字、斜体、その他のテキスト書式設定オプションを調整します。
  • マージンコントロール最適な配置のために、ミリメートル単位で正確な余白を設定してください。
  • 最初のページをスキップする最初のページからページ番号を除外するオプション
  • プロフェッショナルな成果文書全体で一貫性のあるプロフェッショナルなページ番号を作成する

REST API 終点​

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

  • 方法: 役職
  • 終点: /api/v2/AddPageNumber

REST API パラメータ​

ページ番号を追加するパラメーターの完全なリスト 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.
alignXOptionalAn unrecognised value is rejected with 400. Type: string.right
alignYOptionalAn unrecognised value is rejected with 400. Type: string.bottom
fontSizeOptionalRequired. Font size of the page numbers, greater than 0; 0 or less is rejected with 400 (`Invalid FontSize`). Type: integer.12
isBoldOptionalMake the page numbers bold. Type: boolean.true
isItalicOptionalMake the page numbers italic. Type: boolean.false
pageNumberFormatOptionalText of the page number, where `#` is the current page and `{1}` the total number of pages, e.g. `Page # of {1}`. Type: string.# of {1}
skipFirstPageOptionalDo not number the first page. Type: boolean.false
marginXinMMOptionalHorizontal distance in millimetres from the edge chosen by `alignX`. Negative values count as 0. Type: integer.2
marginYinMMOptionalVertical distance in millimetres from the edge chosen by `alignY`. Negative values count as 0. Type: integer.2

ページ番号の書式設定プレースホルダー​

の pageNumberFormat パラメータには以下のプレースホルダーが使用されます。

  • # - 現在のページ番号(1、2、3など)に置き換えられます。
  • {1} - 総ページ数に置き換えました

フォーマット例:

  • "# of {1}" → 「1/10」、「2/10」、「3/10」などと表示されます。
  • "Page #" → 「ページ 1」、「ページ 2」、「ページ 3」などを表示します。
  • "# / {1}" → 「1 / 10」、「2 / 10」、「3 / 10」などを表示します。
  • "- # -" → "- 1 -", "- 2 -", "- 3 -", などを表示します。
  • "[#/{1}]" → "[1/10]", "[2/10]", "[3/10]", などと表示されます。
  • "(#)" → "(1)", "(2)", "(3)"などを表示します。
  • "#" → ページ番号のみを表示します:「1」、「2」、「3」など。

出力​

の PDF4me ページ番号を追加 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 ページ番号が追加されたファイル、エンコードされた 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==",
"pageNumberFormat": "# of {1}",
"alignX": "right",
"alignY": "bottom"
}

高度な例(すべてのオプションフィールドを含む):

{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"pageNumberFormat": "# of {1}",
"alignX": "right",
"alignY": "bottom",
"marginXinMM": 2,
"marginYinMM": 2,
"fontSize": 12,
"isBold": true,
"isItalic": false,
"skipFirstPage": false,
"async": true
}

コードサンプル​

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

C# (CSharp) サンプル

完了 C# ページ番号を追加する実装 PDF:

ページ番号の機能​

書式設定オプション​

  • 複数のフォーマット: さまざまな番号付けスタイルとパターンに対応
  • 柔軟な位置決めページ番号の配置を正確に制御
  • カスタムスタイリングフォントの外観と書式設定を完全に制御できます。
  • 最初のページコントロール表紙ページを番号付けから除外するオプション

文書の強化​

  • プロフェッショナルなレイアウト文書全体で一貫性のあるプロフェッショナルなページ番号を作成する
  • 印刷最適化印刷要件に応じてページ数を最適化します。
  • デジタル配信: さまざまな表示デバイス間でフォーマットを維持する
  • ブランドの一貫性組織全体で統一されたページ番号付け基準を適用する。

高度な機能​

  • バッチ処理: 複数の文書を一貫したページ番号で処理する
  • 品質保証ページ番号の整合性と適切な PDF 互換性
  • レイアウトの維持ページ番号を追加しながら文書構造を維持する
  • カスタムマージンページ番号の位置を正確に制御

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

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

  • 法的文書契約書、合意書、および法的文書にページ番号を付ける
  • 裁判所文書裁判所提出書類や法律文書にページ番号を追加する
  • コンプライアンス文書コンプライアンスおよび規制文書のページ番号
  • クライアントドキュメント: 顧客文書をページ番号付きで整理する

ヘルプが必要な場合​