バーコード・小売

文書・ラベル向け QR コード PDF API

JSON Render またはテンプレートを使って、領収書、チケット、ラベル、オンボーディング資料、文書照会ワークフロー向けに PDF 内へ QR コードをレンダリングします。

主 API JSON Render
ENDPOINT /api/v1/pdf/render
対象システム SaaS バックエンド / EC バックエンド / チケットバックエンド / 文書自動化サービス
解決する業務課題

PDF 文書、ラベル、領収書、チケット、フォームに QR コードを配置し、ユーザーが自社システムで管理するリンク、識別子、照会トークンをスキャンできるようにします。

この API が合う場合

  • 自社システムに、符号化する URL、トークン、注文 ID、チケット ID、照会値がある場合。
  • QR コードを外部ビットマップとして合成するのではなく、PDF 内に描画したい場合。
  • QR ベースの繰り返しレイアウトに Template Render を使いたい場合。
  • テキスト、レイアウト、PDF 出力、QR コードレンダリングを 1 つの API パスで扱いたい場合。

置き換えないもの

  • gPdf から URL 短縮、アクセストークン発行、決済リンク作成が必要な場合。
  • スキャン分析やモバイルアプリのロジックが必要な場合。
  • PDF 出力以外で QR コードが必要な場合。

呼び出す endpoint

主経路

/api/v1/pdf/render

JSON Render がこのワークフローの標準パスです。

補助経路 1

/api/v1/template-render

関連 API パス、テンプレート契約、または機能確認が必要な場合に使います。

最小リクエスト

POST /api/v1/pdf/render - QR 照会コード付きの文書ページ。

{
  "pages": [
    {
      "size": "a4",
      "elements": [
        {
          "type": "text",
          "x": 20,
          "y": 24,
          "content": "Scan to view this document online",
          "style": { "font_size": 14, "font_family": "NotoSans-Regular" }
        },
        {
          "type": "barcode",
          "format": "qrcode",
          "content": "https://example.com/documents/DOC-2026-001",
          "x": 20,
          "y": 44,
          "width": 32,
          "height": 32
        }
      ]
    }
  ]
}

gPdf が担当すること

  • PDF 出力内でのベクター QR バーコードレンダリング。
  • QR コード周辺のテキスト、レイアウト、領収書、チケット、ラベル、文書コンテキスト。
  • 繰り返し使う QR ワークフロー向けのテンプレートバインディング。
  • 公開 render API を通じた PDF レスポンス配信。

自社システムが担当すること

  • 符号化する URL またはトークン、アクセス制御、有効期限、リダイレクト挙動、モバイル側の遷移先。
  • スキャナーテスト、ユーザージャーニー、不正防止ルール。
  • スキャン後に発生する支払い、チケット、返品、アカウント操作。

本番前チェックリスト

  1. 符号化する URL は、文書の寿命にわたって安定させるかリダイレクト可能にする。
  2. スキャン距離、コントラスト、サイズ、印刷素材をテストする。
  3. 機微な生データを QR コードの内容へ直接埋め込むことは避ける。
  4. リクエスト ID を使い、生成した各 PDF に紐づく業務オブジェクトをログに記録する。
  5. 安定した QR レイアウトは Template Render に移す。

対応範囲の境界

  • gPdf は PDF 内に QR コードをレンダリングしますが、遷移先をホストしたり保護したりはしません。
  • トークンの有効期限、リダイレクト、権限、読み取り時のユーザー体験は自社システム側で管理します。
  • QR コード自体は、支払いシステムやチケットシステムではありません。

QR コードを置くページでもスキャン後の意味を明確にする

QR コードは目に見える媒体にすぎません。本番ワークフローは、その背後にある遷移先またはトークンによって決まります。gPdf は QR コードを PDF に描画します。スキャン後に何が起こるかは自社システムが管理します。

FAQ

gPdf は QR コード画像を生成しますか?
gPdf は PDF 出力内に QR コードのバーコード要素をレンダリングします。公開レスポンスは PDF であり、単体の画像サービスではありません。
QR コードをテンプレートで使えますか?
はい。テンプレートに QR フィールドを含め、呼び出し側が可変データを送れます。
QR の遷移先は誰が管理しますか?
URL、トークン、リダイレクト、権限、有効期限の挙動は自社システムが管理します。
QR コードに機微データを入れられますか?
送信した内容は符号化できますが、本番システムでは通常、生の機微データではなく照会トークンや URL を符号化すべきです。