製品・APIガイド

クイックスタート

5分で最初のドキュメントを

このページでは、何もない状態から、ディスクに保存されたPDFを作成するまでを説明します。すべてのワークスペースに最初からある請求書テンプレートを使うため、事前のデザインは不要です。

1. APIキー

「アカウント → APIキー」でキーを作成してください。シークレットは一度だけ表示されます。ソースコードには含めないでください。すべての呼び出しで、X-PDFgine-Keyヘッダーに指定します。

cURL

# キーはコードではなく、環境変数に設定
export PDFGINE_KEY="pdfgine_live_..."

# 接続確認：テンプレートの一覧を取得
curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

2. ドキュメントを生成

テンプレートコードとデータを指定して、1回呼び出します。documentIdとダウンロードURLを含む202レスポンスが返されます。

cURL

curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "ja",
        "data": {
          "document": { "title": "請求書の概要" },
          "referenceNo": "DOC-2026-0042",
          "issueDate": "2026-09-06",
          "currency": "USD",
          "customer": "Northwind Trading Ltd.",
          "lineItems": [
            { "name": "故障診断", "quantity": 2, "unitPrice": 850.00 }
          ]
        }
      }'

テンプレートを試す際は、"purpose": "editor-test"を送信してください。この出力は利用枠を消費せず、未公開の下書きを使用します。

3. ダウンロード

レスポンスのダウンロードURLはAPIアドレスに対する相対URLで、同じキーで取得します。pdfの代わりにdocxを指定すると、同じデータがWordファイルとして返されます。

cURL

curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

最初につまずきやすい点

402は、月間ページ利用枠を使い切ったことを示します。到達する前に、X-PDFgine-Quota-Remainingヘッダーで残量を確認できます。
422は、データがテンプレートの要件を満たしていないことを示します。本文のerrorsに不足するすべてのフィールドが示されるため、推測する必要はありません。
生成は200ではなく202を返します。200以外を失敗と見なすクライアントでは、成功をエラーとして報告してしまいます。

次に読むページ

「データ形式」は、特によく参照するページです。日付、金額、通貨をどのような形式で送信するかを、具体的に説明しています。

データ形式 →