API の概要

​

できること

​

ガイド

​

ベース URL

https://getqr.com/api/v1

​

バージョン管理

• 互換性のない変更は、/api/v2/ のような新しいバージョンのプレフィックスで公開されます。/api/v1/ はそのまま使い続けられます。
• 新しい任意フィールドや新しいエンドポイントなどの追加的な変更は、v1 の中で行われることがあります。コードが認識しないレスポンスフィールドは無視してください。

​

クイックスタート

curl https://getqr.com/api/v1/health

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-qr-0001" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page"
  }'

curl "https://getqr.com/api/v1/qrs/{qrId}/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

​

リクエストとレスポンス

• 形式。 リクエストボディは Content-Type: application/json を付けて JSON で送ります。例外は 一括作成 の CSV アップロードで、multipart/form-data を使います。
• レスポンス。 レスポンスは JSON です。QR コードの画像や一括作成の ZIP アーカイブなどのダウンロードでは、ファイルそのものが返ります。
• 日時。 日時は UTC の ISO 8601 文字列です。例：2026-08-01T10:00:00.000Z。
• クエリパラメータ。 ブール値のパラメータには文字列 true または false を指定します。
• 部分更新。 PATCH エンドポイントは、送ったフィールドだけを変更します。
• 機密情報。 レスポンスにパスワードや内部 ID が含まれることはありません。パスワード保護された QR コードは passwordProtected: true だけを返します。
• ワークスペース。 すべてのリクエストは、API キーが属するワークスペースで実行されます。ワークスペース ID を渡す必要はありません。アクセスと役割 をご覧ください。
• エラー。 失敗したリクエストは、安定した code を持つ error オブジェクトを返します。エラー をご覧ください。

​

ページネーション

{
  "data": [ … ],
  "pagination": { "page": 1, "pageSize": 50, "total": 128, "hasMore": true }
}

​

冪等性

-H "Idempotency-Key: order-4821-qr"

• 24 時間以内に同じキーでリクエストを繰り返すと、2 つ目の QR コードは作成されず、最初のレスポンスが返ります。
• レスポンスヘッダー x-idempotent-replay は、再送されたレスポンスでは true、新しいレスポンスでは false になります。
• そのキーの最初のリクエストがまだ処理中の場合、API は 409 conflict を返します。処理が終わってから再試行してください。
• 同じキーを別のリクエストボディで使うと 422 unprocessable_entity が返ります。
• ヘッダーがない場合、30 秒以内に送られた同一のリクエストボディは重複として扱われます。

​

レート制限

​

今後追加予定

​

次のステップ