開発者向け
API＆インテグレーションリファレンス
ビジネスAPIの呼び出し、APIキーの管理、Webhookの受信に必要なすべての情報。
認証
ビジネスAPIはすべてのリクエストでAPIキーによる認証を行います。X-Api-Keyヘッダー、またはAuthorizationヘッダーのBearerトークンとして送信してください。
キーには qrg_ プレフィックスが付いており、作成時に一度だけ表示されます。後から再確認することはできませんので安全に保管してください。
有効なキーがないリクエストは401を返します。所有していないリソースへのリクエストは403を返します。
ベースURL
すべてのビジネスAPIエンドポイントは /v1 プレフィックスの下に存在します。
例えば、QRコード一覧の取得は https://qr-global.com/api/v1/qr-codes にリクエストします。
- 解決されたベースURL
- https://qr-global.com
APIキー
ダッシュボードのAPIキーページでキーを作成・失効させることができます。
各キーはワークスペースに属し、プランのレート制限を引き継ぎます。
キーの失効は即座に反映されます。
コード例
curlコマンドをコピー＆ペーストしてすぐに開始できます。YOUR_API_KEY をAPIキーページで取得したキーに置き換えてください。
QRコード一覧の取得
curl -sS -H "X-Api-Key: YOUR_API_KEY" -H "Accept: application/json" \ "https://qr-global.com/api/v1/qr-codes"
QRコードの作成
QRのタイプとコンテンツを送信すると、サーバーがコードを生成して保存します。
curl -sS -X POST "https://qr-global.com/api/v1/qr-codes" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"type":"url","content":"https://example.com","display_name":"Example link"}'画像のレンダリング
作成済みのPNGまたはSVGファイルを取得します（?format=png
curl -sS "https://qr-global.com/api/v1/qr-codes/123/image?format=png&size=512" \ -H "X-Api-Key: YOUR_API_KEY" -o qr.png # SVG (vector, no size limit on scale): curl -sS "https://qr-global.com/api/v1/qr-codes/123/image?format=svg" \ -H "X-Api-Key: YOUR_API_KEY" -o qr.svg
Webhookのサンプルペイロード
{
"event": "qr.scan.created",
"timestamp": "2026-04-03T12:00:00+00:00",
"data": {
"scan_id": 42,
"qr_code_id": 7,
"scanned_at": "2026-04-03T12:00:00+00:00",
"ip_address": "203.0.113.10",
"device_type": "mobile"
}
}Webhook
Webhookはイベントが発生した際、リアルタイムでエンドポイントへ通知を送信するため、ポーリングは不要です。
ダッシュボードのWebhookページでエンドポイントを設定します。
各配信は署名され、失敗した場合は指数バックオフで自動再試行されます。
スキャンイベントは、作成したQRコードがスキャンされた際に発火します。
配信ログで配信試行、ペイロード、レスポンスを確認できます。
配信完了を確認するために 2xx ステータスを返してください。それ以外のステータスは失敗として扱われます。
エクスポート
エクスポートページから、QRコード、スキャン履歴、位置情報、アクティビティをCSVとして出力できます。
エクスポート機能はAPIキーではなくダッシュボードのセッションを使用します。ログインした状態で実行してください。
ヒントとよくあるエラー
- 401 Unauthorized — APIキーが未設定または無効です。X-Api-Keyヘッダーを確認してください。
- 403 Forbidden — キーは有効ですが、リソースが別のワークスペースに属しています。
- 一部の機能（Webhookなど）はプランに依存します。エンドポイントが機能エラーを返した場合はアップグレードをご検討ください。
- まだWebhookの配信がありませんか？作成したQRコードをスキャンしてテストを発生させてください。
- 失敗したWebhook配信は自動再試行されます。配信ログから手動で再試行することも可能です。
- チームメンバーはワークスペース内で操作します。キーとデータはワークスペース所有者に紐付けられます。