API リファレンス
Printgraph API は REST API です。JSON 形式のリクエストを送信し、PDF バイナリを受け取ります。
基本情報
| Base URL | https://api.printgraph.jp/v1 |
| バージョン | v1 |
| Content-Type | application/json |
認証
すべての API リクエストには Authorization ヘッダーに Bearer スキームで API キーを指定してください。 API キーの取得方法は API キーの発行 を参照してください。
Authorization: Bearer YOUR_API_KEYエンドポイント一覧
| メソッド | パス | 説明 |
|---|---|---|
| POST | /pdf/generate | テンプレートから PDF を生成する |
エラーレスポンス
| HTTP ステータス | 説明 |
|---|---|
400 Bad Request | リクエストの形式が不正、または params が上限を超えている |
401 Unauthorized | API キーが無効または未指定 |
403 Forbidden | サブスクリプションが有効でない |
404 Not Found | 指定したテンプレートが見つからない |
500 Internal Server Error | サーバー内部エラー |
cURL によるリクエスト例
curl -X POST https://api.printgraph.jp/v1/pdf/generate \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"templateId":"YOUR_TEMPLATE_ID","params":{"name":"world"}}' \
--output hello_world.pdfPDF 生成エンドポイントの詳細は PDF を生成する を参照してください。
SDK を使った実装は JavaScript SDK または PHP SDK を参照してください。