ページ番号を追加 PDF - ページネーション API
PDF4me ページ番号を追加 PDF カスタマイズ可能なページ番号を追加できます PDF 位置、書式、スタイルを制御できるドキュメント。 API サービスプロセス PDF ファイルとページ番号をフォーマットプレースホルダーを使用して追加します。 # 現在のページ番号を表し、 {1} は総ページ数を表します。 API 受け取る PDF コンテンツを通じて REST API 通話を利用して Base64 安全な送信のためのエンコード。このソリューションは、文書整理、法的文書、学術論文、企業向け文書に最適です。 PDF ワークフロー。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- 柔軟なフォーマット: 複数のページ番号形式から選択してください
#現在のページと{1}総ページ数 (例: "# 1", "ページ番号") - 精密な位置決め水平方向と垂直方向の配置をピクセル単位で正確に制御します。
- カスタムスタイリングフォントサイズ、太字、斜体、その他のテキスト書式設定オプションを調整します。
- マージンコントロール最適な配置のために、ミリメートル単位で正確な余白を設定してください。
- 最初のページをスキップする最初のページからページ番号を除外するオプション
- プロフェッショナルな成果文書全体で一貫性のあるプロフェッショナルなページ番号を作成する
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのページ番号追加操作は、単一のエンドポイントを介して実行されます。
- 方法: 役職
- 終点:
/api/v2/AddPageNumber
REST API パラメータ
ページ番号を追加するパラメーターの完全なリスト PDF REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| jobIdExt | Optional | Your own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string. | |
| integrations | Optional | Integration identifiers, forwarded unchanged with the job's notification settings. Type: array. | |
| isAsync | Optional | Set 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 |
| docName | Optional | Source 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 |
| docContent | Required | The 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... |
| docContentBytes | Optional | Alternative raw byte payload for the source file. Type: string. | |
| callBackUrl | Optional | Optional URL notified when an asynchronous job completes. Type: string. | |
| alignX | Optional | An unrecognised value is rejected with 400. Type: string. | right |
| alignY | Optional | An unrecognised value is rejected with 400. Type: string. | bottom |
| fontSize | Optional | Required. Font size of the page numbers, greater than 0; 0 or less is rejected with 400 (`Invalid FontSize`). Type: integer. | 12 |
| isBold | Optional | Make the page numbers bold. Type: boolean. | true |
| isItalic | Optional | Make the page numbers italic. Type: boolean. | false |
| pageNumberFormat | Optional | Text 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} |
| skipFirstPage | Optional | Do not number the first page. Type: boolean. | false |
| marginXinMM | Optional | Horizontal distance in millimetres from the edge chosen by `alignX`. Negative values count as 0. Type: integer. | 2 |
| marginYinMM | Optional | Vertical 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 フォーマットバイナリデータとしてではなく。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
いつ async 設定されていないか、 false、 API リクエストを即座に処理します。
ステータスコード: 200 OK
Content-Type: application/json
応答本文:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
回答欄:
- ドキュメント名 (文字列):出力 PDF ファイル名
- ドキュメントコンテンツ (文字列): PDF ページ番号が追加されたファイル、エンコードされた Base64 弦
使用方法:
- 抽出する
docContentからのフィールド JSON 応答 - 解読する Base64 バイナリを取得する文字列 PDF データ
- 保存または処理 PDF 必要に応じてファイルする
例 (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
非同期処理
いつ async: true 設定されている、 API リクエストを非同期的に処理します。
ステータスコード: 202 Accepted
レスポンスヘッダー:
Location: https://api.pdf4me.com/api/v2/AddPageNumber/poll/12345-abcde-67890
投票プロセス:
- 抽出する
Location202レスポンスのヘッダー - 投票する URL 使用 GET リクエスト
- 受信するまで投票を続けてください 200 OK 状態
- 最終回答には同じ内容が含まれています JSON フォーマット
docNameそしてdocContent(Base64)
投票例:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const data = await pollResponse.json();
// Process data.docContent (Base64 PDF)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
エラー応答
の API 標準を返します HTTP エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています(
ドキュメントコンテンツ、ドキュメント名、ページ番号の形式、alignX、整列Y) - 無効 Base64 エンコーディング
ドキュメントコンテンツ - 無効な配置値です(alignX の場合は「left」、「center」、「right」、alignY の場合は「top」、「middle」、「bottom」のいずれかを指定する必要があります)。
- 無効なフォントサイズです(8~72ポイントの範囲である必要があります)
- 無効なマージン値です(0~100の整数である必要があります)
- 無効または欠落 API 鍵
- API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
- ない
認証: 基本ヘッダー
- サーバー側処理エラー
- PDF 処理エラー
- ページ番号の追加に失敗しました
エラー応答フォーマット:
{
"error": "Error message describing what went wrong"
}
回答形式の詳細
重要: の API 常に返される JSON決してバイナリではない PDF データを直接取得します。
応答構造:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type ヘッダー:
- 成功:
application/json - の PDF として埋め込まれています Base64 文字列内の JSON 応答
なぜ Base64?
- JSON-バイナリデータの安全なエンコード
- 簡単に伝達できます HTTP
- すべてのプログラミング言語に対応
- 直接埋め込むことができます JSON 問題から逃れることなく
デコード Base64 に PDF:
JavaScript/Node.js:
const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js
Python:
import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
f.write(pdf_bytes)
C#:
byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
ページ番号の機能
書式設定オプション
- 複数のフォーマット: さまざまな番号付けスタイルとパターンに対応
- 柔軟な位置決めページ番号の配置を正確に制御
- カスタムスタイリングフォントの外観と書式設定を完全に制御できます。
- 最初のページコントロール表紙ページを番号付けから除外するオプション
文書の強化
- プロフェッショナルなレイアウト文書全体で一貫性のあるプロフェッショナルなページ番号を作成する
- 印刷最適化印刷要件に応じてページ数を最適化します。
- デジタル配信: さまざまな表示デバイス間でフォーマットを維持する
- ブランドの一貫性組織全体で統一されたページ番号付け基準を適用する。
高度な機能
- バッチ処理: 複数の文書を一貫したページ番号で処理する
- 品質保証ページ番号の整合性と適切な PDF 互換性
- レイアウトの維持ページ番号を追加しながら文書構造を維持する
- カスタムマージンページ番号の位置を正確に制御
業界におけるユースケースとアプリケーション
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Government & Compliance
法律・専門サービスにおけるユースケース
- 法的文書契約書、合意書、および法的文書にページ番号を付ける
- 裁判所文書裁判所提出書類や法律文書にページ番号を追加する
- コンプライアンス文書コンプライアンスおよび規制文書のページ番号
- クライアントドキュメント: 顧客文書をページ番号付きで整理する
教育・研究における活用事例
- 学術論文研究論文や学位論文に適切なページ番号を付ける
- 研究資料研究論文や出版物にページ番号を追加する
- 論文の書式設定論文や学位論文のページ番号
- 教育資料教育資料をページ番号付きで整理する
ビジネスおよび企業向けユースケース
- ビジネスレポート: 一貫したページ番号でプロフェッショナルなレポートを作成する
- 文書構成レポート、マニュアル、技術文書にページ番号を追加する
- 技術マニュアル技術文書は、明確なページ参照を用いて整理する。
- 企業文書企業文書やマニュアルのページ番号を付ける
政府およびコンプライアンス関連のユースケース
- 公文書ページ番号を付けて長期保存用の文書を準備する
- 政府報告書政府の報告書や文書にページ番号を追加する
- 規制関連文書規制およびコンプライアンス文書のページ番号
- 公文書公文書をページ番号で整理する