QRFLOW.codes
公式QRコードを作成し、印刷済みの動的コードを再設定し、自社ドメイン上でリンクに名前を付け、スキャン分析を読み取ります。
QRFLOW Codes MCPで何ができますか?
- 動的QRコードを作成 — アシスタントに
destination_dataを指定したurlコードの作成を依頼し、印刷用にshort_urlを返してもらいます。 - 印刷済みコードのリンク先を変更 — 画像には
short_urlが含まれているため、再印刷せずに既存の動的コードのリダイレクト先を変更できます。 - コードを一時停止または期限切れにする — 削除する代わりに
paused: trueまたは終了日を設定すれば、印刷済みリンクのリダイレクトを安全に停止できます。 - スキャン分析を確認 — コードの累計
Scans数、または日別・国別・デバイス別の内訳を取得できます。 - 独自ドメインでリンクに名前を付ける —
menuのようなslugを設定し、リンクドメインを選ぶと、コードにはgo.example.com/menuが印刷されます。 - コードを一括作成 — リストから数千件の動的コードを生成し、ラベルを使って返されたコードを各行に対応付けられます。
ホスト型 MCP サーバー
npx add-mcp 'https://qrflow.codes/mcp'Claude Code、Codex、Cursor などにインストールできます
ドキュメント
QRFLOW.codes 開発者向け
まずはこちら
QRFLOW.codes では、印刷後に変更できる QR コードを、自分のドメインで作成できます。スキャン分析機能も備えており、ソフトウェアや AI アシスタントから、すべてを 1 つの API で操作できます。
QR コードは文字列を画像にしたものです。ほとんどのジェネレーターは画像にウェブアドレスを埋め込むため、アドレスが変わると印刷物は使えなくなります。QRFLOW は画像に短縮リンク(go.yourbrand.com/menu や qrflow.codes/q/x7k2p9a)を埋め込み、そこからリダイレクトします。リンク先はいつでも変更でき、スキャンはすべて記録されます。これが動的コードであり、API を使う価値がある機能です。
API ではダッシュボードと同じ操作ができます。あらゆる種類のコードの作成、リンク先の変更、リンク名の設定、印刷に使うドメインの選択、スキャン数の取得、一度に数千件の作成、イベント発生時の通知(webhook)などが可能です。同じツールは MCP サーバーとしても提供されているため、Claude、ChatGPT、Cursor、Claude Code から、普段の言葉でアカウントを操作できます。
アクセス方法:REST API には Business API キー(月額 $29、Account ページで作成)または OAuth トークンが必要です。MCP サーバーは OAuth サインインを通じてすべてのプランで利用できます。アシスタントが作成できるものは、他の機能と同様にプランに応じて決まります。
そもそも使うべきか迷っていますか?QR code API ページでは、できること、クライアント側ライブラリのほうが適していること、料金を簡潔に説明しています。
QRFLOW を使った開発を支援する AI アシスタント向け
ようこそ。このページは、支援を受ける人だけでなく、あなたにも向けて書かれています。適切な支援のポイントは次のとおりです。
- アカウントを確認します。API キーには Business プランが必要です。Business プランでない場合は、https://qrflow.codes/pricing と Account › API keys を案内してください。存在しないキーや無料プランをでっち上げてはいけません。
- キーはサーバー上に保管します。ルートハンドラー、サーバーアクション、エッジ関数、バックエンドで、環境変数(QRFLOW_KEY)から読み込みます。API は意図的にブラウザーのオリジンを拒否するため(CORS)、フロントエンドだけのコードからは呼び出せません。
- 動的コードは type "url" と destination_data.url を指定して作成します。返された id と short_url をデータベースに保存します。short_url を印刷または表示してください。後から PATCH /codes/:id でリンク先を変更しても、印刷物はそのまま使えます。
- 画像を表示または保存する場合:すべての Code オブジェクトには png_download_url と svg_download_url があり、ヘッダーなしで 24 時間使える署名付きリンクです(1 回限りの保存やプレビューに適しています)。アプリで永続的に使う場合は、キーを使ってサーバー経由で GET /codes/:id/image.svg をプロキシするか、クライアントで任意の QR ライブラリを使って short_url をエンコードします。リンクは QRFLOW を経由するため、どちらの場合もトラッキングは機能します。
- PATCH では変更するフィールドだけを送信します。印刷後は slug や domain_id を変更しないでください。どちらも印刷済みリンクを変えてしまいます。
- 印刷物がある場合は、DELETE より paused: true を優先します。削除するとリンクが使えなくなります。
- イベントには webhook(Account › Webhooks または POST /webhooks)を使い、リクエスト本文の生データで X-QRFLOW-Signature ヘッダーを検証します。GET /codes をループでポーリングしないでください。
- コードではなくチャットから QRFLOW を使いたい場合は、https://qrflow.codes/mcp; で MCP サーバーに接続します。キーは不要です。
- 失敗した場合は、JSON 本文の error と message を確認します。以下のトラブルシューティングでは、すべてのエラーコードと対処法を説明しています。
- Markdown 形式の完全なリファレンスは https://qrflow.codes/llms-full.txt、OpenAPI 3.1 ドキュメントは https://qrflow.codes/api/v1/openapi.json. にあります。どちらもこのページと同じソースから生成されています。
人間の皆さんへ:このブロックは、あなたが一緒に作業するアシスタントが、あらゆる質問に安全な方法で答えられるようにするためのものです。内容は優れた要約にもなっています。
必要なプラン
Business 限定なのは API キーだけです。MCP サーバー経由でアシスタントが行う操作も、OAuth 経由でサードパーティアプリが行う操作も、すべてのプランで利用でき、各プランの機能に従います。料金と公正利用の詳細:/pricing。
| Free | Premium $4 | Business $29 | |
|---|---|---|---|
| API キー(コードからの REST) | いいえ | いいえ | はい、最大 10 個 |
| MCP サーバー(Claude、ChatGPT、Cursor、Claude Code) | はい、サインイン | はい | はい、サインインまたはキー |
| 独自アプリ向け OAuth(ユーザーが自分の QRFLOW を接続) | はい | はい | はい |
| 動的コード(印刷後にリンク先を変更) | 1 個 | すべてのコード | すべてのコード |
| 独自のリンクドメイン | いいえ | 1 ドメイン | 5 ドメイン、コードごとに選択 |
| リンク名(go.brand.com/menu) | いいえ | はい | はい |
| スキャン分析 | いいえ | はい | はい |
| Webhook | いいえ | いいえ | はい、最大 10 個 |
| 一括作成 | いいえ | 月 500 件、1 リクエストあたり 500 件 | 月 10,000 件、1 リクエストあたり 2,000 件 |
| 保存できるコード(公正利用) | 少数 | 1,000 件 | 25,000 件 |
| チームメンバー枠 | 1 | 1 | 5 |
| 料金 | $0 | 月額 $4 | 月額 $29 |
すべてを担う 12 の言葉
概念
一度読めば、以下のすべてのエンドポイントが理解できます。
Static code
画像の中にコンテンツが含まれます。Wi-Fi、連絡先カード(vCard)、プレーンテキストのコードは常に静的です。Free プランではすべてのコードが静的です。静的コードはサーバーを必要とせず、期限切れにもなりませんが、変更や計測はできません。
Dynamic code
画像には、QRFLOW がリダイレクトする短縮リンクが含まれます。url、phone、email、sms、location のコードは、Premium と Business で動的になります。印刷物に手を加えずに、リンク先の変更、一時停止、期限設定、名前の変更、計測ができます。
short_url
動的コードにエンコードされる正確な文字列で、印刷する対象です。ドメインを接続するまでは https://qrflow.codes/q/<short_code>、接続後は https://<your domain>/<slug or short_code>. です。すべての Code オブジェクトに含まれます。
short_code
コードの作成時に割り当てられる、コードごとに一意な 7 文字のランダム文字列です。変更されることはありません。リンク名がないコードで使われるフォールバックパスです。
slug (link name)
独自ドメイン上の読みやすいパスです(go.example.com/menu)。3~40 文字の小文字、数字、ハイフンを使い、アカウント内で一意である必要があります。接続済みドメインがある場合にのみ設定できます。印刷前に設定してください。変更すると印刷済みリンクも変わります。
Link domain
所有するホスト名(go.example.com)を CNAME で QRFLOW に向け、Account ページで検証したものです。Premium では 1 つ、Business では 5 つ利用でき、domain_id を使ってコードごとに選択できます。最も古い有効なドメインがデフォルトになります。
Kind, type and subtype
type はエンコード形式です:url、text、wifi、vcard、email、phone、sms、location。kind は、ユーザーが求めるものをわかりやすく表す名前です(instagram、googlereview、whatsapp、pdf、menu、appstore など)。ほとんどの kind は、destination_data.subtype を設定した url コードです。GET /catalog で各 kind とそのフィールドを確認できます。Code の kind から、そのコードの種類がわかります。
destination_data
type に対応する文字列フィールドです。ウェブサイトなら { url }、Wi-Fi なら { ssid, password, encryption }、Google レビューなら { placeId }、Instagram なら { handle } です。動的コードでは、いつでも置き換えられます。
Scans
リダイレクトごとに、リクエスト自体からデバイスの種類、国、都市、リファラー、ブラウザー、OS、言語を記録し、ユニーク訪問者の計測には日ごとの一方向ハッシュを使います。Cookie は設定せず、IP アドレスも保存しません。Code の scans は累計数です。GET /codes/:id/scans で内訳を確認できます。
Source
すべてのコードには作成元が記録されます。dashboard、api:<key name>、mcp、canva、app:<connected app>(例:app:Google Sheets)、または bulk です。一括リクエスト経由の場合は bulk: プレフィックスが付きます。ダッシュボードと webhook ペイロードに表示されるため、連携機能で作成したコードと手動で作成したコードを区別できます。
Workspace
Business のオーナーは、最大 4 人のチームメンバーを招待できます。キーと webhook はオーナーのアカウントに属します。ワークスペース内で誰が作成したコードも、チーム全体から確認できます。
5 分で完了
クイックスタート
キーを取得する
- Business プランで、Account › API keys を開きます。
- 用途に合わせて名前を付け(「Shop backend」「Reporting」など)、スコープを選択します。スコープは後から変更できません。追加が必要な場合は、新しいキーを作成してください。
- キーを一度だけコピーします。形式は
qrf_live_…です。QRFLOW_KEYという名前の環境変数に設定します。 - すべてのリクエストで
Authorization: Bearer $QRFLOW_KEYとして送信します。認証の手順はこれだけです。
キーはサーバー用です。ウェブページ、モバイルアプリ、共有スプレッドシートには絶対に入れないでください。漏えいした場合は、キーを失効させて再発行してください。
curl、TypeScript、Python で同じ 5 つの手順を実行します。それぞれ動的コードを作成し、画像をダウンロードし、リンク先を変更して、スキャン数を取得します。
export QRFLOW_KEY=qrf_live_... # from Account › API keys
# 1. Who am I, what can this key do?
curl https://qrflow.codes/api/v1/me -H "Authorization: Bearer $QRFLOW_KEY"
# 2. Make a dynamic code. Print what comes back as short_url.
curl -X POST https://qrflow.codes/api/v1/codes \
-H "Authorization: Bearer $QRFLOW_KEY" -H "Content-Type: application/json" \
-d '{ "type": "url", "destination_data": { "url": "https://example.com/menu" }, "label": "Table tents" }'
# 3. The print-ready image (SVG, with your colors and frame).
curl "https://qrflow.codes/api/v1/codes/$CODE_ID/image.svg?size=1024" \
-H "Authorization: Bearer $QRFLOW_KEY" -o menu.svg
# 4. Fall menu. The printed code keeps working.
curl -X PATCH https://qrflow.codes/api/v1/codes/$CODE_ID \
-H "Authorization: Bearer $QRFLOW_KEY" -H "Content-Type: application/json" \
-d '{ "destination_data": { "url": "https://example.com/menu-fall" } }'
# 5. How did it do?
curl "https://qrflow.codes/api/v1/codes/$CODE_ID/scans?group=day" -H "Authorization: Bearer $QRFLOW_KEY"
TypeScript(Node 18+、Bun、Deno、Workers)
// npm install qrflow (zero dependencies; ESM + CommonJS; full types)
import { QRFlow, QRFlowError } from "qrflow";
const qr = new QRFlow(process.env.QRFLOW_KEY!);
const { code } = await qr.createCode({
type: "url",
destination_data: { url: "https://example.com/menu" },
label: "Table tents",
});
console.log(code.id, code.short_url); // save both; print short_url
await qr.updateCode(code.id, { destination_data: { url: "https://example.com/menu-fall" } });
const stats = await qr.scans(code.id, { group: "day" });
console.log(stats.total, stats.rows); // [{ key: "2026-09-21", scans: 18 }, ...]
try {
await qr.updateCode(code.id, { slug: "menu" });
} catch (e) {
if (e instanceof QRFlowError) console.log(e.status, e.code, e.message); // 400 no_domain: connect a domain first
}
# Download https://qrflow.codes/sdk/qrflow.py next to your code.
import os
from qrflow import QRFlow, QRFlowError
qr = QRFlow(os.environ["QRFLOW_KEY"])
code = qr.create_code(type="url", destination_data={"url": "https://example.com/menu"}, label="Table tents")["code"]
print(code["id"], code["short_url"]) # save both; print short_url
qr.update_code(code["id"], destination_data={"url": "https://example.com/menu-fall"})
stats = qr.scans(code["id"], group="day")
print(stats["total"], stats["rows"])
try:
qr.update_code(code["id"], slug="menu")
except QRFlowError as e:
print(e.status, e.code, e) # 400 no_domain: connect a domain first
認証
API キー(Business)
アカウントごとに最大 10 個、キーごとに毎分 600 リクエストまで利用できます。キーはハッシュ化して保存され、一度だけ表示されます。キーには作成時に指定したスコープが設定されます。
| スコープ | 許可される操作 |
|---|---|
| profile | GET /me:プラン、機能、上限。すべてのキーに含まれます。 |
| codes:read | コードの一覧表示と読み取り、画像のダウンロード。 |
| codes:write | コードの作成、変更、動的化、削除、一括作成。 |
| analytics:read | GET /codes/:id/scans。 |
| domains:read | GET /domains(domain_id を適切に使うために必要)。 |
| codes:read / codes:write | GS1 製品にも対応します。/products エンドポイントもコード用スコープを共有するため、コードを管理するキーでパッケージコードも管理できます。 |
| webhooks:manage | webhook の一覧表示、作成、テスト、削除。 |
OAuth 2.0(すべてのプラン、アプリとアシスタント向け)
コードを自分ではなくユーザーのアカウントに紐付ける場合や、チャットアシスタントをクライアントにする場合は、OAuth を使います。クライアントは自身で登録します。パブリッククライアントには PKCE S256 が必須です。トークンは resource= を使って MCP サーバーに紐付けられます。OAuth レシピで手順を説明しています。
| エンドポイント | URL | 備考 |
|---|---|---|
| Authorization | https://qrflow.codes/oauth/authorize | ユーザーをここに誘導します。サインインして Allow を押します。 |
| Token | https://qrflow.codes/api/oauth/token | authorization_code と refresh_token のグラントに対応します。アクセストークンの有効期間は 1 時間、リフレッシュトークンは 90 日です。 |
| Revoke | https://qrflow.codes/api/oauth/revoke | RFC 7009。ユーザーは Account › Connected apps からも接続を解除できます。 |
| クライアントの登録 | https://qrflow.codes/api/oauth/register | RFC 7591 の動的登録に対応し、アカウントは不要です。パブリッククライアントには dyn_ client_id が付与され、PKCE S256 の使用が必須です。 |
| Discovery | https://qrflow.codes/.well-known/oauth-authorization-server | RFC 8414。MCP リソースドキュメントは /.well-known/oauth-protected-resource にあります。 |
アクセストークンの有効期間は 1 時間、リフレッシュトークンは 90 日です。ユーザーは Account › Connected apps で接続済みアプリを確認でき、いつでも接続を解除できます。https://qrflow.codes/mcp 用に発行されたトークンは /api/v1 では拒否され、その逆も同様です。
実際によくある要望
開発レシピ
各レシピは、動作するコードをそのまま使える完全な例です。利用するスタックに合ったものを選んでください。基本の流れは常に同じです。キーを使ってサーバー側から呼び出し、id と short_url を保存し、画像を表示します。
- Next.js
- プロキシを使わずに QR を表示する
- Express または任意の Node サーバー
- Cloudflare Workers、Vercel Edge、Deno Deploy、Supabase Edge Functions
- Python
- 注文、テーブル、商品、チケット、イベントごとに QR コードを作成する
- 印刷済みコードのリンク先を変更する
- 独自ドメインでコードを印刷する
- 独自の管理画面にスキャンチャートを表示する
- Next.js で webhook を受信して検証する
- Python で webhook を受信する
- CSV から数千件のコードを作成する
- ユーザーが自分の QRFLOW アカウントを接続できるようにする(OAuth)
- Zapier、Make、n8n
Next.js:コードを作成するルートと表示するルート
対象:Next.js アプリ(App Router)があり、ボタンで QR コードを作成し、ページに表示したい場合。
- キーを .env.local に QRFLOW_KEY として設定します。NEXT_PUBLIC_ を前置しないでください。
- コードを作成して id と short_url を返す POST ルートハンドラーを追加します。
- ブラウザーにキーが見えないよう、画像をプロキシする GET ルートを追加します。
- id と short_url を独自のレコード(注文、テーブル、商品、イベント)に保存します。
import { NextResponse } from "next/server";
export async function POST(req: Request) {
const { url, label } = await req.json();
const r = await fetch("https://qrflow.codes/api/v1/codes", {
method: "POST",
headers: { Authorization: \`Bearer ${process.env.QRFLOW_KEY}\`, "Content-Type": "application/json" },
body: JSON.stringify({ type: "url", destination_data: { url }, label }),
});
const data = await r.json();
if (!r.ok) return NextResponse.json(data, { status: r.status }); // { error, message }
return NextResponse.json({ id: data.code.id, short_url: data.code.short_url });
}
// Proxies the SVG so the key stays on the server. Check that the signed-in
// user owns this id before you serve it, or anyone with an id can fetch it.
export async function GET(_: Request, { params }: { params: Promise<{ id: string }> }) {
const { id } = await params;
const r = await fetch(\`https://qrflow.codes/api/v1/codes/${id}/image.svg?size=1024\`, {
headers: { Authorization: \`Bearer ${process.env.QRFLOW_KEY}\` },
});
return new Response(r.body, {
status: r.status,
headers: { "Content-Type": "image/svg+xml", "Cache-Control": "private, max-age=3600" },
});
}
<img src={\`/api/qr/${code.id}/image\`} alt={\`QR code for ${code.label}\`} width={256} height={256} />
<a href={code.short_url}>{code.short_url}</a>
- Server Actions も同じ方法です。アクション内でキーを使って fetch を呼び出します。
- Pages Router の場合は、同じコードを pages/api/qr.ts に配置し、req/res を使います。
プロキシを使わずに QR を表示する: short_url を自分でレンダリングする
対象: ブラウザーですぐに画像を表示したく、QRFLOW のフレームやロゴが不要な場合。
コードが短縮リンクそのものなので、どの QR ライブラリでも使えます
import QRCode from "qrcode"; // npm i qrcode
// short_url came back from POST /codes. Encode it as-is.
const dataUrl = await QRCode.toDataURL(code.short_url, { width: 512, margin: 2 });
// <img src={dataUrl} /> scans go through QRFLOW, so analytics and re-pointing still work.
- プレビューにはこれが最速の方法です。印刷する場合は /codes/:id/image.svg をダウンロードしてください。保存済みの色、フレーム、キャプション、ロゴが反映され、ベクター形式です。
- 後から slug または domain_id を変更すると short_url も変わるため、再レンダリングしてください。
Express または任意の Node サーバー
対象: シンプルな Node バックエンド。
import express from "express";
const app = express();
app.use(express.json());
const H = { Authorization: \`Bearer ${process.env.QRFLOW_KEY}\`, "Content-Type": "application/json" };
app.post("/qr", async (req, res) => {
const r = await fetch("https://qrflow.codes/api/v1/codes", {
method: "POST", headers: H,
body: JSON.stringify({ type: "url", destination_data: { url: req.body.url }, label: req.body.label }),
});
res.status(r.status).json(await r.json());
});
app.get("/qr/:id.svg", async (req, res) => {
const r = await fetch(\`https://qrflow.codes/api/v1/codes/${req.params.id}/image.svg\`, { headers: H });
res.status(r.status).type("image/svg+xml").send(await r.text());
});
app.listen(3000);
Cloudflare Workers、Vercel Edge、Deno Deploy、Supabase Edge Functions
対象: Node の組み込み機能を使わない、fetch のみのランタイム。
export default {
async fetch(req: Request, env: { QRFLOW_KEY: string }) {
const { url, label } = await req.json();
const r = await fetch("https://qrflow.codes/api/v1/codes", {
method: "POST",
headers: { Authorization: \`Bearer ${env.QRFLOW_KEY}\`, "Content-Type": "application/json" },
body: JSON.stringify({ type: "url", destination_data: { url }, label }),
});
return new Response(r.body, { status: r.status, headers: { "Content-Type": "application/json" } });
},
};
Deno.serve(async (req) => {
const { url, label } = await req.json();
const r = await fetch("https://qrflow.codes/api/v1/codes", {
method: "POST",
headers: { Authorization: \`Bearer ${Deno.env.get("QRFLOW_KEY")}\`, "Content-Type": "application/json" },
body: JSON.stringify({ type: "url", destination_data: { url }, label }),
});
return new Response(await r.text(), { status: r.status, headers: { "Content-Type": "application/json" } });
});
// supabase secrets set QRFLOW_KEY=qrf_live_...
- npm パッケージ
qrflow\は fetch と WebCrypto のみを使うため、これらすべてで変更なしに動作します。
Python: FastAPI、Flask、Django、スクリプト
対象: バックエンドが Python の場合。
import os
from fastapi import FastAPI, HTTPException, Response
from qrflow import QRFlow, QRFlowError # https://qrflow.codes/sdk/qrflow.py
app = FastAPI()
qr = QRFlow(os.environ["QRFLOW_KEY"])
@app.post("/qr")
def make_qr(url: str, label: str | None = None):
try:
code = qr.create_code(type="url", destination_data={"url": url}, label=label)["code"]
except QRFlowError as e:
raise HTTPException(e.status, {"error": e.code, "message": str(e)})
return {"id": code["id"], "short_url": code["short_url"]}
@app.get("/qr/{code_id}.svg")
def qr_image(code_id: str):
import urllib.request
req = urllib.request.Request(qr.image_url(code_id), headers={"Authorization": f"Bearer {os.environ['QRFLOW_KEY']}"})
with urllib.request.urlopen(req) as r:
return Response(r.read(), media_type="image/svg+xml")
注文、テーブル、商品、チケット、イベントごとに QR コードを 1 つ作成する
対象: テーブルの各行に、それぞれのコードを自動で作成する必要がある場合。
- テーブルに列を 2 つ追加します: qrflow_code_id (uuid) と qr_short_url (text)。
- 行が作成されたら、その行の公開 URL と、行を識別するラベル(「注文 10432」、「テーブル 7」など)を指定して POST /codes を実行します。id と short_url を保存します。
- 行のページが移動したら(新しいドメイン、新しいパス)、destination_data を PATCH します。印刷済みのコードは引き続き使えます。
- 行を廃止する場合、印刷済みのものがあれば PATCH { paused: true } を実行します。印刷していない場合に限り DELETE します。
- 一度に数千件必要ですか(300 軒のレストランで、テーブルごとにメニューを用意するなど)? POST /codes/bulk を分割して実行し、返されたコードをラベルまたは順序で各行に対応付けます。
const { code } = await qr.createCode({
type: "url",
destination_data: { url: \`https://example.com/orders/${order.id}\` },
label: \`Order ${order.number}\`,
});
await db.orders.update(order.id, { qrflow_code_id: code.id, qr_short_url: code.short_url });
- Business では保存できるコード数は 25,000 件までです。API はその 2 倍で停止します。レシートごとにコードを永久に 1 つ作成する必要がある場合は、まずご相談ください: hello@qrflow.codes。
印刷済みコードのリンク先を変更する
対象: キャンペーンの終了、ページの移動、PDF の差し替え、シーズンの変更など。
curl -X PATCH https://qrflow.codes/api/v1/codes/$CODE_ID \
-H "Authorization: Bearer $QRFLOW_KEY" -H "Content-Type: application/json" \
-d '{ "destination_data": { "url": "https://example.com/spring" } }'
一時停止するか、終了日を設定する
# Scans show a "paused" page instead of redirecting
curl -X PATCH https://qrflow.codes/api/v1/codes/$CODE_ID -H "Authorization: Bearer $QRFLOW_KEY" \
-H "Content-Type: application/json" -d '{ "paused": true }'
# Stops working after the date; null clears it
curl -X PATCH https://qrflow.codes/api/v1/codes/$CODE_ID -H "Authorization: Bearer $QRFLOW_KEY" \
-H "Content-Type: application/json" -d '{ "expires_at": "2026-12-31T23:59:59Z" }'
- リンク先を変更できるのは動的コードのみです。静的コードは 400 not_dynamic を返します。Wi-Fi、vCard、プレーンテキストのコードはパターン内にコンテンツを含むため、動的にはできません。そのため POST /codes/:id/dynamic は 400 not_dynamic_capable を返します。url、phone、email、sms、location のコードでは、Free プランの場合、最初の 1 つが動的で残りは静的になります。有料プランではすべて動的です。アカウントの上限に達していなければ、POST /codes/:id/dynamic で静的コードを動的に変換できます。その後、画像が変わるため、再レンダリングして再印刷してください。
- スキャナーは次回のスキャンから新しいリンク先を認識します。キャッシュが切れるのを待つ必要はありません。
独自ドメインでコードを印刷する
対象: コードに qrflow.codes/q/x7k2p9a ではなく go.example.com/menu を表示したい場合。
- Account ページの Your own link domain で go.example.com を追加し、DNS プロバイダーに表示された CNAME を作成します。通常、数分で検証が完了します。
- 以降、新しい動的コードの short_url にはそのドメインが使われます。既存のコードも切り替わります。画像には qrflow.codes/q/... が埋め込まれていますが、引き続きリダイレクトされるため、印刷済みのコードに影響はありません。
- slug を使って読みやすい名前を付けます: PATCH { "slug": "menu" } を実行すると go.example.com/menu になります。印刷前に設定してください。
- 複数のドメインを使う Business プランでは、GET /domains で ID を確認できます。コードごとにドメインを選ぶには、POST または PATCH に domain_id を渡します。
リンクに名前を付け、ドメインを選ぶ
curl https://qrflow.codes/api/v1/domains -H "Authorization: Bearer $QRFLOW_KEY"
# { "default_base": "https://go.example.com", "domains": [ { "id": "…", "host": "go.example.com", "is_default": true, … }, { "id": "…", "host": "qr.example.fr", … } ] }
curl -X PATCH https://qrflow.codes/api/v1/codes/$CODE_ID -H "Authorization: Bearer $QRFLOW_KEY" -H "Content-Type: application/json" \
-d '{ "slug": "menu", "domain_id": "<id of qr.example.fr>" }'
# short_url is now https://qr.example.fr/menu
独自の管理画面にスキャンチャートを表示する
対象: 自社の数値と並べて、日別、国別、デバイス別のスキャン数を表示したい場合。
const stats = await qr.scans(code.id, { from: "2026-09-01", to: "2026-09-30", group: "day" });
// stats.total -> 412
// stats.rows -> [{ key: "2026-09-01", scans: 18 }, { key: "2026-09-02", scans: 25 }, ...]
// Feed rows straight into Recharts, Chart.js, or a <table>.
const byCountry = await qr.scans(code.id, { group: "country" }); // [{ key: "US", scans: 300 }, { key: "MX", scans: 41 }]
const byDevice = await qr.scans(code.id, { group: "device" }); // mobile, desktop, tablet
- 1 回のリクエストで最大 92 日分を取得できます。それより長い期間は繰り返しリクエストしてください。日付は UTC です。
- ポーリングせずにリアルタイムの数値を取得するには、スキャンイベントの webhook を登録します。数分ごとに、詳細を含むすべてのスキャンがバッチで届きます。
Next.js で webhook を受信して検証する
対象: コードのスキャンや変更を、自社データベースでほぼリアルタイムに把握したい場合。
- Account › Webhooks または POST /webhooks で webhook を作成します。シークレット (whsec_...) をコピーし、QRFLOW_WEBHOOK_SECRET に一度だけ保存します。
- パースする前に、リクエストの生の本文をテキストとして読み込みます。署名は正確なバイト列を対象にしています。
- 検証してからイベントに応じて処理を切り替えます。すぐに 2xx を返し、時間のかかる処理は応答後またはキューで実行します。
- webhook の Test を押して署名付き ping を受信し、設定を確認します。
import { createHmac, timingSafeEqual } from "node:crypto";
function verify(raw: string, header: string, secret: string): boolean {
const t = /t=(\d+)/.exec(header)?.[1], v1 = /v1=([a-f0-9]+)/.exec(header)?.[1];
if (!t || !v1 || Math.abs(Date.now() / 1000 - Number(t)) > 300) return false;
const expected = createHmac("sha256", secret).update(\`${t}.${raw}\`).digest("hex");
return expected.length === v1.length && timingSafeEqual(Buffer.from(expected), Buffer.from(v1));
}
export async function POST(req: Request) {
const raw = await req.text();
if (!verify(raw, req.headers.get("x-qrflow-signature") ?? "", process.env.QRFLOW_WEBHOOK_SECRET!)) {
return new Response("bad signature", { status: 401 });
}
const evt = JSON.parse(raw) as { id: string; event: string; created_at: string; data: any };
// evt.id is stable across retries: store it and skip duplicates.
switch (evt.event) {
case "scan": // evt.data.scans[]: code_id, label, slug, scanned_at, device, country, city, referrer, browser, os, language
break;
case "code.created": // evt.data.code, evt.data.source
case "code.updated": // evt.data.code, evt.data.changed[]
case "code.deleted": // evt.data.code { id, label, short_code, slug }
break;
case "ping": // the Test button
break;
}
return new Response(null, { status: 204 });
}
- ローカルでは、トンネルを使って開発サーバーを公開します(cloudflared tunnel --url http://localhost:3000, または ngrok)。開発中は、その https URL を webhook に指定します。
- npm パッケージを使えば、これらの処理を任せられます:
import { parseWebhook } from "qrflow"\は 1 回の呼び出しで検証とパースを行います(WebCrypto を使うため、Workers と Deno でも動作します)。Python クライアントには verify_webhook が含まれています。
Python で webhook を受信する
対象: 同じイベントを受信する Flask、FastAPI、Django。
import os, json
from flask import Flask, request, abort
from qrflow import verify_webhook # https://qrflow.codes/sdk/qrflow.py
app = Flask(__name__)
@app.post("/qrflow")
def hook():
raw = request.get_data() # bytes, before any parsing
if not verify_webhook(raw, request.headers.get("X-QRFLOW-Signature", ""), os.environ["QRFLOW_WEBHOOK_SECRET"]):
abort(401)
evt = json.loads(raw)
if evt["event"] == "scan":
for s in evt["data"]["scans"]:
print(s["code_id"], s["scanned_at"], s["country"], s["device"])
return "", 204
CSV から数千件のコードを作成する
対象: SKU、座席、資産タグ、郵送物ごとにコードを作成する場合。
import { parse } from "csv-parse/sync";
import { readFileSync } from "node:fs";
const rows = parse(readFileSync("skus.csv"), { columns: true }) as Array<{ sku: string; url: string }>;
const out: Array<{ sku: string; id: string; short_url: string }> = [];
for (let i = 0; i < rows.length; i += 2000) { // Business: 2,000 per request
const chunk = rows.slice(i, i + 2000);
const { codes, rejected, remaining_this_month } = await qr.bulkCreate(
chunk.map((r) => ({ destination: r.url, label: r.sku })),
);
codes.forEach((c, j) => out.push({ sku: chunk[j].sku, id: c.id, short_url: c.short_url }));
if (rejected.length) console.warn(rejected); // rows that were not web addresses
console.log(remaining_this_month, "left this month");
}
- 一括作成で作成できるのは、色がすべて同じ動的な url コードのみです。コードは送信した順に返されますが、拒否された行は除かれます。対応関係が不明な場合は、ラベルで照合してください。
- 一括リクエストごとに、コードごとではなく codes[] を含む code.created イベントが 1 つ webhook に送信されます。
ユーザー自身の QRFLOW アカウントを接続する (OAuth)
対象: 他の人向けの製品を開発しており、自分のアカウントではなく、ユーザーの QRFLOW アカウントにコードを作成したい場合。
- クライアントを一度登録します: client_name と redirect_uris を指定して POST https://qrflow.codes/api/oauth/register を実行します。client_id(および confidential client の場合は client_secret)が発行されます。
- response_type=code、client_id、redirect_uri、scope、state、PKCE (code_challenge、code_challenge_method=S256) を指定して、ユーザーを /oauth/authorize に誘導します。
- /api/oauth/token でコードを交換します。refresh token を保存してください。access token の有効期間は 1 時間です。
- Authorization: Bearer <access_token> を指定して /api/v1 を呼び出します。ユーザーのプランに基づき、API キーを使う場合とまったく同じように動作します。
curl -X POST https://qrflow.codes/api/oauth/register -H "Content-Type: application/json" \
-d '{ "client_name": "Acme Menus", "redirect_uris": ["https://app.example.com/oauth/qrflow"], "token_endpoint_auth_method": "none" }'
# { "client_id": "dyn_…", "redirect_uris": [...], "grant_types": ["authorization_code","refresh_token"], … }
https://qrflow.codes/oauth/authorize?response_type=code&client_id=dyn_…&redirect_uri=https%3A%2F%2Fapp.example.com%2Foauth%2Fqrflow
&scope=profile%20codes%3Aread%20codes%3Awrite%20analytics%3Aread&state=…&code_challenge=…&code_challenge_method=S256
- スコープは API キーと同じ 6 種類です。必要最小限のスコープを要求してください。ユーザーの同意画面に一覧が表示されます。
- アプリがチャットアシスタントまたはエージェントの場合は、認可リクエストに resource=https://qrflow.codes/mcp を追加し、代わりに MCP サーバーを利用してください。トークンはそのサーバーに紐付けられます。
Zapier、Make、n8n: コード不要
対象: スキャンや新しいコードをスプレッドシート、Slack チャンネル、CRM に送信したい場合。
- catch-hook トリガーを作成します(Zapier: Webhooks by Zapier › Catch Hook、Make: Custom webhook、n8n: Webhook node)。表示された https URL をコピーします。
- Account › Webhooks でその URL を追加し、イベントを選択します。Test を押すと、ツールに ping が届き、ペイロードの形式を確認できます。
- data.scans[](スキャンの場合)または data.code(code.* の場合)を、スプレッドシート、メッセージ、レコードにマッピングします。
- これらのツールからコードを作成するには、Authorization ヘッダーを付けて POST /codes に HTTP モジュールからリクエストします。キーはツールの認証情報ストアに保存してください。
- Zapier には QRFLOW.codes アプリが追加されました。Create QR Code、Update QR Code、Find の各ステップと、即時実行される New Scan トリガーは、webhook の設定も API キーも不要です。QRFLOW with Zapier を参照してください。以下の手順は Make、n8n、その他のツール向けです。
- これらのツールでは署名を検証できません。ツールが発行する URL は推測できないため、それが保護手段になります。どこにも公開しないでください。
- リストがすでに Google Sheets にある場合、webhook は不要かもしれません。QRFLOW for Google Sheets アドオンを使うと、API キーなしで、Premium プランにおいて行ごとにコードを作成し、短縮リンクとスキャン数をシートに書き戻せます。Google Sheets アドオン を参照してください。
バイブコーディング
貼り付けて使えるプロンプト
コーディングアシスタントには、最初にルールを伝えると適切なものを作ってもらえます。以下のプロンプトにはルールが含まれています。1 つ選んで貼り付け、角括弧内を埋めると、アシスタントはコードを書く前に Markdown リファレンスを読み込みます。
アプリに QR コードを追加する
Claude、ChatGPT、Cursor、Codex、Windsurf、Copilot Chat: チャットに貼り付けます
Add QR codes to this project using the QRFLOW.codes API.
Read https://qrflow.codes/llms-full.txt before writing code; it is the complete reference.
Rules:
- The API key is in the environment variable QRFLOW_KEY. It must only be used server-side (route handler, server action, edge function). Never expose it to the browser.
- Create dynamic codes: POST https://qrflow.codes/api/v1/codes with { "type": "url", "destination_data": { "url": ... }, "label": ... }.
- Save the returned code.id and code.short_url on my record. short_url is what gets printed or displayed.
- Show the image by proxying GET /codes/:id/image.svg through my server, or by encoding short_url with a QR library on the client.
- Handle errors from the JSON body: { "error", "message" }. Map 402 to "upgrade needed", 429 to a retry with the Retry-After header.
What I want: [describe the feature, e.g. "every event in my events table gets a QR code that opens its public page; show it on the event admin page with a download button"].
リポジトリに QRFLOW を教える
CLAUDE.md、AGENTS.md、.cursorrules、または .github/copilot-instructions.md に追加します
## QR codes (QRFLOW.codes)
- Docs: https://qrflow.codes/llms-full.txt (Markdown), https://qrflow.codes/api/v1/openapi.json (OpenAPI 3.1).
- Base URL https://qrflow.codes/api/v1, header Authorization: Bearer $QRFLOW_KEY. Server-side only.
- Codes are created with POST /codes { type: "url", destination_data: { url }, label }. Store code.id and code.short_url.
- Change the destination with PATCH /codes/:id { destination_data: { url } }. Never change slug/domain_id after printing.
- Image: GET /codes/:id/image.svg (needs the key). Prefer paused: true over DELETE when a print exists.
- Webhooks arrive as POST with X-QRFLOW-Signature (t=,v1=HMAC-SHA256 of "t.rawBody"); verify with the raw body.
Lovable、Bolt、v0、Replit などのアプリビルダーで使う
バックエンド(Supabase、serverless functions)を提供するフロントエンド優先のビルダー
Integrate QRFLOW.codes QR codes. The API refuses browser calls, so create a backend function (Supabase Edge Function / serverless function) that holds the secret QRFLOW_KEY and calls POST https://qrflow.codes/api/v1/codes with { "type": "url", "destination_data": { "url": "<the page URL>" }, "label": "<name>" }. Return code.id and code.short_url to the UI and save them in the database. Render the QR in the UI by encoding short_url with a QR library; add a "Download for print" button that fetches /codes/:id/image.svg through the same backend function. Reference: https://qrflow.codes/llms-full.txt
自分のコードを管理するカスタム GPT
ChatGPT › Create a GPT › Actions
Import from URL: https://qrflow.codes/api/v1/openapi.json
Authentication: API Key › Bearer › paste a Business key with the scopes you want the GPT to have.
Then the GPT can list, create, re-point and report on your codes. For a no-setup version, add the MCP connector instead (Developer mode › Plugins › https://qrflow.codes/mcp).
コネクター接続後に指示する内容
QRFLOW MCP サーバーに接続した Claude、ChatGPT、Claude Code
"Make a QR code for https://example.com/fall-menu, call it Fall menu, frame caption 'Scan for menu'."
"Which of my codes got the most scans this month? Show a breakdown by country for the top one."
"Point the 'Lobby poster' code at https://example.com/events/october."
"Name the 'Business card' code's link 'hi' on my domain."
"Pause every code with 'Summer' in the label."
"Make 40 codes, one per table, going to https://example.com/order?table=1 through 40."
"Show me the PNG of the 'Front door' code."
MCP サーバー
Claude、ChatGPT、Cursor、Claude Code から使う
QRFLOW は https://qrflow.codes/mcp にある MCP サーバーです。一度接続してサインインすれば、「秋のメニューページ用に、ドメイン上で menu という名前の QR コードを作成して」「ロビーのポスターのコードを新しいページに向けて」「先週のチラシのスキャン数を国別に教えて」などと指示できます。アシスタントは、この API と同じツールを同じルールで使い、コードは mcp をソースとしてダッシュボードに作成されます。
開発者でない方は、各アシスタントでの正確な操作手順を含む、わかりやすい説明を AI アシスタントで QR コードを作成する でご覧ください。
Glama による独立したスコア評価と毎時のヘルスチェックを受けており、awesome-remote-mcp-servers ディレクトリと公式 MCP Registry に codes.qrflow/qrflow として掲載されています。
接続する
Customize › Connectors › Add custom connector › アドレスを貼り付けるか、QRFLOW のディレクトリ掲載ページで Connect を押します。Claude が QRFLOW のサインイン画面を開くので、Allow を押します。すべてのプランで利用できます。
https://qrflow.codes/mcp
Settings › Security and login › Developer mode をオンにし、Settings › Plugins › + › アドレスを貼り付けます。求められたらサインインします。Plus、Pro、Team、Enterprise、Edu で利用できます。
https://qrflow.codes/mcp
コマンドを 1 つ実行し、/mcp でサインインします。サインインを省略するには、Business キーをヘッダーとして追加します。
claude mcp add --transport http qrflow https://qrflow.codes/mcp
# or, with a key:
claude mcp add --transport http qrflow https://qrflow.codes/mcp --header "Authorization: Bearer $QRFLOW_KEY"
Cursor、Windsurf、VS Code、その他の MCP クライアント
URL に HTTP サーバーを追加します。OAuth サインインはブラウザーで行います。または、キーを含む Authorization ヘッダーを渡します。
{
"mcpServers": {
"qrflow": { "type": "http", "url": "https://qrflow.codes/mcp" }
}
}
独自のエージェント(Anthropic または OpenAI SDK)
Business キーを bearer として指定し、MCP コネクターまたはツールを URL に接続します。ブラウザーでの認証フローは不要です。
// Anthropic Messages API, MCP connector
mcp_servers: [{ type: "url", url: "https://qrflow.codes/mcp", name: "qrflow", authorization_token: process.env.QRFLOW_KEY }]
アシスタントができること
| ツール | 機能 | スコープ |
|---|---|---|
| list_code_kinds | 各種コード、そのフィールド、必要なプランを一覧表示します。アシスタントは、一般的でないコードを作成する前にこれを呼び出します。 | profile |
| list_domains | リンクドメイン、デフォルトのドメイン、および各 ID を一覧表示します。 | domains:read |
| get_qr_image | アシスタントが表示または保存できる PNG と、印刷用の SVG URL を返します。 | codes:read |
| get_account | アカウントのプラン、機能、上限を返します。 | profile |
安全性の仕組み
- アシスタントが保持するのは、QRFLOW のページであなたが Allow を押した後に発行される、あなた自身のアカウント用トークンだけです。Account › Connected apps からいつでも接続を解除できます。
- トークンは MCP サーバーに紐付けられており、REST API に対して再利用できません。
- すべての書き込みはダッシュボードと同じ検証を通ります。許可リストに登録されたリンク先、プランの確認、公正利用の上限が適用されます。
- 破壊的な操作を行うツールは、動作を慎重に説明します:
delete_qr_codeは、印刷済みのコードがある場合は一時停止を優先するようモデルに指示します。 - ディスカバリードキュメントは
/.well-known/oauth-authorization-serverと/.well-known/oauth-protected-resourceにあります。登録は RFC 7591、PKCE は S256 のみです。
SDK と OpenAPI 仕様
- TypeScript / JavaScript:
npm install qrflow(npm)。依存関係ゼロ、ESM と CommonJS に対応し、型定義も完備。Node 18+、Bun、Deno、Workers で動作します。429 を自動で再試行し、verifyWebhook/parseWebhookを同梱しています。 - Python 3.9+、標準ライブラリのみ:qrflow.py。
- OpenAPI 3.1:/api/v1/openapi.json。Postman または Insomnia にインポートしたり、任意の言語でクライアントを生成したり、ChatGPT Action に追加したりできます。
- どちらのクライアントも型付きエラー(
QRFlowError、status、code、message、retryAfterを含む)をスローし、Webhook 検証機能を同梱しています。単一ファイルの TypeScript ソースは /sdk/qrflow.ts にもあります。こちらをベンダーとして取り込むこともできます。
| TypeScript | Python | 呼び出し |
|---|---|---|
| me() | me() | GET /me |
| catalog() | catalog() | GET /catalog |
| listCodes({ limit, q }) | list_codes(limit, q) | GET /codes |
| getCode(id) | get_code(id) | GET /codes/:id |
| createCode(input) | create_code(**fields) | POST /codes |
| updateCode(id, patch) | update_code(id, **patch) | PATCH /codes/:id |
| deleteCode(id) | delete_code(id) | DELETE /codes/:id |
| makeDynamic(id) | make_dynamic(id) | POST /codes/:id/dynamic |
| scans(id, { from, to, group }) | scans(id, from_, to, group) | GET /codes/:id/scans |
| bulkCreate(rows, colors) | bulk_create(rows, **colors) | POST /codes/bulk |
| domains() | domains() | GET /domains |
| listWebhooks() / createWebhook() / testWebhook(id) / deleteWebhook(id) | list_webhooks() / create_webhook() / test_webhook(id) / delete_webhook(id) | /webhooks |
| imageUrl(id, size) | image_url(id, size) | 画像アドレス(キーを使って取得) |
| verifyWebhook(raw, header, secret) | verify_webhook(raw, header, secret) | 配信の署名チェック |
エンドポイントリファレンス
ベース URL https://qrflow.codes/api/v1。リクエスト本文とレスポンスは JSON です。日付は UTC の ISO 8601 形式です。PATCH では変更するフィールドだけを送信してください。
GETprofile
このアカウントに適用されるプラン、機能フラグ、制限、およびキーのスコープ。
curl https://qrflow.codes/api/v1/me \
-H "Authorization: Bearer $QRFLOW_KEY"
{ "id": "…", "email": "ops@example.com", "plan": "business", "paid": true,
"features": { "dynamic_codes": true, "custom_domain": true, "link_names": true, "gs1": true, "api_keys": true },
"limits": { "saved_codes": 25000, "bulk_per_month": 10000, "bulk_per_request": 2000, "link_domains": 5, "requests_per_minute": 600 },
"auth": "api_key", "scopes": ["codes:read", "codes:write"] }
GETpublic
ネイティブ型(url、wifi、vcard、email、phone、sms、text、location)と、50 種類ほどのサブタイプ(Instagram、Google review、Wi-Fi、app store など)。それぞれに必要なフィールドと必要なプランが示されます。キーは不要です。
curl https://qrflow.codes/api/v1/catalog
GETcodes:read
新しいものから順に表示します。?limit= は最大 100、?q= はラベルを検索します。
curl "https://qrflow.codes/api/v1/codes?limit=20&q=menu" \
-H "Authorization: Bearer $QRFLOW_KEY"
POSTcodes:write
サイトの Save と同じルールです。有料プランでは url、phone、email、sms、location のコードは動的になります。Wi-Fi、vCard、text はパターンにコンテンツを含みます。Google review コードなどを作成するには、サブタイプ ID を destination_data.subtype に指定します。省略可能な domain_id で、コードに表示するリンクドメインを選択できます(GET /domains で一覧を取得できます)。
curl -X POST https://qrflow.codes/api/v1/codes \
-H "Authorization: Bearer $QRFLOW_KEY" \
-H "Content-Type: application/json" \
-d '{ "type": "url", "destination_data": { "url": "https://example.com/menu" }, "label": "Table tents", "frame_style": "caption-below", "frame_caption": "Scan for menu" }'
{ "code": { "id": "…", "label": "Table tents", "kind": "url", "dynamic": true, "short_code": "x7k2p9a",
"short_url": "https://go.example.com/x7k2p9a", "scans": 0, "image_url": "https://qrflow.codes/api/v1/codes/…/image.svg", … } }
GETcodes:read
スキャン数、短縮リンク、画像アドレスを含むコード。
curl https://qrflow.codes/api/v1/codes/$ID \
-H "Authorization: Bearer $QRFLOW_KEY"
PATCHcodes:write
指定できる項目:destination_data(動的コードのみ。印刷物はそのまま有効)、label、paused、expires_at(ISO または null)、slug(ドメイン上のリンク名)、domain_id(コードに表示するリンクドメイン。null = アカウントのデフォルト)、fg_color、bg_color、frame_style、frame_caption、frame_caption2。変更するフィールドだけを送信してください。
curl -X PATCH https://qrflow.codes/api/v1/codes/$ID \
-H "Authorization: Bearer $QRFLOW_KEY" \
-H "Content-Type: application/json" \
-d '{ "destination_data": { "url": "https://example.com/menu-fall" }, "slug": "menu" }'
DELETEcodes:write
スキャン履歴も含めて完全に削除されます。動的コードの印刷済みリンクは解決されなくなります。印刷物がまだ出回っている場合は、代わりに paused: true を指定してください。
curl -X DELETE https://qrflow.codes/api/v1/codes/$ID \
-H "Authorization: Bearer $QRFLOW_KEY"
204 No Content
POSTcodes:write
印刷されるパターンが変わり(短縮リンクをエンコードするようになります)、その後に画像を再レンダリングする必要があります。
curl -X POST https://qrflow.codes/api/v1/codes/$ID/dynamic \
-H "Authorization: Bearer $QRFLOW_KEY"
GETcodes:read
フレームと色を含む印刷用 SVG。?size= でモジュールグリッドの幅を px 単位で指定します。ファイルはどのみち劣化なく拡大縮小できます。
curl https://qrflow.codes/api/v1/codes/$ID/image.svg \
-H "Authorization: Bearer $QRFLOW_KEY" -o code.svg
GETanalytics:read
?from= と ?to=(ISO 日付、最大 92 日間。デフォルトは直近 30 日間)、および ?group= day、device、country、city、browser、os、referrer。分析ページと同じ数値です。
curl "https://qrflow.codes/api/v1/codes/$ID/scans?from=2026-09-01&to=2026-09-21&group=day" \
-H "Authorization: Bearer $QRFLOW_KEY"
{ "code_id": "…", "from": "…", "to": "…", "group": "day", "total": 412,
"rows": [ { "key": "2026-09-01", "scans": 18 }, { "key": "2026-09-02", "scans": 25 }, … ] }
POSTcodes:write
1 回の呼び出しで最大 2,000 件の URL コードを作成でき、すべて動的になります。Bulk ページと同じ月間一括作成枠を消費します(Business では 10,000 件)。Web アドレスでない行は rejected に返され、それ以外は作成されます。
curl -X POST https://qrflow.codes/api/v1/codes/bulk \
-H "Authorization: Bearer $QRFLOW_KEY" \
-H "Content-Type: application/json" \
-d '{ "rows": [ { "destination": "https://example.com/t/1", "label": "Table 1" }, { "destination": "https://example.com/t/2", "label": "Table 2" } ] }'
{ "codes": [ … ], "rejected": [], "remaining_this_month": 9998 }
GETcodes:read
小売パッケージに使用するコード。各商品は 1 つの GTIN、パッケージに印刷されたアドレス、およびその背後にあるリンクで構成されます。?q= で名前と GTIN を検索できます。Business プランが必要です。
curl https://qrflow.codes/api/v1/products \
-H "Authorization: Bearer $QRFLOW_KEY"
{ "products": [ { "gtin": "00860001234565", "name": "Wildflower Honey 12 oz",
"digital_link": "https://id.example.com/01/00860001234565",
"page_url": "https://id.example.com/p/00860001234565",
"links": [ { "link_type": "gs1:pip", "url": "…", "is_default": true, "batch": null } ] } ] }
POSTcodes:write
gtin と name は必須です。brand と url は省略可能です。書き込み前にチェックデジットが検証され、8、12、13、14 桁の形式はすべて 14 桁に正規化されます。すでに登録済みの GTIN を指定すると、2 つ目の商品は作成されず 409 が返されます。
curl -X POST https://qrflow.codes/api/v1/products \
-H "Authorization: Bearer $QRFLOW_KEY" -H "Content-Type: application/json" \
-d '{"gtin":"00860001234565","name":"Wildflower Honey 12 oz","brand":"Sunny Acres","url":"https://sunnyacres.example/honey"}'
{ "product": { "gtin": "00860001234565", "digital_link": "https://id.example.com/01/00860001234565", … } }
PUTcodes:write
1 つの GTIN から、用途を示すラベル付きの複数の場所へ同時にリンクできます。電話はデフォルトを取得し、タイプを指定するアプリはそのタイプのリンクを取得します。冪等です。同じ link_type と batch を渡すと、そのリンクが置き換えられ、重複して追加されることはありません。そのため、夜間スクリプトを 2 回実行しても問題ありません。batch を渡すとリンクを 1 つのロットに限定できます。これにより、残りのロットに触れずにリコール情報を公開できます。
curl -X PUT https://qrflow.codes/api/v1/products/00860001234565/links \
-H "Authorization: Bearer $QRFLOW_KEY" -H "Content-Type: application/json" \
-d '{"link_type":"gs1:recallStatus","url":"https://sunnyacres.example/recall-a42","title":"Recall notice","batch":"A42","is_default":true}'
GETanalytics:read
直近 ?days= 日間(1~365、デフォルトは 30 日間)の GTIN ごとの件数を、国、デバイス、リンクタイプ、batch 別に集計します。went_nowhere は、遷移先が見つからなかったスキャン数です。0 であるべきです。
curl "https://qrflow.codes/api/v1/products/00860001234565/scans?days=30" \
-H "Authorization: Bearer $QRFLOW_KEY"
{ "gtin": "00860001234565", "days": 30, "total": 412, "went_nowhere": 0,
"by_link_type": [ { "key": "gs1:pip", "scans": 390 }, { "key": "gs1:recallStatus", "scans": 22 } ],
"by_batch": [ { "key": "A42", "scans": 22 } ] }
GETdomains:read
接続済みドメイン、そのステータス、および動的コードの印刷にデフォルトで使われるドメイン(default_base)。別のドメインでコードを印刷するには、そのドメインの ID をコードの domain_id として渡します。
curl https://qrflow.codes/api/v1/domains \
-H "Authorization: Bearer $QRFLOW_KEY"
GETwebhooks:manage
イベント、直近のステータス、失敗回数を含む Webhook 一覧。
curl https://qrflow.codes/api/v1/webhooks \
-H "Authorization: Bearer $QRFLOW_KEY"
POSTwebhooks:manage
url は公開ホスト上の https である必要があります。events には scan、code.created、code.updated、code.deleted のいずれかを指定します。署名シークレットは一度だけ返されます。
curl -X POST https://qrflow.codes/api/v1/webhooks \
-H "Authorization: Bearer $QRFLOW_KEY" \
-H "Content-Type: application/json" \
-d '{ "url": "https://example.com/hooks/qrflow", "events": ["scan", "code.updated"] }'
{ "webhook": { "id": "…", "url": "…", "events": ["scan", "code.updated"], "active": true, "secret": "whsec_…" } }
POSTwebhooks:manage
署名付き ping をただちに送信し、レスポンスを報告します。
curl -X POST https://qrflow.codes/api/v1/webhooks/$WEBHOOK_ID \
-H "Authorization: Bearer $QRFLOW_KEY"
DELETEwebhooks:manage
キューに入った再試行も含め、すべての配信を停止します。
curl -X DELETE https://qrflow.codes/api/v1/webhooks/$WEBHOOK_ID \
-H "Authorization: Bearer $QRFLOW_KEY"
204 No Content
GETpublic
フレーム ID と、それぞれに必要な項目(キャプション、2 行目)をカスタマイザーと同じ分類で表示します。キーは不要です。
curl https://qrflow.codes/api/v1/frames
Code オブジェクト
コードを扱うすべてのエンドポイントは、同じ形式を返します。不明なフィールドは無視してください。新しいフィールドは随時追加されます。
| フィールド | 型 | 意味 |
|---|---|---|
| id | uuid | 固定 ID。他のすべての呼び出しで使用します。 |
| label | string | null | ダッシュボード上の名前。最大 120 文字。?q= で検索できます。 |
| kind | string | カタログ ID:url、wifi、instagram、googlereview,... kind_label は人間向けの名前です。 |
| type | string | エンコード形式:url、text、wifi、vcard、email、phone、sms、location。 |
| destination_data | object | 送信したフィールド(および kind 用の subtype)。destination はその概要を 1 行で示します。 |
| dynamic | boolean | スキャンが QRFLOW を経由し、遷移先を変更できる場合は true。dynamic_capable は、有料プランでこのタイプを動的にできるかどうかを示します。 |
| short_code | string | 7 文字。変更されません。 |
| short_url | string | 動的コードに印刷する URL。設定されている場合はドメインと slug を含みます。 |
| domain_id | uuid | null | このコードに表示するリンクドメイン。null はアカウントのデフォルトを意味します。 |
| fg_color, bg_color | hex | モジュールと背景の色。 |
| has_logo | boolean | ダッシュボードでロゴが追加されています。image.svg に含まれます。 |
| frame_style, frame_caption, frame_caption2 | string | null | カスタマイザーと同じフレーム ID とキャプション。 |
| scans | integer | 累計スキャン数。 |
| created_at, updated_at | ISO 8601 | UTC。 |
| manage_url | url | ダッシュボード上のコードのページ。「Open in QRFLOW」リンクに使用します。 |
| image_url | url | GET /codes/:id/image.svg。Authorization ヘッダーが必要です。公開画像 URL ではありません。 |
| svg_download_url, png_download_url | url | 同じ SVG(フレーム、色、ロゴを含む)と、署名付きリンクで取得できるプレーンな PNG。ヘッダーなしで 24 時間有効です。<img> タグ、スクリプト、アシスタントでファイルを保存する場合に使います。download_expires_at は有効期限を示します。コードを読み取るたびに新しいリンクが返されます。 |
その他の形式:Scans(code_id, from, to, group, total, rows[key, scans])、Domain(id, host, status, active, is_default, verified_at, grace_until)、Webhook(id, url, events, active, last_status, last_delivery_at, consecutive_failures、さらに secret が 1 つ)、Me(id, email, plan, paid, features, limits, auth, scopes)、および Error(error, message)。すべてのプロパティの型は OpenAPI ドキュメントに記載されています。
Business
Webhook
イベントが発生すると、QRFLOW は指定した https URL を呼び出します。Account › Webhooks から、または POST /webhooks で作成できます。署名シークレットは一度だけ取得できます。1 アカウントにつき最大 10 個です。
| イベント | 発生タイミング | data |
|---|---|---|
| scan | 数分ごとにまとめて送信されます。前回の配信以降の新しいスキャンをすべて含み、1 回あたり最大 500 件です。 | count、from、to、code_id、label、short_code、slug、scanned_at、device、country、city、referrer、browser、os、language を含む scans[] |
| code.created | API とアシスタントからは即時、ダッシュボードからは数分以内に送信されます。一括リクエストでは bulk: true と codes[] を含むイベントが 1 件送信されます。 | code、source |
| code.updated | 同じタイミングで送信されます。遷移先、ラベル、一時停止、期限、リンク名、ドメイン、色、フレーム、動的コードへの変換が対象です。 | code、changed[](変更されたフィールド名) |
| code.deleted | 同じタイミングで送信されます。 | code: { id, label, short_code, slug } |
| ping | Test を押したときに送信されます。 | webhook_id、message |
受信する内容
すべてのペイロードは { id, event, created_at, data } です。id は 1 回の配信の再試行を通じて変わらないため、これを使って重複を排除できます。
{
"id": "9b1c6d2e-…",
"event": "scan",
"created_at": "2026-09-21T18:05:00.000Z",
"data": {
"count": 2,
"from": "2026-09-21T18:00:00.000Z",
"to": "2026-09-21T18:04:12.331Z",
"scans": [
{ "code_id": "…", "label": "Table tents", "short_code": "x7k2p9a", "slug": "menu", "scanned_at": "2026-09-21T18:03:40.101Z",
"device": "mobile", "country": "US", "city": "Las Vegas", "referrer": null, "browser": "Safari", "os": "iOS", "language": "en-US" },
{ "code_id": "…", "label": "Table tents", "short_code": "x7k2p9a", "slug": "menu", "scanned_at": "2026-09-21T18:04:12.331Z",
"device": "mobile", "country": "MX", "city": "Tijuana", "referrer": null, "browser": "Chrome", "os": "Android", "language": "es-MX" }
]
}
}
{
"id": "2f0a…",
"event": "code.updated",
"created_at": "2026-09-21T18:06:00.000Z",
"data": {
"code": { "id": "…", "label": "Table tents", "kind": "url", "dynamic": true, "short_url": "https://go.example.com/menu", "scans": 412, "…": "…" },
"changed": ["destination_data"]
}
}
POST /your/endpoint HTTP/1.1
Content-Type: application/json
User-Agent: QRFLOW-Webhooks/1.0 (+https://qrflow.codes/developers)
X-QRFLOW-Event: scan
X-QRFLOW-Signature: t=1758477900,v1=5f1c…e9
署名の検証
X-QRFLOW-Signature: t=<unix seconds>,v1=<hex>。シークレットを使って ${t}.${rawBody} に対する HMAC-SHA256 を計算し、v1 と定数時間で比較します。t が 5 分以上古い場合は拒否してください。受信した生のバイト列を使い、オブジェクトを再シリアライズしたものは使わないでください。Next.js と Python 用の動作する受信処理はレシピにあり、どちらの SDK にもヘルパーが含まれています。
配信ルール
- 8 秒以内に任意の 2xx を返してください。処理はレスポンス後に行います。
- それ以外のレスポンスは、1、5、15、60、240、720 分後に再試行されます。
- 20 回連続で失敗すると Webhook がオフになり、アカウント所有者にメールが送信されます。受信処理を修正したら再度オンにしてください。キューに入った再試行は再開されます。
- URL は公開ホスト上の https である必要があります。localhost、プライベート範囲、qrflow.codes 自体は拒否されます。開発中はトンネルを使用してください。
- Test を押すと、署名付きの
pingを受信し、サーバーが返したステータスを確認できます。
エラー
すべてのエラーは { "error": "<code>", "message": "<what to do>" } で、以下のステータスを伴います。メッセージは人向けに書かれているため、そのまま表示してください。
| ステータス | error | 意味 |
|---|
症状、原因、対処法
トラブルシューティング
すべての呼び出しで 401 invalid_token が返る
原因ヘッダーが間違っているか、キーが有効ではありません。
対処法Authorization: Bearer qrf_live_… の形式で正確に指定してください(コロンではなくスペースを使います)。Account › API keys でキーが取り消されていないか確認してください。チャットやドキュメントからコピーした場合は、末尾のピリオドやスマートクォートに注意してください。
MCP サーバーでは使えるトークンなのに /api/v1 で 401 が返る
原因https://qrflow.codes/mcp 用に発行されたトークンは、そのサーバーに紐付けられています。
対処法REST には API キーを使うか、resource= を指定せずに 2 回目の OAuth フローを実行して REST API 用のトークンを取得してください。
キーまたは Webhook の作成時に 402 upgrade_required が返る
原因どちらも Business の機能です。
対処法/pricing でアップグレードするか、サインインを通じてすべてのプランで使える MCP サーバーを使用してください。
OAuth アプリから POST /codes を実行すると 402 が返る
原因ユーザーのプランには、アプリが要求した機能(動的コード、ドメイン)が含まれていません。
対処法まず GET /me features を読み取り、状況に応じて対応してください。コードを作成する(Free では静的になります)か、必要なプランをユーザーに伝えます。
403 insufficient_scope
原因スコープはキーの作成時に固定されます。 Fix必要なスコープを持つ新しいキーを作成し、古いキーを失効させてください。OAuth の場合は、authorize リクエストでスコープを要求してください。
PATCH destination_data で 400 not_dynamic が返る
Whyコードが静的です。Wi-Fi/vCard/テキスト形式のコードか、Free プランで無料の動的コードをすでに1つ使った後に作成したコードです。
Fixurl/phone/email/sms/location の場合、アカウントに利用枠がある間に POST /codes/:id/dynamic を実行し、再ダウンロードして再印刷してください(画像が変わります)。Wi-Fi、vCard、テキストは動的にできません。代わりに、ページを開く url コードを作成してください。
slug を設定すると 400 no_domain が返る
Whyリンク名は独自ドメイン上に作成されます。
Fixまず Account ページでドメインを接続して認証してください。qrflow.codes/q では、パスは常に short_code です。
slug で 409 conflict が返る
Why別のコードがその名前を使っています。
FixGET /codes?q= で検索するか、別の名前を選んでください。名前はアカウントごとに設定され、全体で一意ではありません。
ブラウザーのコンソールに CORS エラーが表示される
WhyAPI が受け付けるのはサーバー間の呼び出し(および Canva)のみです。これは意図的な仕様です。Web ページにキーを置くと漏洩します。
Fix呼び出しを route handler、server action、edge function、またはバックエンドに移し、ページからそこを呼び出してください。
画像に QRFLOW のマークが表示される
Whyサインインしていないユーザーが作成したコードです。このマークは匿名ダウンロードにのみ付きます。
FixFree を含むどのアカウントでもマークは消えます。保存済みコードの画像には付きません。
ドメインを追加した後も short_url が qrflow.codes/q/… のまま
Whyドメインがまだ認証されていないか、CNAME が正しくありません。
FixAccount ページまたは GET /domains でステータスを確認してください(status が verified である必要があります)。認証されると、既存のコードも自動的に切り替わります。
<img> タグで image_url が 401 を返す
WhyAuthorization ヘッダーが必要ですが、<img> からは送信できません。
Fix同じ Code オブジェクトにある svg_download_url または png_download_url を使ってください。ヘッダーなしで24時間使える署名付きリンクです。永続的に使う場合は、サーバー経由で image_url をプロキシする(Next.js のレシピを参照)か、short_url を自分でエンコードしてください。
SVG ではなく PNG が必要
WhySVG にはフレームとロゴが含まれますが、PNG はコードのみです。
FixGET /codes/:id/image.png(bearer または署名付き png_download_url)を使うと、256~2048 px の PNG が返されます。フレーム付き PNG が必要な場合は、sharp または resvg で SVG を変換してください(sharp(svgBuffer).png().toBuffer())。
アシスタントが画像エンドポイントに拒否され、コードを自分で描画した
Whybearer が必要な image_url を取得しようとしました。
Fixすべてのコードに png_download_url と svg_download_url が含まれるようになり、get_qr_image もこれらを返します。アシスタントはサインインなしで curl できます。同じ short_url をエンコードするローカル生成のコードも引き続き使え、スキャンも記録されますが、フレームとロゴは付きません。
Webhook が届かない
WhyURL のルールか、受信側に問題があります。
FixURL は公開ホスト上の https である必要があります(localhost、プライベート IP、qrflow.codes は不可)。Webhook の Test を押すと、サーバーが返したステータスが表示されます。スキャンイベントはまとめて送信され、最大で約5分かかることがあります。ダッシュボードからの code.* イベントも数分間キューに入りますが、API と MCP による書き込みはすぐに配信されます。
署名を検証できない
Why再シリアライズした本文に対して署名を検証しています。
FixJSON を解析する前に、受信した正確な生バイト列を使って検証してください。Express ではそのルートで express.raw({ type: 'application/json' }) を使います。Next.js App Router では await req.text()、Flask では request.get_data() を使います。その後、${t}.${raw}\ の HMAC-SHA256 を計算してください。
Webhook が勝手にオフになった
Why連続して20回失敗しました。
Fix受信側を修正してから、再び有効にしてください(Account › Webhooks、または削除して再作成)。発生時にメールが届いています。キューに入った再試行は再開されます。
Webhook が重複して届く
Why応答に時間がかかり(8秒超)、2xx が返らない場合は失敗とみなされ、再試行されます。
Fixまず応答し、その後に処理してください。再試行の間も変わらない、ペイロードの id で重複を排除してください。
インポート中に 429 rate_limited が返る
Whyキーごとに1分あたり600リクエストまでです。
Fixコードごとに POST する代わりに POST /codes/bulk(1リクエストで2,000コード)を使うか、Retry-After の秒数だけ待ってください。
コードを削除したら、印刷済みポスターに「Code not found」と表示される
Why削除は取り消せず、リンクも無効になります。
Fix元に戻す方法はありません。次回は PATCH { paused: true } を使ってください。一時停止中のコードには案内ページが表示され、再開できます。
ダウングレード後にキーが使えなくなった
WhyBusiness を解約してから30日間はキーを使えますが、その後は 402 が返ります。
Fix再登録してください。何も削除されておらず、同じキーを再び使えます。
一覧にない問題がありますか?正確なリクエストと返された JSON エラーを添えて、hello@qrflow.codes までご連絡ください。Business アカウントは優先対応されます。
制限と公正利用
| 制限 | |
|---|---|
| キーごとの1分あたりのリクエスト数 | 600. 超過すると Retry-After 付きの 429 が返ります。 |
| アカウントごとのキー数 | 10 |
| アカウントごとの Webhook 数 | 10 |
| 保存済みコード(公正利用) | Premium は1,000、Business は25,000。API はその2倍で停止します。 |
| Bulk | Premium は月500件(1リクエストあたり500件)、Business は月10,000件(1リクエストあたり2,000件)。 |
| リンクドメイン | Premium は1、Business は5 |
| スキャン | 無制限。Premium はコードごとに月100,000スキャン、Business は1,000,000スキャンで確認メールが届きます。スロットリングはありません。 |
| スキャン分析の期間 | リクエストごとに92日 |
| リストのページサイズ | 100 (?limit=) |
| ラベル / キャプション / slug | 120 / 60 / 40文字 |
| Webhook のタイムアウトと再試行 | 8秒。1、5、15、60、240、720分後に再試行。連続20回失敗するとオフになります。 |
| Business 解約後 | キーと Webhook は30日間使えますが、その後は 402 が返ります。何も削除されません。 |
公正利用の上限は、プラン料金に含まれる利用量です。この数値でスロットリングされることはありません。API はその2倍で停止し、その前に担当者からメールで連絡します。さらに多くの利用をご希望の場合は、hello@qrflow.codes までご連絡ください。
あなたとスキャンする人のためのセキュリティ
QRFLOW がアカウントを保護する方法
- キーは一度だけ表示され、SHA-256 ハッシュとして保存されます。QRFLOW の担当者もキーを読み戻せません。紛失した場合は新しいキーを作成してください。
- すべてのリクエストは、キーが属するアカウントに限定されます。別のアカウントのコード ID は404になり、情報が漏れることはありません。
- スコープはキーごとに固定されるため、レポート用ダッシュボードのキーでコードを作成したり削除したりすることはできません。
- キーごとに1分あたり600リクエストまでです。超過すると、全員の処理が遅くなるのではなく、明確な 429 が返ります。
- 遷移先は許可リストで管理されています。http、https、mailto、tel、sms、geo と、限られたアプリ用スキーム(whatsapp、tg、signal、spotify、アプリストア)が許可されます。javascript:、data:、file: は作成時に拒否されるため、連携が侵害されてもコードを攻撃に利用できません。
- Webhook URL は公開ホスト上の https である必要があります。QRFLOW がプライベートネットワークや自身にリクエストすることはありません。すべての配信に署名が付き、すべてのペイロードに安定した ID が含まれます。
- OAuth クライアントは PKCE S256 で登録され、トークンは発行先のサーバーに紐付けられます。MCP サーバー用のトークンを REST API で再利用することはできません。
- Account ページから誰でもキーを失効させたり、アプリの接続を解除したりできます。変更はすぐに反映されます。
あなたが行うこと
- キーはソースコードではなく、環境変数に保存してください。キーが git の履歴に入った場合は失効させてください。
- サーバー側でのみ使用してください。API はブラウザーからのオリジンを拒否しますが、API をラップする独自のエンドポイントにも認証が必要です。そうしないと、誰でもあなたの請求でコードを作成できます。
- 連携ごとに必要なスコープだけを持つ専用キーを作成し、連携名を付けてください。キーを失効させたときの影響を、その連携だけに限定できます。
- Webhook の署名を検証し、5分より古いタイムスタンプは拒否してください。
- ユーザーのデータをラベルや遷移先に含める場合、QRFLOW に保存されることを忘れず、可能な限りラベルに個人データを含めないでください。
スキャンで記録される情報と、記録されない情報
- リダイレクトごとに、リクエストから取得したデバイスの種類、国、都市、リファラー、ブラウザー、オペレーティングシステム、言語と、コード + 日付 + IP + ユーザーエージェントの一方向ハッシュが保存されます。これにより所有者はユニーク訪問者数を集計できます。ハッシュからアドレスを復元することはできません。
- スキャンした人に Cookie は設定されず、IP アドレス自体もスキャン情報と一緒には保存されません。既知のボットやリンクプレビュー用クローラーは除外されます。
- コードを削除すると、そのスキャン情報も削除されます。アカウントを削除すると、すべてが削除されます。
- 全文:https://qrflow.codes/privacy および https://qrflow.codes/terms.
バージョン管理と安定性
API のバージョンはパスで指定します:/api/v1。v1 ではフィールド、エンドポイント、種類、イベントを追加しますが、削除や名前変更は行いません。レスポンスに未知のフィールドがあっても、コードで無視してください。
v1 に破壊的変更が必要になった場合は、/api/v2 としてリリースし、v1 は少なくとも12か月間稼働し続けます。キーの所有者には、非推奨化の90日前にメールで通知します。
MCP サーバーのツールも同じルールに従います。引数は追加のみで、すべてのツール名は維持されます。
/api/v1/openapi.json の OpenAPI ドキュメントと /llms-full.txt の Markdown は、API を提供するコードから生成されるため、現在稼働中の仕様を記述しています。
開発者からよくある質問
QRFLOW API を使うには料金が必要ですか?
API キーは月額29ドルの Business プランで利用できます。MCP サーバー(Claude、ChatGPT、Cursor、Claude Code)と独自アプリ向けの OAuth は、どのプランでもサインインして利用でき、作成できる内容はプランに従います。GET /catalog、GET /frames、/preview.svg はキーなしで利用できます。
API で QR コードを無料で生成できますか?
キーを使った場合はできません。静的な画像だけであれば、qrflow.codes の無料ジェネレーターやオープンソースの QR ライブラリで十分です。API は動的コード、独自ドメイン、分析、bulk、Webhook 向けで、これらは有料アカウントの機能です。
ブラウザーから API を呼び出せますか?
いいえ。キーが Web ページに漏れないよう、ブラウザーからのオリジンを拒否します。route handler、server action、edge function、またはバックエンドから API を呼び出し、ページからはそれらを呼び出してください。
どの画像形式を利用できますか?
色、フレーム、キャプション、ロゴを含む SVG(GET /codes/:id/image.svg、標準サイズ256~4096 px)と、コードのみの PNG(GET /codes/:id/image.png、256~2048 px)を利用できます。どちらも bearer を使うか、各 Code オブジェクトに含まれる署名付き svg_download_url / png_download_url を使えます。署名付き URL はヘッダーなしで24時間使えます。MCP ツールの get_qr_image は PNG をインラインで返し、両方のリンクも返します。
印刷後に QR コードを変更できますか?
動的コード(有料プランの url、phone、email、sms、location)であれば可能です。新しい destination_data を指定して PATCH /codes/:id を実行してください。画像は変わらず、次のスキャンから新しい場所に移動します。Wi-Fi、vCard、テキストコードは画像に内容が含まれるため、変更できません。
short_url と遷移先の違いは何ですか?
short_url は画像内のリンクです(go.example.com/menu)。遷移先は、そのリンクからリダイレクトされる場所です(https://example.com/menu-fall)。short_url は一度印刷すれば、遷移先は何度でも変更できます。
独自ドメインをコードに使えますか?
はい。Premium は1ドメイン、Business は5ドメインを接続できます。CNAME を追加し、Account ページで認証してください。Business では domain_id を指定してコードごとにドメインを選べます。リンク名(slug)を使うと、読みやすいパスを作成できます。
スキャンした人について、スキャン記録には何が保存されますか?
リクエストから取得したデバイスの種類、国、都市、リファラー、ブラウザー、オペレーティングシステム、言語と、ユニーク訪問者数の集計に使う一方向の日次ハッシュです。Cookie は使わず、IP アドレスも保存されません。グラフを作成するには十分ですが、個人を特定するには不十分です。詳細:https://qrflow.codes/privacy#scans
npm または PyPI パッケージはありますか?
npm:npm install qrflow\(https://www.npmjs.com/package/qrflow)。依存関係はなく、ESM と CommonJS に対応し、TypeScript の型定義を完備しています。Node 18+、Bun、Deno、Workers で動作します。すべてのエンドポイントをラップし、429 を再試行し、verifyWebhook/parseWebhook も含みます。Python:https://qrflow.codes/sdk/qrflow.py に単一ファイルのクライアントがあります(標準ライブラリのみ)。verify_webhook を含みます。PyPI パッケージも今後公開予定です。
Claude、ChatGPT、Cursor、Claude Code で使えますか?
はい。QRFLOW は https://qrflow.codes/mcp. にある MCP サーバーです。コネクターとして追加し、一度サインインすれば、自然な言葉で指示できます。作成、編集、一時停止、名前設定、bulk、分析、画像、ドメインを扱う11個のツールがあります。
自分のユーザーが QRFLOW アカウントをアプリに接続できますか?
はい、OAuth 2.0 を使います。/api/oauth/register でクライアントを登録し(アカウントは不要)、PKCE を使ってユーザーを /oauth/authorize に誘導し、そのユーザーのトークンで API を呼び出します。コードはユーザーのプランに応じて、そのアカウントに保存されます。
localhost で Webhook をテストするには?
トンネル(cloudflared または ngrok)を使って開発サーバーを公開し、その https アドレスを Webhook URL として設定します。次に、Account › Webhooks で Test を押すと、署名付きの ping を受信できます。Webhook URL は公開された https アドレスである必要があります。localhost とプライベートアドレスは拒否されます。
Business を解約すると、連携機能はどうなりますか?
キーと Webhook は 30 日間動作し、その後は 402 を返します。コード、スキャン、ドメインはアカウントに残ります。再登録すると、同じキーですべてが再び有効になります。
API で Google レビュー、Instagram、Wi-Fi、PDF のコードを作成するには?
GET /catalog で、各種コードとそのフィールドを確認できます。次に、コードの種類に応じた type と fields を指定して POST /codes を呼び出し、次の種類では subtype を追加します: { type: 'url', destination_data: { subtype: 'googlereview', placeId: 'ChIJ…' } }, { type: 'wifi', destination_data: { ssid, password, encryption: 'WPA' } }, { type: 'url', destination_data: { subtype: 'instagram', handle: 'acme' } }。
API でコードにロゴをアップロードできますか?
まだできません。ダッシュボードでロゴを追加してください。image.svg にロゴが含まれ、has_logo でロゴの有無を確認できます。色、フレーム、キャプションはすべて API で設定できます。
API は安定していますか?
v1 では追加のみを行い、削除や名前の変更は行いません。破壊的変更は v2 として提供し、v1 は少なくとも 12 か月間維持します。また、メールで 90 日前に通知します。
エージェント、ツール、およびこのドキュメントを読むアシスタント向け
機械可読形式
このページのすべての情報は、ソフトウェアが取得できる形式でも提供されています。すべて API を提供するコードから生成されるため、常に最新です。
| URL | 内容 | |
|---|---|---|
| llms-full.txt | https://qrflow.codes/llms-full.txt | このリファレンス全体を Markdown で収録しています。概念、すべてのエンドポイント、すべての MCP ツール、レシピ、トラブルシューティング、FAQ が含まれます。このページと同じソースから生成されています。 |
| developers.md | https://qrflow.codes/developers.md | 同じドキュメントです。a.md を取得するツール向けです。 |
| llms.txt | https://qrflow.codes/llms.txt | アシスタント向けのサイトインデックスで、このページを案内しています。 |
| API の概要 | https://qrflow.codes/qr-code-api | API の機能、クライアントサイドライブラリが適している場合、料金について説明します。実装ではなく判断に役立つ、このリファレンスの簡潔な概要です。 |
| openapi.json | https://qrflow.codes/api/v1/openapi.json | OpenAPI 3.1 形式です。Postman、Insomnia、コードジェネレーター、または ChatGPT Action にインポートできます。 |
| MCP server | https://qrflow.codes/mcp | Streamable HTTP、動的登録による OAuth、または bearer としての Business キーに対応しています。 |
| server.json | https://qrflow.codes/.well-known/mcp/server.json | MCP レジストリのマニフェストです。 |
| OAuth discovery | https://qrflow.codes/.well-known/oauth-authorization-server | RFC 8414 メタデータです。保護リソースのドキュメントも隣にあります。 |
| npm package | https://www.npmjs.com/package/qrflow | npm install qrflow。型付きクライアント、依存関係ゼロ、Webhook 検証機能を備えています。Python の単一ファイルクライアント: https://qrflow.codes/sdk/qrflow.py. |
| GitHub | https://github.com/nativecodeapps/qrflow-sdk | クライアント、OpenAPI スナップショット、Next.js、Workers、Express、FastAPI、Flask の Webhook 用実行可能サンプルを提供しています。Issue と PR を歓迎します。 |
質問、アイデア、追加してほしいコードの種類については、hello@qrflow.codes までご連絡ください。利用規約: /terms。プライバシー: /privacy。