ドキュメント
justQRs公開API
QRコードをプログラムから管理できます。APIキーはダッシュボードのAPIキーから作成してください(アカウント所有者のみ)。
ベースURL
https://api.justqrs.com
認証
すべてのリクエストで、APIキーをベアラートークンとして送信してください:
Authorization: Bearer jqr_xxxxxxxxxxxxxxxx
キーの全文が表示されるのは作成時の1回だけです。キーをローテーションするには、新しいキーを作成してから古いキーを削除してください。
エンドポイント
| メソッド | パス | 説明 |
|---|---|---|
GET | /v1/qrcodes | QRコードの一覧を取得します。 Response: { qrcodes: QrResponse[] } |
POST | /v1/qrcodes | QRコードを作成します。 Request: CreateQrRequest { name, mode, content, design? } · Response: QrResponse |
GET | /v1/qrcodes/{qrId} | QRコードを1件取得します。 Response: QrResponse |
PATCH | /v1/qrcodes/{qrId} | QRコードを更新します(動的QRコードのみ)。 Request: UpdateQrRequest { name?, content?, design? } · Response: QrResponse |
DELETE | /v1/qrcodes/{qrId} | QRコードを削除します。 Response: 204 No Content |
GET | /v1/qrcodes/{qrId}/stats?days=7|30|90 | 動的QRコードのスキャン分析を取得します。 Response: QrStats { totalScans, rangeScans, rangeUniques, series, breakdowns } |
例:URL型のQRコードを作成する
curl -X POST "https://api.justqrs.com/v1/qrcodes" \
-H "Authorization: Bearer jqr_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"name": "My link",
"mode": "dynamic",
"content": { "kind": "url", "url": "https://example.com" }
}'
例:スキャン統計を取得する
curl "https://api.justqrs.com/v1/qrcodes/{qrId}/stats?days=30" \
-H "Authorization: Bearer jqr_xxxxxxxxxxxxxxxx"
エラー
エラーレスポンスはJSON形式です:{ "error": string, "code"?: string }。
| ステータス | コード | 意味 |
|---|---|---|
| 400 | (validation) | リクエストボディが検証に失敗しました。詳細はエラーメッセージをご確認ください。 |
| 401 | — | Authorizationヘッダーがありません。 |
| 403 | — | APIキーが拒否されました。無効、取り消し済み、または期限切れです。 |
| 402 | upgrade_required | アカウントは無料プランです。APIの利用には有料プランが必要です。 |
| 404 | — | QRコードが存在しないか、このアカウントに属していません。 |
| 409 | qr_limit_reached | アカウントはすでに動的QRコードの上限に達しています(基本プランは500個、追加パックで増量できます)。 |