gPdf render/edge
Use cases · PDF生成API

PDF生成API：業務システム向けの動的PDF生成

PDF生成ツールを探している開発者へ。gPdfはJSONから面ラベル、請求書、レポート、保管文書を自動・一括生成するためのPDF Generation APIです。

Job to be done

注文、請求、レポート、証明書、配送ラベルなどの業務データを、アプリケーションのバックエンドから自動でPDFに変換する。手作業のアップロードや運用担当者による個別エクスポートではなく、JSONリクエストから安定したPDFを継続的に生成する。

Why gPdf for this

  • JSONからPDF生成: 1つのDocumentRequestでページ、テキスト、画像、表、バーコード、メタデータを定義。
  • API中心の運用: バックエンド、ジョブキュー、WMS、SaaSからPOST /api/v1/pdf/renderを直接呼び出し。
  • 一括生成に対応: PuppeteerやPlaywrightのブラウザクラスタを保守せず、大量PDFを生成。
  • 多言語フォント内蔵: Latin、CJK、Arabic、Devanagari、Bengali、Thai、Cyrillicをカバー。
  • 物流・帳票向け: 固定サイズラベル、ベクターバーコード、PDFメタデータ、PDF/A、電子請求書設定に対応。
  • 同じJSONをAPIとhttps://studio.gpdf.comのVisual Editorで利用可能。

Sample request

POST /api/v1/pdf/render：JSONから最小構成の動的PDFを生成する例。

{
  "pages": [
    {
      "size": "a4",
      "elements": [
        {
          "type": "text",
          "x": 24,
          "y": 28,
          "content": "Order #A-10042",
          "style": {
            "font_size": 18,
            "font_family": "NotoSans-Regular"
          }
        },
        {
          "type": "text",
          "x": 24,
          "y": 44,
          "content": "Generated automatically from application data.",
          "style": {
            "font_size": 10,
            "font_family": "NotoSans-Regular"
          }
        },
        {
          "type": "barcode",
          "format": "code128",
          "content": "A-10042",
          "x": 24,
          "y": 70,
          "width": 80,
          "height": 18
        }
      ]
    }
  ]
}

Compliance and conformance

  • 長期保管や監査証跡が必要なPDFには、同じリクエスト内でPDF/Aプロファイルを指定できます。
  • タイトル、作成者、件名、言語などのPDFメタデータを明示できるため、検索・保管システムと連携しやすくなります。
  • レイアウト確認や非エンジニアとの共同作業には、同じJSONモデルをhttps://studio.gpdf.comで編集できます。

1回だけPDFを作りたい場合

WordをPDFに変換する、画像をまとめる、1ページだけPDFとして保存する。そうした作業なら、一般的なオンラインPDF生成ツールで十分です。人がファイルをアップロードし、ボタンを押し、結果をダウンロードするための道具だからです。

gPdfが対象にするのは別の仕事です。業務システムが、自分でPDFを生成し続けるための仕組みです。

「PDF生成ツール」の検索が、実際にはAPI要件になるとき

「PDF生成」「PDF generator」「動的PDF生成」と検索していても、開発フェーズに入ると要件は具体的になります。

  1. 注文作成時に配送ラベルを自動発行したい。
  2. SaaSで顧客別の月次レポートを作りたい。
  3. 請求書に安定したメタデータや保管設定を持たせたい。
  4. 倉庫の出荷ピーク前に数万枚のラベルを生成したい。
  5. サポートや運用画面からブランド付きの証明書や控えを出力したい。

この段階で重要なのは「どのボタンでPDFを作るか」ではありません。バックエンドがデータから正しいPDFを、繰り返し、速く、予測可能なコストで生成できるかです。

gPdfの方式：JSONを送ってPDFを受け取る

gPdfは構造化されたJSONドキュメントモデルを使います。アプリケーションは以下をリクエストで指定します。

  • ページサイズと座標レイアウト
  • テキスト、フォント、画像、表
  • ベクターバーコードと固定サイズラベル
  • PDFメタデータ
  • 必要に応じたPDF/A、電子請求書、保管設定

APIはPDFを返します。ブラウザサーバーのウォームアップ、Chromiumのバージョン固定、HTML/CSSレンダリングエンジンを生成処理のホットパスに置く運用は不要です。

一括PDF生成で効くポイント

個人向けPDF生成ツールは便利ですが、1日中ドキュメントを作り続けるシステムのためには設計されていません。

一括生成で大事なのは次の性質です。

  • 再発行や監査で同じ出力を再現できること
  • キューが急増してもp99レイテンシが読めること
  • ページ単価を見積もりやすいこと
  • フォントやバーコードの見た目が環境差で揺れないこと
  • JSONリクエストをバージョン管理し、テストできること

gPdfはこの負荷を前提にしたPDF Generation APIです。

次に試すこと

まずはPlaygroundでJSONモデルを試せます。実装に進む場合はJSON Render APIリファレンスから同じリクエストをバックエンドに組み込んでください。

物流やECの帳票から始めるなら、物流・ECのPDF生成にgPdfが合うケースも参考になります。

FAQ

gPdfは一般的なオンラインPDF生成ツールですか？
いいえ。ファイルをアップロードして変換する個人向けツールではなく、プロダクトや業務システム内でPDFを自動生成するための開発者向けAPIです。
JSONから動的にPDFを生成できますか？
できます。DocumentRequestでページ、テキスト、画像、表、バーコード、メタデータ、文書設定を指定し、APIからPDFを受け取ります。
ヘッドレスブラウザではなくgPdfを選ぶのはどんな場合ですか？
配送ラベル、請求書、定型レポートなど、構造が決まっていて大量に繰り返し生成するPDFでは、ブラウザクラスタの運用よりgPdfの構造化APIが扱いやすくなります。
開発者以外もレイアウトを調整できますか？
できます。https://studio.gpdf.comでは同じJSONをVisual Editorで編集でき、開発者はそのままAPIワークフローに戻せます。

Keep reading