APIドキュメント

QR Cake API を使って QRコードを連携・管理するための開発者向けガイドです。

JSON REST API動的QRの作成Bearer認証

APIキーを作成

クイックスタート

QR Cake API を使うと、アカウント内のQRコードをプログラムから作成・更新・管理できます。

ベースURL

https://api.qrcake.com/v1/product

エンドポイント

/user/product

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

認証

ダッシュボードで API キーを作成し、Authorization ヘッダーで送信します。

Authorization: Bearer <API Key>
Content-Type: application/json

APIキーの管理ダッシュボードのAPIキー.

APIリクエストテスター

このページからエンドポイントを直接テストできます。APIキーを入力し、エンドポイントを選択して、レスポンスをその場で確認できます。

インタラクティブ API テスター

ブラウザから選択した QR Cake API エンドポイントに対してリクエストを直接実行します。

GET

エンドポイント

API キー

Authorization: Bearer <API Key>

実行URL

https://api.qrcake.com/v1/product/user/product

リクエストを実行すると、ステータスとレスポンス内容がここに表示されます。

用語

製品

QRコード

ユーザー

QR Cake アカウント

リクエストボディ (POST/PUT)

POST および PUT リクエストでは、リクエストボディを文字列として送信する必要があります。JSON を送る場合は、JSON 文字列として渡してください（例: JSON.stringify(payload)).

const payload = { redirect: "https://example.com", metadata: {} };

await fetch(url, {
  method: "POST",
  body: JSON.stringify(payload),
});

GET

QRコード一覧

この API キーでアクセスできる QRコードを一覧表示します。

GitBook で開く

パス: /user/product

URL: https://api.qrcake.com/v1/product/user/product

リクエストの詳細

ヘッダー

Authorization: Bearer <API Key>
Accept: application/json

応答

200 OK

[
  {
    "accountId": "string",
    "productId": "string",
    "userId": "string",
    "redirect": "string",
    "state": "ACTIVE",
    "metadata": {},
    "createdAt": 0,
    "updatedAt": 0
  }
]

401 Unauthorized

{
  "message": {}
}

products は QRコードを指します。

GET

QRコードを取得

1件の QRコードを取得します。

GitBook で開く

パス: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

リクエストの詳細

パスパラメータ

productId (string)

ヘッダー

Authorization: Bearer <API Key>
Accept: application/json

応答

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

POST

QRコードを作成

新しい QRコードを作成します。

GitBook で開く

パス: /product

URL: https://api.qrcake.com/v1/product/product

リクエストの詳細

ヘッダー

Authorization: Bearer <API Key>
Content-Type: application/json
Accept: application/json

本文テンプレート

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

応答

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

POST リクエスト本文は文字列化する必要があります (JSON.stringify(payload) など)。

PUT

QRコードを更新

既存の QRコードを更新します。

GitBook で開く

パス: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

リクエストの詳細

パスパラメータ

productId (string)

ヘッダー

Authorization: Bearer <API Key>
Content-Type: application/json
Accept: application/json

本文テンプレート

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

応答

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

PUT リクエスト本文は文字列化する必要があります。

DELETE

QRコードを削除

QRコードを削除します。

GitBook で開く

パス: /product/{productId}

URL: https://api.qrcake.com/v1/product/product/{productId}

リクエストの詳細

パスパラメータ

productId (string)

ヘッダー

Authorization: Bearer <API Key>
Accept: application/json

応答

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

権限

API キーに付与された権限を返します。

GitBook で開く

パス: /permission

URL: https://api.qrcake.com/v1/product/permission

リクエストの詳細

ヘッダー

Authorization: Bearer <API Key>
Accept: application/json

応答

200 OK

{
  "success": true,
  "result": {
    "analytics": true,
    "productLimit": 100,
    "tier": "subscriber",
    "productTotal": 3,
    "productActiveLimit": 100,
    "productActiveTotal": 3
  }
}

401 Unauthorized

{
  "message": {}
}

サポートされている QR タイプ

QRコードを作成または更新するときは、これらのメタデータタイプを使用します。

redirect, link, image, video, file, pdf, audio, app, event, vCard

まずはホームページでダイナミックQRコードと変更可能なQRコードをご覧ください。