API ドキュメント

REST API で製品から QR コードとバーコードを作成します。/api/v1 に JSON を送り、ホストされた SVG 画像を受け取り、同じリソースを一覧または更新できます。

QR コードを作成する

type、内容、任意のデザイン(色、モジュール形状、ロゴ、アイ、フレーム)を付けて POST /api/v1/qr-codes します。応答にはホストされた SVG URL が含まれます。

{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}
QR 作成リファレンス

バーコードを作成する

シンボロジ、value、任意の色やサイズを付けて POST /api/v1/barcodes します。Code 128 から EAN-13 まで 34 種類あります。

{
  "name": "Product SKU",
  "type": "C128",
  "value": "FORQR-1001",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "width_scale": 2,
  "height": 80,
  "display_text": true
}
バーコード作成リファレンス

認証

すべてのリクエストに Bearer トークンとして API キーを付与してください。ダッシュボード → アカウント → API で確認・再生成できます。

Authorization: Bearer YOUR_API_KEY

ベース URL: https://forqrcode.com/api/v1

レート制限

API キーごとに 1 分あたり 60 リクエスト。X-RateLimit-* ヘッダーが付きます。

エラー

エラーは JSON:API 形式です:

{ "errors": [{ "title": "…", "status": "422" }] }

バリデーションエラーには source.pointer が含まれる場合があります。

リソース

OpenAPI 3.1 仕様

QR コード

ロゴ、色、スタイル、コンテンツタイプ付きで QR コードを作成し、一覧または更新します。

5 件のエンドポイント

バーコード

34 種類のシンボロジでバーコードを作成。色、サイズ、ラベルを指定できます。

5 件のエンドポイント

ユーザー

認証済みアカウントのプロフィールを読み取り・更新します。

2 件のエンドポイント

AI QR コード

Replicate 経由でスタイル付き AI QR コードを生成します。

5 件のエンドポイント

リンク

動的 QR 先の短縮リンク。

5 件のエンドポイント

統計

ディメンション別に集計したリンクスキャン分析。

2 件のエンドポイント

プロジェクト

QR コード、バーコード、リンクをプロジェクトに整理します。

5 件のエンドポイント

ドメイン

短縮リンク用のカスタムドメイン。

6 件のエンドポイント

ピクセル

短縮リンク用トラッキングピクセル。

5 件のエンドポイント

支払い

読み取り専用の請求履歴。

2 件のエンドポイント

ログ

アカウント活動ログ(ログイン、キー再生成など)。

1 件のエンドポイント

チーム

認証ユーザーが所有するチームワークスペース。

5 件のエンドポイント

チームメンバー

所有チームのメンバーを招待・管理します。

5 件のエンドポイント

チームメンバーシップ

自分宛てのチーム招待を表示・応答します。

4 件のエンドポイント