ユーザーAPIキー

RapidAPIマーケットプレイスのプロキシシークレットの代わりに、/dashboard/keys で発行した自分のキーで認証したい場合は、このページをご覧ください。エンジンは同じで、入口が違うだけです。

マーケットプレイスのクライアントは、引き続き api.qr-branding.com に対して X-RapidAPI-Proxy-Secret を使ってください。コンシューマー向けキーのゲートウェイは qr-branding.com/api/v1/* にあり、マーケットプレイスのチャネルには一切影響しません。

ベースURL

https://qr-branding.com/api/v1

認証

すべてのリクエストでキーを送信します。

X-API-Key: qrb_…

キーはエッジ（CF Pages）で、データベース内のハッシュと照合して検証されます。エンジン自体が平文のキーを目にすることはありません。

キーがない、形式が正しくない、または失効している場合は、次のレスポンスが返ります。

{ "success": false, "error": "Key not recognised, revoked, or malformed.", "code": "invalid_api_key" }

（ステータスコードは401です。）

必要条件: Studio プラン

API は Studio の機能です。AI のリクエストに限らず、すべてのリクエストに有効な Studio パック（購入から12か月以内で、返金されていないもの）が必要です。キーが有効でもアカウントに Studio がない場合、ゲートウェイはこのページと料金ページへのリンクを付けて 402 を返します。

{ "success": false, "error": "The QR Branding API is included with Studio. Buy a Studio pack at https://qr-branding.com/pricing to use your key.", "code": "studio_required", "docs": "https://qr-branding.com/docs/api/public-keys", "pricing": "https://qr-branding.com/pricing" }

当社の LLM キーを使う AI 生成（POST /api/v1/qr/ai/generate/server）では、さらに Studio パックの AI クレジットを1つ消費します。使い切ると、同じリンク付きで 402 out_of_api_credits が返ります。それ以外の呼び出しではクレジットを消費しません。

利用可能なエンドポイント

ゲートウェイは、/api/v1/* 以下のすべてのパスをエンジンに転送します。つまり次のとおりです。

公開URL	転送先
`POST /api/v1/qr/generate`	POST /api/qr/generate
`POST /api/v1/qr/ai/generate/server`	POST /api/qr/ai/generate/server
`GET /api/v1/qr/templates`	GET /api/qr/templates
`POST /api/v1/qr/templates/:id`	POST /api/qr/templates/:id
`POST /api/v1/qr/content/:type`	コンテンツヘルパー（wifi · vcard · geo）
`GET /api/v1/qr/ai/providers`	GET /api/qr/ai/providers
`GET /api/v1/ping`	GET /api/ping

ボディ、レスポンスの形式、エラーコードはエンジンのエンドポイントと同一です。ドキュメントのブックマークはそのままお使いいただけます。

簡単なテスト

curl -X POST https://qr-branding.com/api/v1/qr/generate \
  -H "X-API-Key: qrb_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "content": "https://yourbrand.com", "primaryColor": "#dcc28a", "backgroundColor": "#0a0b0e", "eccLevel": "H" }' \
  --output qr.png --silent --write-out "%{http_code}\n"

200が返り、ディスクに qr.png ができていれば完了です。

制限

ユーザーキーには、コンシューマーチャネルの顧客ごとの制限が適用されます。

呼び出しの種類	1分あたり
一般	120
生成（`/qr/generate`、`/qr/templates/:id`）	60
AI（`/qr/ai/generate/server`）	30

制限に達すると、Retry-After ヘッダー付きの 429 が返ります。詳細と全体の上限は API概要をご覧ください。

マルチパートのアップロード

ゲートウェイが受け付けるのはJSONのみです。ロゴや背景のバイナリをアップロードするには、multipart/form-data の代わりにbase64のフィールド（logoBase64、backgroundImageBase64）を使ってください。v2でマルチパートをネイティブにサポートする可能性があります。

ローテーション

新しいキーを生成してデプロイし、その後で古いキーを失効させます。平文が表示されるのは一度だけなので、シークレットマネージャーに保存してください。

# in your CI / secrets tool
QR_BRANDING_KEY=qrb_new_key_here

古いキーがゲートウェイから 401 invalid_api_key を受け取るようになれば、すべての環境の移行が完了し、ローテーションが成功したことを確認できます。