QRFLOW.codes
resmiBuat kode QR, arahkan ulang kode dinamis yang tercetak, beri nama tautan di domain Anda sendiri, dan baca analitik pemindaian.
Apa yang bisa Anda lakukan dengan QRFLOW Codes MCP?
- Buat kode QR dinamis — Minta asisten membuat kode
urldengandestination_datadan mengembalikanshort_urluntuk dicetak. - Ubah tujuan kode yang sudah dicetak — Ubah tujuan pengalihan kode dinamis yang sudah ada tanpa mencetak ulang, karena gambar menyimpan
short_url. - Jeda atau kedaluwarsakan kode — Atur
paused: trueatau tanggal akhir alih-alih menghapusnya, agar tautan yang sudah dicetak berhenti mengalihkan dengan aman. - Baca analitik pemindaian — Ambil total
Scanssepanjang masa atau perincian per hari, negara, dan perangkat untuk sebuah kode. - Beri nama tautan dengan domain sendiri — Atur
slugsepertimenudan pilih domain tautan agar kode tercetak sebagaigo.example.com/menu. - Buat kode secara massal — Buat ribuan kode dinamis dari sebuah daftar dan cocokkan kode yang dikembalikan dengan baris berdasarkan label.
Server MCP Terhosting
npx add-mcp 'https://qrflow.codes/mcp'Terpasang ke Claude Code, Codex, Cursor, dan lainnya
Dokumentasi
QRFLOW.codes untuk developer
Mulai di sini
QRFLOW.codes membuat kode QR yang bisa Anda ubah setelah dicetak, menggunakan domain Anda sendiri, dilengkapi analitik pemindaian, dan memungkinkan perangkat lunak serta asisten AI Anda melakukan semuanya melalui satu API.
Kode QR adalah gambar dari sebuah string. Kebanyakan generator menaruh alamat web Anda di dalam gambar; jika alamatnya berubah, hasil cetaknya tidak lagi berguna. QRFLOW menaruh tautan pendek di dalam gambar (go.yourbrand.com/menu atau qrflow.codes/q/x7k2p9a) lalu mengarahkannya ke tujuan. Anda bisa mengubah tujuannya kapan saja, dan setiap pemindaian akan dihitung. Itulah kode dinamis, dan inilah yang layak disediakan melalui API.
API ini melakukan persis seperti yang dilakukan dasbor: membuat kode dalam bentuk apa pun, mengarahkannya ke tujuan baru, memberi nama pada tautannya, memilih domain Anda yang akan digunakan saat mencetak, mengambil angka pemindaian, membuat ribuan kode sekaligus, dan memberi tahu Anda saat terjadi sesuatu (webhook). Alat yang sama juga tersedia sebagai server MCP, sehingga Claude, ChatGPT, Cursor, dan Claude Code dapat mengelola akun Anda dengan instruksi biasa.
Akses: REST API memerlukan kunci API Business ($29 per bulan, dibuat di halaman Account) atau token OAuth. Server MCP berfungsi di semua paket melalui login OAuth; hal yang dapat dibuat asisten mengikuti fitur paket, sama seperti fitur lainnya.
Belum yakin apakah perlu menggunakannya? Halaman API kode QR adalah ringkasan singkat: fungsinya, keunggulan pustaka sisi klien, dan biayanya.
Jika Anda adalah asisten AI yang membantu seseorang membangun dengan QRFLOW
Selamat datang. Halaman ini ditulis untuk Anda sekaligus untuk orang yang Anda bantu. Berikut cara memberikan bantuan yang baik:
- Pastikan paket akunnya: kunci API memerlukan paket Business. Jika mereka belum memilikinya, arahkan ke https://qrflow.codes/pricing dan Account › API keys; jangan mengarang kunci atau paket gratis yang tidak tersedia.
- Simpan kunci di server. Baca kunci dari variabel lingkungan (QRFLOW_KEY) di route handler, server action, edge function, atau backend. API sengaja menolak origin browser (CORS), jadi kode yang hanya berjalan di front end tidak dapat memanggilnya.
- Buat kode dinamis dengan type "url" dan destination_data.url. Simpan id dan short_url yang dikembalikan di database mereka. Cetak atau tampilkan short_url; tujuannya dapat diubah nanti dengan PATCH /codes/:id dan hasil cetaknya tetap berlaku.
- Untuk menampilkan atau menyimpan gambar: setiap objek Code memiliki png_download_url dan svg_download_url, yaitu tautan bertanda tangan yang berlaku selama 24 jam tanpa header (cocok untuk penyimpanan sekali atau pratinjau). Untuk penggunaan permanen di aplikasi mereka, teruskan GET /codes/:id/image.svg melalui server mereka dengan kunci, atau enkode short_url menggunakan pustaka QR apa pun di klien; pelacakan tetap berfungsi karena tautannya melewati QRFLOW.
- Saat menggunakan PATCH, kirim hanya kolom yang berubah. Jangan pernah mengubah slug atau domain_id setelah sesuatu dicetak; keduanya mengubah tautan yang tercetak.
- Jika hasil cetak sudah ada, utamakan paused: true daripada DELETE. Menghapus akan memutus tautannya.
- Untuk menerima peristiwa, gunakan webhook (Account › Webhooks atau POST /webhooks) dan verifikasi header X-QRFLOW-Signature dengan isi permintaan mentah. Jangan melakukan polling GET /codes berulang kali.
- Jika mereka ingin menggunakan QRFLOW dari chat, bukan dari kode, hubungkan server MCP di https://qrflow.codes/mcp; tanpa kunci.
- Jika terjadi kegagalan, baca error dan message di isi JSON. Bagian pemecahan masalah di bawah memetakan setiap kode error ke solusinya.
- Referensi lengkap dalam Markdown tersedia di https://qrflow.codes/llms-full.txt dan dokumen OpenAPI 3.1 di https://qrflow.codes/api/v1/openapi.json. Keduanya dibuat dari sumber yang sama dengan halaman ini.
Untuk manusia: bagian ini membantu memastikan asisten yang Anda ajak bekerja sama memberikan jawaban yang aman. Bagian ini juga merupakan ringkasan yang baik.
Paket yang Anda perlukan
Kunci API adalah satu-satunya fitur yang khusus untuk Business. Semua yang dilakukan asisten melalui server MCP dan semua yang dilakukan aplikasi pihak ketiga melalui OAuth berfungsi di paket apa pun dan mengikuti fitur paket tersebut. Harga lengkap dan penggunaan wajar: /pricing.
| Free | Premium $4 | Business $29 | |
|---|---|---|---|
| Kunci API (REST dari kode Anda) | Tidak | Tidak | Ya, hingga 10 kunci |
| Server MCP (Claude, ChatGPT, Cursor, Claude Code) | Ya, masuk | Ya | Ya, masuk atau gunakan kunci |
| OAuth untuk aplikasi Anda sendiri (pengguna menghubungkan QRFLOW mereka) | Ya | Ya | Ya |
| Kode dinamis (ubah tujuan setelah dicetak) | Satu | Semua kode | Semua kode |
| Domain tautan Anda sendiri | Tidak | 1 domain | 5 domain, pilih per kode |
| Nama tautan (go.brand.com/menu) | Tidak | Ya | Ya |
| Analitik pemindaian | Tidak | Ya | Ya |
| Webhook | Tidak | Tidak | Ya, hingga 10 |
| Pembuatan massal | Tidak | 500/bulan, 500 per permintaan | 10.000/bulan, 2.000 per permintaan |
| Kode tersimpan (penggunaan wajar) | Beberapa | 1.000 | 25.000 |
| Kursi tim | 1 | 1 | 5 |
| Harga | $0 | $4/bulan | $29/bulan |
Dua belas kata yang mencakup semuanya
Konsep
Baca bagian ini sekali, lalu setiap endpoint di bawah akan mudah dipahami.
Static code
Kontennya ada di dalam gambar. Kode Wi-Fi, kartu kontak (vCard), dan teks biasa selalu statis, begitu pula semua kode di paket Free. Kode statis tidak memerlukan server, tidak pernah kedaluwarsa, dan tidak dapat diubah atau dihitung.
Dynamic code
Gambar berisi tautan pendek yang dialihkan oleh QRFLOW. Kode url, phone, email, sms, dan location bersifat dinamis di paket Premium dan Business. Anda dapat mengubah tujuan, menjeda, menetapkan masa berlaku, mengganti nama, dan menghitung pemindaiannya tanpa menyentuh hasil cetak.
short_url
String persis yang dienkode dalam kode dinamis dan yang harus dicetak. Nilainya adalah https://qrflow.codes/q/<short_code> sampai Anda menghubungkan domain, lalu menjadi https://<your domain>/<slug or short_code>. Setiap objek Code menyertakannya.
short_code
Tujuh karakter acak, unik untuk setiap kode, ditetapkan saat kode dibuat dan tidak pernah berubah. Ini adalah jalur cadangan jika kode tidak memiliki nama tautan.
slug (link name)
Jalur yang mudah dibaca di domain Anda sendiri: go.example.com/menu. Terdiri dari 3 hingga 40 huruf kecil, angka, dan tanda hubung, unik di dalam akun Anda, dan hanya tersedia jika domain sudah terhubung. Tetapkan sebelum mencetak: mengubahnya akan mengubah tautan yang tercetak.
Link domain
Nama host milik Anda (go.example.com) yang diarahkan ke QRFLOW melalui CNAME dan diverifikasi di halaman Account. Paket Premium mendapat satu; Business mendapat lima dan dapat memilihnya per kode dengan domain_id. Domain aktif yang paling lama menjadi default.
Kind, type and subtype
type adalah format enkode: url, text, wifi, vcard, email, phone, sms, location. Jenis adalah nama yang lebih mudah dipahami untuk kebutuhan pengguna (instagram, googlereview, whatsapp, pdf, menu, appstore,...). Sebagian besar jenis adalah kode url dengan destination_data.subtype yang ditetapkan. GET /catalog mencantumkan semua jenis beserta kolomnya; kind pada objek Code menunjukkan jenisnya.
destination_data
Kolom untuk jenis tersebut, dalam bentuk string: { url } untuk situs web, { ssid, password, encryption } untuk Wi-Fi, { placeId } untuk ulasan Google, { handle } untuk Instagram. Pada kode dinamis, Anda dapat menggantinya kapan saja.
Scans
Setiap pengalihan mencatat jenis perangkat, negara, kota, perujuk, browser, OS, dan bahasa dari permintaan itu sendiri, serta hash harian satu arah untuk menghitung pengunjung unik. Cookie tidak dibuat dan alamat IP tidak disimpan. scans pada objek Code adalah jumlah total sepanjang masa; GET /codes/:id/scans merincinya.
Source
Setiap kode mengingat asal pembuatannya: dashboard, api:<key name>, mcp, canva, app:<connected app> (misalnya app:Google Sheets), atau bulk, dengan awalan bulk: jika dibuat melalui permintaan massal. Informasi ini ditampilkan di dasbor dan dalam payload webhook, sehingga Anda dapat membedakan kode dari integrasi Anda dengan kode yang dibuat secara manual.
Workspace
Pemilik paket Business dapat mengundang hingga empat anggota tim. Kunci dan webhook menjadi milik akun pemilik; kode yang dibuat siapa pun di ruang kerja dapat dilihat oleh seluruh tim.
Lima menit
Mulai cepat
Dapatkan kunci
- Di paket Business, buka Account › API keys.
- Beri nama sesuai kegunaannya ("Shop backend", "Reporting") dan pilih cakupannya. Cakupan tidak dapat diubah nanti; buat kunci baru jika perlu.
- Salin sekali saja. Bentuknya seperti
qrf_live_…. Simpan dalam variabel lingkungan bernamaQRFLOW_KEY. - Kirim sebagai
Authorization: Bearer $QRFLOW_KEYpada setiap permintaan. Begitulah seluruh proses autentikasinya.
Kunci digunakan di server. Jangan pernah menaruhnya di halaman web, aplikasi seluler, atau spreadsheet bersama; cabut dan buat ulang jika bocor.
Lima langkah yang sama dalam curl, TypeScript, dan Python. Masing-masing membuat kode dinamis, mengunduh gambarnya, mengubah tujuannya, dan membaca jumlah pemindaiannya.
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
Autentikasi
Kunci API (Business)
Hingga 10 kunci per akun, masing-masing 600 permintaan per menit, disimpan dalam bentuk hash, dan hanya ditampilkan sekali. Kunci memiliki cakupan yang ditetapkan saat dibuat:
| Cakupan | Izin |
|---|---|
| profile | GET /me: paket, fitur, batas. Setiap kunci memilikinya. |
| codes:read | Mencantumkan dan membaca kode, mengunduh gambar. |
| codes:write | Membuat, mengubah, menjadikan dinamis, menghapus, dan membuat kode secara massal. |
| analytics:read | GET /codes/:id/scans. |
| domains:read | GET /domains (diperlukan agar domain_id dapat digunakan dengan tepat). |
| codes:read / codes:write | Juga untuk produk GS1: endpoint /products menggunakan cakupan kode yang sama, jadi kunci yang mengelola kode juga mengelola kode kemasan. |
| webhooks:manage | Mencantumkan, membuat, menguji, dan menghapus webhook. |
OAuth 2.0 (paket apa pun, untuk aplikasi dan asisten)
Jika kode harus menjadi milik akun pengguna Anda, bukan akun Anda, atau jika kliennya adalah asisten chat, gunakan OAuth. Klien mendaftarkan dirinya sendiri; PKCE S256 wajib untuk klien publik; token dapat diikat ke server MCP dengan resource=. Panduan OAuth menjelaskan langkah-langkahnya.
| Endpoint | URL | Catatan |
|---|---|---|
| Otorisasi | https://qrflow.codes/oauth/authorize | Arahkan pengguna ke sini; mereka masuk lalu menekan Allow. |
| Token | https://qrflow.codes/api/oauth/token | Grant authorization_code dan refresh_token. Token akses berlaku 1 jam, token refresh 90 hari. |
| Cabut | https://qrflow.codes/api/oauth/revoke | RFC 7009. Pengguna juga dapat memutuskan koneksi di Account › Connected apps. |
| Daftarkan klien | https://qrflow.codes/api/oauth/register | Pendaftaran dinamis RFC 7591, tanpa perlu akun. Klien publik mendapat client_id berawalan dyn_ dan harus menggunakan PKCE S256. |
| Discovery | https://qrflow.codes/.well-known/oauth-authorization-server | RFC 8414. Dokumen resource MCP tersedia di /.well-known/oauth-protected-resource. |
Token akses berlaku 1 jam, token refresh 90 hari. Pengguna dapat melihat aplikasi yang terhubung di Account › Connected apps dan memutuskan koneksi kapan saja. Token yang diterbitkan untuk https://qrflow.codes/mcp akan ditolak di /api/v1, begitu pula sebaliknya.
Hal-hal yang benar-benar diminta orang
Panduan implementasi
Setiap panduan lengkap dan disalin langsung dari kode yang berfungsi. Pilih yang sesuai dengan stack Anda; polanya selalu sama: panggilan sisi server dengan kunci, simpan id dan short_url, lalu tampilkan gambar.
- Next.js
- Tampilkan QR tanpa meneruskan permintaan melalui proxy
- Express atau server Node apa pun
- Cloudflare Workers, Vercel Edge, Deno Deploy, Supabase Edge Functions
- Python
- Satu kode QR untuk setiap pesanan, meja, produk, tiket, atau acara
- Ubah tujuan kode yang sudah dicetak
- Cetak kode di domain Anda sendiri
- Grafik pemindaian di panel admin Anda sendiri
- Terima webhook di Next.js dan verifikasi tanda tangannya
- Terima webhook di Python
- Buat ribuan kode dari CSV
- Izinkan pengguna menghubungkan akun QRFLOW mereka sendiri (OAuth)
- Zapier, Make, n8n
Next.js: route untuk membuat kode dan route untuk menampilkannya
Kapan digunakan: Anda memiliki aplikasi Next.js (App Router) dan ingin tombol yang membuat kode QR serta halaman yang menampilkannya.
- Simpan kunci di .env.local sebagai QRFLOW_KEY. Jangan pernah menambahkan awalan NEXT_PUBLIC_.
- Tambahkan route handler POST yang membuat kode dan mengembalikan id serta short_url.
- Tambahkan route GET yang meneruskan gambar melalui proxy agar browser tidak pernah melihat kunci.
- Simpan id dan short_url pada data Anda sendiri (pesanan, meja, produk, acara).
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 bekerja dengan cara yang sama: panggil fetch dengan kunci di dalam action.
- Untuk Pages Router, kode yang sama ditempatkan di pages/api/qr.ts dengan req/res.
Tampilkan QR tanpa proxy: render short_url sendiri
Kapan: Anda ingin gambar langsung tampil di browser dan tidak memerlukan frame atau logo QRFLOW.
Library QR apa pun bisa digunakan, karena kode tersebut ADALAH tautan pendek
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.
- Ini cara tercepat untuk membuat pratinjau. Untuk dicetak, unduh /codes/:id/image.svg: file ini memuat warna, frame, keterangan, dan logo yang tersimpan, serta berupa gambar vektor.
- Jika nanti Anda mengubah slug atau domain_id, short_url akan berubah; render ulang.
Express atau server Node apa pun
Kapan: Backend Node biasa.
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
Kapan: Runtime yang hanya menggunakan fetch dan tidak memiliki bawaan Node.
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_...
- Paket npm
qrflow\hanya menggunakan fetch dan WebCrypto, sehingga dapat berjalan di semua runtime ini tanpa perubahan.
Python: FastAPI, Flask, Django, sebuah skrip
Kapan: Backend Anda menggunakan 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")
Satu kode QR untuk setiap pesanan, meja, produk, tiket, atau acara
Kapan: Setiap baris di salah satu tabel Anda memerlukan kodenya sendiri, yang dibuat secara otomatis.
- Tambahkan dua kolom ke tabel Anda: qrflow_code_id (uuid) dan qr_short_url (text).
- Saat baris dibuat, kirim POST /codes dengan URL publik baris tersebut dan label yang menyebutkan nama baris ("Order 10432", "Table 7"). Simpan id dan short_url.
- Saat halaman baris berpindah (domain atau jalur baru), PATCH destination_data. Kode yang sudah dicetak akan tetap berfungsi.
- Saat baris tidak lagi digunakan, PATCH { paused: true } jika ada yang sudah dicetak; gunakan DELETE hanya jika belum ada yang dicetak.
- Perlu membuat ribuan sekaligus (menu untuk setiap meja di 300 restoran)? Gunakan POST /codes/bulk dalam beberapa bagian, lalu cocokkan kode yang dikembalikan dengan baris Anda berdasarkan label atau urutan.
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 });
- Penggunaan wajar adalah 25,000 kode tersimpan di Business; API membatasi hingga dua kali jumlah tersebut. Jika Anda memerlukan satu kode untuk setiap struk selamanya, hubungi kami terlebih dahulu: hello@qrflow.codes.
Ubah tujuan kode yang sudah dicetak
Kapan: Kampanye berakhir, halaman berpindah, PDF diganti, atau musim berganti.
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" } }'
Jeda kode, atau tetapkan tanggal berakhir
# 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" }'
- Hanya kode dinamis yang dapat dialihkan; kode statis apa pun akan menghasilkan 400 not_dynamic. Kode Wi-Fi, vCard, dan teks biasa menyimpan kontennya dalam pola dan tidak pernah bisa menjadi dinamis, sehingga POST /codes/:id/dynamic menolaknya dengan 400 not_dynamic_capable. Untuk kode url, phone, email, sms, dan location, Free menjadikan kode pertama dinamis dan sisanya statis, sedangkan semua kode dinamis di paket berbayar; POST /codes/:id/dynamic mengubah kode statis selama akun masih memiliki kuota. Render dan cetak ulang setelahnya, karena gambarnya berubah.
- Pemindai akan melihat tujuan baru pada pemindaian berikutnya. Tidak ada cache yang perlu ditunggu kedaluwarsa.
Cetak kode di domain Anda sendiri
Kapan: Anda ingin go.example.com/menu tercantum dalam kode, bukan qrflow.codes/q/x7k2p9a.
- Di halaman Account, pada bagian Your own link domain, tambahkan go.example.com dan buat CNAME yang ditampilkan di penyedia DNS Anda. Verifikasi biasanya selesai dalam beberapa menit.
- Setelah itu, short_url setiap kode dinamis baru akan menggunakan domain tersebut. Kode yang sudah ada juga akan beralih: gambar kodenya menyimpan qrflow.codes/q/..., yang tetap mengalihkan, sehingga tidak ada kode cetak yang rusak.
- Beri nama yang mudah dibaca pada kode dengan slug: PATCH { "slug": "menu" } akan membuat go.example.com/menu. Lakukan ini sebelum mencetak.
- Di Business dengan beberapa domain, GET /domains mencantumkan domain beserta id-nya; teruskan domain_id pada POST atau PATCH untuk memilih domain bagi setiap kode.
Beri nama pada tautan dan pilih domain
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
Grafik pemindaian di panel admin Anda sendiri
Kapan: Anda ingin melihat jumlah pemindaian per hari, negara, atau perangkat di samping angka Anda sendiri.
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
- Satu permintaan mencakup hingga 92 hari; lakukan perulangan untuk rentang yang lebih panjang. Tanggal menggunakan UTC.
- Untuk mendapatkan angka terbaru tanpa polling, daftarkan webhook ke event pemindaian: Anda akan menerima setiap pemindaian beserta detailnya dalam beberapa menit sekali secara berkelompok.
Terima webhook di Next.js dan verifikasi
Kapan: Anda ingin mengetahui saat kode dipindai atau diubah, di database Anda sendiri, hampir secara real-time.
- Buat webhook di Account › Webhooks atau dengan POST /webhooks. Salin secret (whsec_...) sekali ke QRFLOW_WEBHOOK_SECRET.
- Baca body mentah sebagai teks sebelum menguraikannya; tanda tangan mencakup byte yang persis sama.
- Verifikasi, lalu gunakan event untuk menentukan tindakan. Berikan respons 2xx dengan cepat; lakukan pekerjaan yang lambat setelah merespons atau di dalam antrean.
- Tekan Test pada webhook untuk menerima ping bertanda tangan dan memastikan konfigurasinya berfungsi.
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 });
}
- Untuk pengembangan lokal, buka server dev Anda melalui tunnel (cloudflared tunnel --url http://localhost:3000, atau ngrok) dan gunakan URL https tersebut untuk webhook selama proses pengembangan.
- Paket npm menangani ini untuk Anda:
import { parseWebhook } from "qrflow"\memverifikasi dan menguraikan dalam satu panggilan (WebCrypto, sehingga juga berjalan di Workers dan Deno). Klien Python menyediakan verify_webhook.
Terima webhook di Python
Kapan: Flask, FastAPI, atau Django menerima event yang sama.
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
Ribuan kode dari CSV
Kapan: Satu kode untuk setiap SKU, kursi, tag aset, atau surat promosi.
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");
}
- Bulk hanya membuat kode url dinamis, semuanya dengan warna yang sama. Kode dikembalikan sesuai urutan pengiriman, kecuali baris yang ditolak; jika ragu, cocokkan berdasarkan label.
- Webhook menerima satu event code.created untuk setiap permintaan bulk dengan codes[], bukan satu event per kode.
Izinkan pengguna Anda menghubungkan akun QRFLOW mereka sendiri (OAuth)
Kapan: Anda sedang membuat produk untuk orang lain dan ingin kode tersimpan di akun QRFLOW mereka, bukan akun Anda.
- Daftarkan klien sekali: POST https://qrflow.codes/api/oauth/register dengan client_name dan redirect_uris. Anda akan mendapatkan client_id (dan client_secret untuk klien rahasia).
- Arahkan pengguna ke /oauth/authorize dengan response_type=code, client_id, redirect_uri, scope, state, dan PKCE (code_challenge, code_challenge_method=S256).
- Tukarkan kode di /api/oauth/token. Simpan refresh token; access token berlaku selama satu jam.
- Panggil /api/v1 dengan Authorization: Bearer <access_token>. Semuanya berfungsi persis seperti dengan kunci, sesuai paket pengguna.
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
- Scope-nya sama dengan enam scope untuk kunci API. Minta hanya yang Anda perlukan; layar persetujuan akan mencantumkannya.
- Jika aplikasi Anda adalah asisten chat atau agen, tambahkan resource=https://qrflow.codes/mcp ke permintaan authorize dan gunakan server MCP; token akan terikat ke server tersebut.
Zapier, Make, n8n: tanpa kode sama sekali
Kapan: Anda ingin pemindaian atau kode baru masuk ke spreadsheet, kanal Slack, atau CRM.
- Buat pemicu catch-hook (Zapier: Webhooks by Zapier › Catch Hook; Make: Custom webhook; n8n: Webhook node) dan salin URL https-nya.
- Di Account › Webhooks, tambahkan URL tersebut dan pilih event. Tekan Test; ping akan muncul di alat dan menunjukkan bentuk payload-nya.
- Petakan data.scans[] (untuk pemindaian) atau data.code (untuk code.*) ke spreadsheet, pesan, atau catatan Anda.
- Untuk membuat kode dari alat tersebut, gunakan modul HTTP-nya untuk mengirim POST /codes dengan header Authorization. Simpan kunci di penyimpanan kredensial alat.
- Zapier kini memiliki aplikasi QRFLOW.codes: langkah Create QR Code, Update QR Code, dan Find, serta pemicu instan New Scan, tidak memerlukan konfigurasi webhook atau kunci API. Lihat QRFLOW dengan Zapier. Langkah-langkah di bawah ini ditujukan untuk Make, n8n, dan alat lainnya.
- Alat-alat ini tidak dapat memverifikasi tanda tangan. URL yang diberikan tidak dapat ditebak; itulah perlindungan yang tersedia. Jangan bagikan URL tersebut di mana pun.
- Jika daftar sudah ada di Google Sheets, webhook mungkin tidak diperlukan: add-on QRFLOW for Google Sheets membuat kode untuk setiap baris dan menulis tautan pendek serta jumlah pemindaian kembali ke spreadsheet, di paket Premium, tanpa kunci API. Lihat add-on Google Sheets.
Pemrograman dengan AI
Prompt untuk ditempel
Asisten pemrograman akan membuat solusi yang tepat jika diberi tahu aturannya sejak awal. Prompt ini memuat aturan tersebut. Tempel salah satunya, isi bagian dalam tanda kurung siku, dan asisten akan membaca referensi Markdown sebelum menulis satu baris kode pun.
Tambahkan kode QR ke aplikasi saya
Claude, ChatGPT, Cursor, Codex, Windsurf, Copilot Chat: tempel ke 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"].
Ajarkan repo Anda tentang QRFLOW
Tambahkan ke CLAUDE.md, AGENTS.md,.cursorrules atau.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.
Di Lovable, Bolt, v0, Replit, dan pembuat aplikasi lainnya
Pembuat aplikasi yang mengutamakan front-end dan menyediakan backend (Supabase, fungsi serverless)
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 kustom yang mengelola kode saya
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).
Hal yang bisa dikatakan setelah konektor aktif
Claude, ChatGPT, Claude Code dengan server QRFLOW MCP yang terhubung
"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."
Server MCP
Gunakan dari Claude, ChatGPT, Cursor, dan Claude Code
QRFLOW adalah server MCP di https://qrflow.codes/mcp. Hubungkan sekali, masuk, lalu ucapkan hal-hal seperti "buat kode QR untuk halaman menu musim gugur kami, beri nama menu di domain saya", "arahkan kode pada poster lobi ke halaman baru" atau "berapa banyak pemindaian yang didapat selebaran minggu lalu, berdasarkan negara?". Asisten mendapatkan alat yang sama seperti yang ditawarkan API ini, dengan aturan yang sama, dan kode tersimpan di dasbor Anda dengan mcp sebagai sumbernya.
Bukan developer? Versi dengan bahasa sederhana, beserta langkah-langkah persis untuk setiap asisten, tersedia di Buat kode QR dengan asisten AI Anda.
Dinilai secara independen dan diperiksa kesehatannya setiap jam oleh Glama, serta tercantum di direktori awesome-remote-mcp-servers dan MCP Registry resmi sebagai codes.qrflow/qrflow.
Hubungkan
Customize › Connectors › Add custom connector › tempel alamatnya, atau tekan Connect pada daftar direktori QRFLOW. Claude akan membuka halaman masuk QRFLOW; tekan Allow. Tersedia di semua paket.
https://qrflow.codes/mcp
Settings › Security and login › aktifkan Developer mode, lalu Settings › Plugins › + › tempel alamatnya; masuk saat diminta. Tersedia untuk Plus, Pro, Team, Enterprise, dan Edu.
https://qrflow.codes/mcp
Satu perintah, lalu /mcp untuk masuk. Tambahkan kunci Business sebagai header untuk melewati proses masuk.
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, klien MCP apa pun
Tambahkan server HTTP di URL tersebut. Masuk melalui OAuth dilakukan di browser; atau teruskan header Authorization dengan kunci.
{
"mcpServers": {
"qrflow": { "type": "http", "url": "https://qrflow.codes/mcp" }
}
}
Agen Anda sendiri (Anthropic atau OpenAI SDK)
Arahkan konektor atau alat MCP ke URL tersebut dengan kunci Business sebagai bearer; alur browser tidak diperlukan.
// Anthropic Messages API, MCP connector
mcp_servers: [{ type: "url", url: "https://qrflow.codes/mcp", name: "qrflow", authorization_token: process.env.QRFLOW_KEY }]
Hal yang dapat dilakukan asisten
| Alat | Fungsinya | Scope |
|---|---|---|
| list_code_kinds | Semua jenis kode beserta kolom dan paket yang diperlukan. Asisten memanggil ini sebelum membuat sesuatu yang tidak biasa. | profile |
| list_domains | Domain tautan Anda, domain default, dan id-nya. | domains:read |
| get_qr_image | PNG yang dapat ditampilkan atau disimpan oleh asisten, serta URL SVG untuk dicetak. | codes:read |
| get_account | Paket, fitur, dan batas akun. | profile |
Cara menjaga keamanan
- Asisten hanya memegang token untuk akun Anda, yang diterbitkan setelah Anda menekan Allow di halaman QRFLOW. Putuskan koneksi kapan saja di Account › Connected apps.
- Token terikat ke server MCP; token tidak dapat digunakan kembali untuk mengakses REST API.
- Setiap operasi tulis menjalani validasi yang sama seperti di dasbor: tujuan yang diizinkan, pemeriksaan paket, dan batas penggunaan wajar.
- Alat yang bersifat destruktif menjelaskan tindakannya dengan cermat:
delete_qr_codememberi tahu model untuk memilih jeda jika kode sudah dicetak. - Dokumen penemuan tersedia di
/.well-known/oauth-authorization-serverdan/.well-known/oauth-protected-resource; pendaftaran menggunakan RFC 7591; hanya PKCE S256 yang didukung.
SDK dan spesifikasi OpenAPI
- TypeScript / JavaScript:
npm install qrflow(npm). Tanpa dependensi, ESM dan CommonJS, tipe lengkap; berjalan di Node 18+, Bun, Deno, dan Workers. Menangani percobaan ulang 429 untuk Anda dan menyertakanverifyWebhook/parseWebhook. - Python 3.9+, hanya pustaka standar: qrflow.py.
- OpenAPI 3.1: /api/v1/openapi.json. Impor ke Postman atau Insomnia, buat klien dalam bahasa apa pun, atau lampirkan ke ChatGPT Action.
- Kedua klien melempar error bertipe (
QRFlowErrordenganstatus,code,message,retryAfter) dan menyertakan verifier webhook. Sumber TypeScript satu file tetap tersedia di /sdk/qrflow.ts jika Anda lebih suka menyertakannya langsung.
| TypeScript | Python | Panggilan |
|---|---|---|
| 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) | Alamat gambar (ambil dengan kunci) |
| verifyWebhook(raw, header, secret) | verify_webhook(raw, header, secret) | Pemeriksaan tanda tangan untuk pengiriman |
Referensi endpoint
URL dasar https://qrflow.codes/api/v1. Isi dan respons berupa JSON. Tanggal menggunakan ISO 8601 dalam UTC. Kirim hanya kolom yang berubah pada PATCH.
GETprofile
Paket, flag fitur, batas yang berlaku untuk akun ini, serta cakupan kunci.
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
Tipe bawaan (url, wifi, vcard, email, phone, sms, text, location) dan sekitar 50 subtipe (Instagram, ulasan Google, Wi-Fi, app store…), masing-masing dengan kolom yang diperlukan dan paket yang disyaratkan. Tidak memerlukan kunci.
curl https://qrflow.codes/api/v1/catalog
GETcodes:read
Urutan terbaru lebih dahulu.?limit= hingga 100,?q= mencari label.
curl "https://qrflow.codes/api/v1/codes?limit=20&q=menu" \
-H "Authorization: Bearer $QRFLOW_KEY"
POSTcodes:write
Aturannya sama seperti Save di situs: kode url, phone, email, sms, dan location bersifat dinamis pada paket berbayar; Wi-Fi, vCard, dan text menyimpan kontennya dalam pola. Masukkan ID subtipe ke destination_data.subtype untuk membuat, misalnya, kode ulasan Google. domain_id opsional menentukan domain tautan Anda yang digunakan untuk mencetak kode (GET /domains menampilkan daftarnya).
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
Kode beserta jumlah pemindaian, tautan pendek, dan alamat gambar.
curl https://qrflow.codes/api/v1/codes/$ID \
-H "Authorization: Bearer $QRFLOW_KEY"
PATCHcodes:write
Salah satu dari: destination_data (hanya kode dinamis, hasil cetak tetap valid), label, paused, expires_at (ISO atau null), slug (nama tautan di domain Anda), domain_id (domain tautan Anda yang digunakan untuk mencetak kode ini; null = default akun), fg_color, bg_color, frame_style, frame_caption, frame_caption2. Kirim hanya kolom yang ingin Anda ubah.
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
Dihapus selamanya, termasuk riwayat pemindaiannya. Tautan tercetak pada kode dinamis tidak lagi berfungsi. Gunakan paused: true jika hasil cetaknya masih beredar.
curl -X DELETE https://qrflow.codes/api/v1/codes/$ID \
-H "Authorization: Bearer $QRFLOW_KEY"
204 No Content
POSTcodes:write
Pola yang dicetak berubah (sekarang mengodekan tautan pendek), jadi render ulang gambar setelahnya.
curl -X POST https://qrflow.codes/api/v1/codes/$ID/dynamic \
-H "Authorization: Bearer $QRFLOW_KEY"
GETcodes:read
SVG siap cetak dengan bingkai dan warna.?size= mengatur lebar kisi modul dalam px; file tetap dapat diskalakan tanpa kehilangan kualitas.
curl https://qrflow.codes/api/v1/codes/$ID/image.svg \
-H "Authorization: Bearer $QRFLOW_KEY" -o code.svg
GETanalytics:read
?from= dan?to= (tanggal ISO, hingga 92 hari, default 30 hari terakhir) dan?group= day, device, country, city, browser, os, atau referrer. Angka yang sama seperti di halaman analitik.
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
Hingga 2.000 kode URL dalam satu panggilan, semuanya dinamis. Dihitung dalam kuota bulanan bulk yang sama dengan halaman Bulk (10.000 pada Business). Baris yang bukan alamat web dikembalikan dalam rejected; sisanya dibuat.
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
Kode yang dicetak pada kemasan ritel. Setiap produk terdiri dari satu GTIN, alamat yang dicetak pada kemasan, dan tautan di baliknya. Cari nama dan GTIN dengan?q=. Paket 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 dan name wajib diisi; brand dan url opsional. Digit pemeriksa diverifikasi sebelum data apa pun ditulis, dan format 8, 12, 13, serta 14 digit semuanya dinormalisasi menjadi 14 digit. GTIN yang sudah Anda miliki menghasilkan 409, bukan produk kedua.
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
Satu GTIN dapat mengarah ke beberapa tempat sekaligus, masing-masing diberi label sesuai kegunaannya. Telepon mendapatkan default; aplikasi yang meminta tipe tertentu mendapatkan tautan untuk tipe tersebut. Idempoten: link_type dan batch yang sama akan mengganti tautan itu, bukan menambahkan tautan kedua, sehingga skrip malam dapat dijalankan dua kali. Berikan batch untuk membatasi tautan ke satu lot; cara ini memungkinkan penarikan produk diumumkan tanpa memengaruhi bagian lain dari produksi.
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
Jumlah per GTIN untuk?days= terakhir (1 hingga 365, default 30), dirinci menurut negara, perangkat, tipe tautan, dan batch. went_nowhere menghitung pemindaian yang tidak menemukan tujuan, dan seharusnya bernilai nol.
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
Domain Anda yang terhubung, statusnya, dan domain yang digunakan kode dinamis secara default (default_base). Berikan ID domain sebagai domain_id pada kode untuk mencetak kode tersebut dengan domain lain.
curl https://qrflow.codes/api/v1/domains \
-H "Authorization: Bearer $QRFLOW_KEY"
GETwebhooks:manage
Webhook Anda beserta event, status terakhir, dan jumlah kegagalan.
curl https://qrflow.codes/api/v1/webhooks \
-H "Authorization: Bearer $QRFLOW_KEY"
POSTwebhooks:manage
url harus berupa https pada host publik; events dapat berupa scan, code.created, code.updated, atau code.deleted. Secret penandatanganan hanya dikembalikan sekali.
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
Mengirim ping bertanda tangan sekarang dan melaporkan responsnya.
curl -X POST https://qrflow.codes/api/v1/webhooks/$WEBHOOK_ID \
-H "Authorization: Bearer $QRFLOW_KEY"
DELETEwebhooks:manage
Menghentikan semua pengiriman, termasuk percobaan ulang yang mengantre.
curl -X DELETE https://qrflow.codes/api/v1/webhooks/$WEBHOOK_ID \
-H "Authorization: Bearer $QRFLOW_KEY"
204 No Content
GETpublic
ID bingkai dan kebutuhan masing-masing (caption, baris kedua), dikelompokkan seperti di kustomisasi. Tidak memerlukan kunci.
curl https://qrflow.codes/api/v1/frames
Objek Code
Setiap endpoint yang berinteraksi dengan kode mengembalikan bentuk yang sama. Abaikan kolom yang tidak Anda kenal; kolom baru ditambahkan seiring waktu.
| Kolom | Tipe | Arti |
|---|---|---|
| id | uuid | ID tetap. Gunakan dalam setiap panggilan lainnya. |
| label | string | null | Nama di dasbor. Maksimal 120 karakter. Dapat dicari dengan?q=. |
| kind | string | ID katalog: url, wifi, instagram, googlereview,... kind_label adalah nama yang mudah dibaca. |
| type | string | Pengodean: url, text, wifi, vcard, email, phone, sms, location. |
| destination_data | object | Kolom yang Anda kirim (ditambah subtype untuk jenis). destination adalah ringkasan satu barisnya. |
| dynamic | boolean | True jika pemindaian melewati QRFLOW dan tujuan dapat diubah. dynamic_capable menunjukkan apakah tipe ini dapat dibuat dinamis pada paket berbayar. |
| short_code | string | Tujuh karakter, tidak pernah berubah. |
| short_url | string | Yang dicetak untuk kode dinamis. Mencakup domain dan slug Anda jika ditetapkan. |
| domain_id | uuid | null | Domain tautan yang digunakan untuk mencetak kode ini; null berarti default akun. |
| fg_color, bg_color | hex | Warna modul dan latar belakang. |
| has_logo | boolean | Logo ditambahkan di dasbor; image.svg menyertakannya. |
| frame_style, frame_caption, frame_caption2 | string | null | ID bingkai dan caption, seperti di kustomisasi. |
| scans | integer | Jumlah pemindaian sepanjang masa. |
| created_at, updated_at | ISO 8601 | UTC. |
| manage_url | url | Halaman kode di dasbor, untuk tautan 'Open in QRFLOW'. |
| image_url | url | GET /codes/:id/image.svg. Memerlukan header Authorization; bukan URL gambar publik. |
| svg_download_url, png_download_url | url | SVG yang sama (bingkai, warna, logo) dan PNG polos melalui tautan bertanda tangan yang berlaku selama 24 jam tanpa header: untuk tag <img>, skrip, dan asisten yang menyimpan file. download_expires_at menunjukkan kapan tautan kedaluwarsa; setiap pembacaan kode mengembalikan tautan baru. |
Bentuk lainnya: 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, ditambah secret sekali), Me (id, email, plan, paid, features, limits, auth, scopes) dan Error (error, message). Dokumen OpenAPI mencantumkan tipe untuk setiap properti.
Business
Webhook
QRFLOW memanggil URL https Anda saat terjadi sesuatu. Buat webhook di Account › Webhooks atau dengan POST /webhooks; secret penandatanganan hanya diberikan sekali. Maksimal 10 per akun.
| Event | Kapan | data |
|---|---|---|
| scan | Dikirim secara berkelompok: setiap beberapa menit, semua pemindaian baru sejak pengiriman terakhir, hingga 500 per panggilan. | count, from, to, scans[] dengan code_id, label, short_code, slug, scanned_at, device, country, city, referrer, browser, os, language |
| code.created | Langsung dari API dan asisten; dalam beberapa menit dari dasbor. Permintaan bulk mengirim satu event dengan bulk: true dan codes[]. | code, source |
| code.updated | Waktu pengiriman sama. Mencakup tujuan, label, jeda, kedaluwarsa, nama tautan, domain, warna, bingkai, dan konversi menjadi dinamis. | code, changed[] (nama kolom yang berubah) |
| code.deleted | Waktu pengiriman sama. | code: { id, label, short_code, slug } |
| ping | Saat Anda menekan Test. | webhook_id, message |
Data yang diterima
Setiap payload adalah { id, event, created_at, data }. id tetap sama untuk percobaan ulang satu pengiriman, sehingga Anda dapat menggunakannya untuk menghapus duplikat.
{
"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
Verifikasi tanda tangan
X-QRFLOW-Signature: t=<unix seconds>,v1=<hex>. Hitung HMAC-SHA256 atas ${t}.${rawBody} dengan secret Anda dan bandingkan dengan v1 dalam waktu konstan; tolak jika t berusia lebih dari lima menit. Gunakan byte mentah yang Anda terima, jangan pernah objek yang diserialisasi ulang. Contoh receiver yang berfungsi untuk Next.js dan Python tersedia di resep, dan kedua SDK menyertakan helper ini.
Aturan pengiriman
- Berikan respons 2xx dalam 8 detik. Lakukan pekerjaan setelah merespons.
- Respons lainnya akan dicoba ulang setelah 1, 5, 15, 60, 240, dan 720 menit.
- Dua puluh kegagalan berturut-turut akan menonaktifkan webhook dan mengirim email kepada pemilik akun. Aktifkan kembali setelah receiver diperbaiki; percobaan ulang yang mengantre akan dilanjutkan.
- URL harus berupa https pada host publik. localhost, rentang privat, dan qrflow.codes sendiri akan ditolak. Gunakan tunnel selama pengembangan.
- Tekan Test untuk menerima
pingbertanda tangan dan melihat status yang dijawab server Anda.
Error
Setiap error adalah { "error": "<code>", "message": "<what to do>" } dengan status di bawah ini. Pesannya ditulis untuk manusia; tampilkan pesan tersebut.
| Status | error | Arti |
|---|
Gejala, penyebab, solusi
Pemecahan masalah
401 invalid_token pada setiap panggilan
PenyebabHeader salah atau kunci tidak aktif.
SolusiKirim tepat Authorization: Bearer qrf_live_… (spasi, bukan titik dua). Pastikan kunci belum dicabut di Account › API keys. Jika Anda menyalinnya dari chat atau dokumen, periksa apakah ada titik di akhir atau tanda kutip tipografis.
401 pada /api/v1 dengan token yang berfungsi di server MCP
PenyebabToken yang diterbitkan untuk https://qrflow.codes/mcp terikat ke server tersebut.
SolusiGunakan kunci API untuk REST, atau jalankan alur OAuth kedua tanpa resource= untuk mendapatkan token bagi REST API.
402 upgrade_required saat membuat kunci atau webhook
PenyebabKeduanya merupakan fitur Business.
SolusiTingkatkan paket di /pricing, atau gunakan server MCP yang berfungsi di semua paket melalui proses masuk.
402 pada POST /codes dari aplikasi OAuth
PenyebabPaket pengguna tidak mencakup hal yang diminta aplikasi (kode dinamis, domain).
SolusiBaca fitur GET /me terlebih dahulu dan sesuaikan: tetap buat kode (kode akan statis pada Free) atau beri tahu pengguna fitur yang diperlukan oleh paket.
403 insufficient_scope
PenyebabCakupan ditetapkan saat kunci dibuat. PerbaikanBuat kunci baru dengan cakupan yang Anda perlukan, lalu cabut kunci lama. Untuk OAuth, minta cakupan tersebut dalam permintaan authorize.
400 not_dynamic saat saya melakukan PATCH destination_data
PenyebabKodenya statis: jenis Wi-Fi/vCard/teks, atau kode yang dibuat dengan paket Free setelah satu kode dinamis gratis sudah digunakan.
PerbaikanUntuk url/phone/email/sms/location, lakukan POST /codes/:id/dynamic saat akun masih memiliki kuota, lalu unduh dan cetak ulang (gambarnya berubah). Kode Wi-Fi, vCard, dan teks tidak pernah bisa dinamis; buat kode url yang membuka halaman.
400 no_domain saat saya menetapkan slug
PenyebabNama tautan berada di domain Anda.
PerbaikanHubungkan dan verifikasi domain terlebih dahulu di halaman Account. Di qrflow.codes/q, jalurnya selalu berupa short_code.
409 conflict pada slug
PenyebabKode lain milik Anda menggunakan nama tersebut.
PerbaikanLakukan GET /codes?q= untuk menemukannya, atau pilih nama lain. Nama berlaku per akun, bukan secara global.
Kesalahan CORS di konsol browser
PenyebabAPI hanya menerima panggilan server-ke-server (dan Canva). Ini disengaja: kunci di halaman web berarti kunci tersebut bocor.
PerbaikanPindahkan panggilan ke route handler, server action, edge function, atau backend, lalu panggil dari halaman.
Gambar menampilkan tanda QRFLOW
PenyebabKode dibuat oleh seseorang yang belum masuk. Tanda tersebut hanya untuk unduhan anonim.
PerbaikanAkun apa pun akan menghapusnya, termasuk akun gratis. Gambar untuk kode tersimpan tidak pernah menampilkan tanda tersebut.
short_url masih menampilkan qrflow.codes/q/… setelah saya menambahkan domain
PenyebabDomain belum diverifikasi, atau CNAME-nya salah.
PerbaikanPeriksa status di halaman Account atau lakukan GET /domains (status harus verified). Kode yang sudah ada akan beralih secara otomatis setelah domain terverifikasi.
image_url menghasilkan 401 dalam tag <img>
PenyebabURL tersebut memerlukan header Authorization, yang tidak dapat dikirim oleh <img>.
PerbaikanGunakan svg_download_url atau png_download_url dari objek Code yang sama: tautan bertanda tangan yang berfungsi selama 24 jam tanpa header. Untuk penggunaan permanen, teruskan image_url melalui server Anda (lihat resep Next.js) atau enkode short_url sendiri.
Saya memerlukan PNG, bukan SVG
PenyebabSVG menyertakan bingkai dan logo; PNG adalah kode polos.
PerbaikanGET /codes/:id/image.png (bearer atau png_download_url bertanda tangan) menghasilkan PNG berukuran 256 hingga 2048 px. Untuk PNG dengan bingkai, konversikan SVG menggunakan sharp atau resvg (sharp(svgBuffer).png().toBuffer()).
Asisten saya mengatakan endpoint gambar menolaknya lalu menggambar kodenya sendiri
PenyebabAsisten mengambil image_url, yang memerlukan bearer.
PerbaikanSetiap kode kini menyertakan png_download_url dan svg_download_url, dan get_qr_image mengembalikannya; asisten dapat menggunakan curl untuk mengambilnya tanpa masuk. Kode yang digambar secara lokal dan mengenkode short_url yang sama tetap berfungsi dan tetap menghitung pemindaian, tetapi tidak memiliki bingkai dan logo.
Webhook tidak pernah tiba
PenyebabAturan URL atau penerima.
PerbaikanURL harus berupa https di host publik (bukan localhost, IP privat, atau qrflow.codes). Tekan Test pada webhook: hasilnya menampilkan status yang dikirimkan server Anda. Peristiwa pemindaian dikirim secara berkelompok dan dapat memerlukan waktu hingga sekitar lima menit; peristiwa code.* dari dasbor juga masuk antrean selama beberapa menit, sedangkan penulisan melalui API dan MCP langsung dikirim.
Tanda tangan tidak pernah terverifikasi
PenyebabAnda menandatangani body yang diserialisasi ulang.
PerbaikanVerifikasi menggunakan byte mentah persis seperti yang Anda terima, sebelum parsing JSON. Di Express, gunakan express.raw({ type: 'application/json' }) pada route tersebut; di Next.js App Router, gunakan await req.text(); di Flask, gunakan request.get_data(). Lalu hitung HMAC-SHA256 dari ${t}.${raw}\.
Webhook mati dengan sendirinya
PenyebabDua puluh kegagalan berturut-turut.
PerbaikanPerbaiki penerima, lalu aktifkan kembali (Account › Webhooks, atau hapus dan buat ulang). Anda menerima email saat hal ini terjadi. Percobaan ulang yang masuk antrean akan dilanjutkan.
Pengiriman webhook duplikat
PenyebabRespons 2xx yang lambat (lebih dari 8 detik) dianggap gagal dan akan dicoba ulang.
PerbaikanKirim respons terlebih dahulu, lalu proses. Lakukan deduplikasi berdasarkan id pada payload, yang tetap sama di setiap percobaan ulang.
429 rate_limited saat impor
Penyebab600 permintaan per menit untuk setiap kunci.
PerbaikanGunakan POST /codes/bulk (2.000 kode dalam satu permintaan), bukan satu POST untuk setiap kode, atau tunggu selama jumlah detik yang ditentukan oleh Retry-After.
Saya menghapus kode dan poster yang sudah dicetak kini menampilkan 'Code not found'
PenyebabPenghapusan bersifat permanen dan mematikan tautan.
PerbaikanTidak dapat dibatalkan. Lain kali, gunakan PATCH { paused: true}; kode yang dijeda menampilkan halaman informatif dan dapat dilanjutkan kembali.
Kunci saya berhenti berfungsi setelah saya menurunkan paket
PenyebabKunci tetap berfungsi selama 30 hari setelah Anda meninggalkan Business, lalu menghasilkan 402.
PerbaikanBerlangganan kembali; tidak ada yang dihapus, dan kunci yang sama akan berfungsi lagi.
Ada hal yang tidak tercantum? Hubungi hello@qrflow.codes, sertakan permintaan persisnya dan kesalahan JSON yang Anda terima. Akun Business mendapat prioritas.
Batas dan penggunaan wajar
| Batas | |
|---|---|
| Permintaan per menit, per kunci | 600. Setelah itu, 429 dengan Retry-After. |
| Kunci per akun | 10 |
| Webhook per akun | 10 |
| Kode tersimpan (penggunaan wajar) | 1.000 Premium, 25.000 Business; API berhenti pada dua kali jumlah tersebut. |
| Bulk | 500/bulan (500 per permintaan) Premium; 10.000/bulan (2.000 per permintaan) Business. |
| Domain tautan | 1 Premium, 5 Business |
| Pemindaian | Tidak terbatas. Email pemberitahuan dikirim saat mencapai 100.000 pemindaian per kode per bulan pada Premium, 1.000.000 pada Business; tidak ada pembatasan laju. |
| Rentang waktu analitik pemindaian | 92 hari per permintaan |
| Ukuran halaman daftar | 100 (?limit=) |
| Label / keterangan / slug | 120 / 60 / 40 karakter |
| Batas waktu dan percobaan ulang webhook | 8 detik; percobaan ulang setelah 1, 5, 15, 60, 240, dan 720 menit; dinonaktifkan setelah 20 kegagalan berturut-turut. |
| Setelah meninggalkan Business | Kunci dan webhook tetap berfungsi selama 30 hari, lalu 402. Tidak ada yang dihapus. |
Penggunaan wajar adalah jumlah yang menjadi dasar penetapan harga paket. Tidak ada pembatasan laju pada jumlah tersebut; API berhenti pada dua kali jumlahnya dan seseorang akan mengirim email terlebih dahulu. Untuk volume yang lebih tinggi: hello@qrflow.codes.
Keamanan, untuk Anda dan orang-orang yang memindai
Cara QRFLOW melindungi akun Anda
- Kunci hanya ditampilkan sekali dan disimpan sebagai hash SHA-256. Tidak seorang pun di QRFLOW dapat membaca kembali kunci; jika Anda kehilangannya, buat kunci baru.
- Setiap permintaan dibatasi pada akun yang memiliki kunci tersebut. ID kode dari akun lain menghasilkan 404, tidak pernah membocorkan data.
- Cakupan ditetapkan untuk setiap kunci, sehingga kunci untuk dasbor pelaporan tidak dapat membuat atau menghapus kode.
- 600 permintaan per menit untuk setiap kunci; jika melebihi batas, responsnya adalah 429, bukan memperlambat layanan untuk semua orang.
- Tujuan menggunakan daftar izin: http, https, mailto, tel, sms, geo, dan daftar singkat skema aplikasi (whatsapp, tg, signal, spotify, app stores). javascript:, data:, dan file: ditolak saat pembuatan, sehingga integrasi yang disusupi tidak dapat mengubah kode Anda menjadi sarana serangan.
- URL webhook harus berupa https di host publik; QRFLOW tidak pernah menghubungi jaringan privat atau dirinya sendiri. Setiap pengiriman ditandatangani dan setiap payload memiliki id yang stabil.
- Klien OAuth mendaftar dengan PKCE S256 dan token terikat pada server tempat token diterbitkan; token untuk server MCP tidak dapat digunakan ulang pada REST API.
- Siapa pun dapat mencabut kunci atau memutuskan koneksi aplikasi di halaman Account; perubahan berlaku seketika.
Yang perlu Anda lakukan
- Gunakan variabel lingkungan, bukan kode sumber. Jika kunci masuk ke riwayat git, cabut kunci tersebut.
- Gunakan hanya di sisi server. API menolak origin browser, tetapi endpoint Anda sendiri yang membungkusnya juga perlu autentikasi, atau siapa pun dapat membuat kode dengan biaya yang dibebankan kepada Anda.
- Berikan setiap integrasi kuncinya sendiri dengan cakupan yang diperlukan, dan beri nama sesuai integrasinya. Dengan begitu, pencabutan hanya memengaruhi satu hal.
- Verifikasi tanda tangan webhook dan tolak timestamp yang lebih lama dari lima menit.
- Jika data pengguna Anda dimasukkan ke label atau tujuan, ingat bahwa QRFLOW menyimpannya; sebisa mungkin jangan masukkan data pribadi ke label.
Data yang dicatat dari pemindaian, dan yang tidak
- Setiap pengalihan menyimpan jenis perangkat, negara, kota, perujuk, browser, sistem operasi, dan bahasa yang diturunkan dari permintaan, serta hash satu arah dari kode + hari + IP + user agent agar pemilik dapat menghitung pengunjung unik. Hash tersebut tidak dapat dikembalikan menjadi alamat.
- Tidak ada cookie yang dipasang pada orang yang memindai dan alamat IP itu sendiri tidak disimpan bersama data pemindaian. Bot yang dikenal dan crawler pratinjau tautan dilewati.
- Menghapus kode akan menghapus data pemindaiannya. Menghapus akun akan menghapus semuanya.
- Teks lengkap: https://qrflow.codes/privacy dan https://qrflow.codes/terms.
Pembuatan versi dan stabilitas
Versi API tercantum di jalur: /api/v1. Dalam v1, kami menambahkan field, endpoint, jenis, dan peristiwa; kami tidak menghapus atau mengganti nama apa pun, dan kode Anda sebaiknya mengabaikan field yang tidak dikenal dalam respons.
Jika suatu perubahan harus merusak kompatibilitas v1, perubahan tersebut akan dirilis sebagai /api/v2 dan v1 akan tetap berjalan setidaknya selama dua belas bulan. Pemilik kunci akan menerima email tentang penghentian 90 hari sebelumnya.
Server MCP mengikuti aturan yang sama untuk tool-nya: argumen hanya ditambahkan, dan setiap tool mempertahankan namanya.
Dokumen OpenAPI di /api/v1/openapi.json dan Markdown di /llms-full.txt dibuat dari kode yang menjalankan API, sehingga keduanya menjelaskan apa yang tersedia saat ini.
Pertanyaan yang sering diajukan developer
Apakah saya harus membayar untuk menggunakan API QRFLOW?
Kunci API tersedia dengan paket Business, $29 per bulan, pembayaran bulanan. Server MCP (Claude, ChatGPT, Cursor, Claude Code) dan OAuth untuk aplikasi Anda sendiri dapat digunakan di semua paket melalui proses masuk, dan hal yang dapat dibuat mengikuti paket yang digunakan. GET /catalog, GET /frames, dan /preview.svg tidak memerlukan kunci.
Bisakah saya membuat kode QR gratis melalui API?
Tidak dengan kunci. Untuk gambar statis polos, generator gratis di qrflow.codes atau pustaka QR sumber terbuka apa pun sudah cukup. API ditujukan untuk kode dinamis, domain Anda sendiri, analitik, bulk, dan webhook, yang merupakan fitur akun berbayar.
Bisakah saya memanggil API dari browser?
Tidak. API menolak origin browser agar kunci tidak pernah masuk ke halaman web. Panggil API dari route handler, server action, edge function, atau backend, lalu panggil itu dari halaman Anda.
Format gambar apa yang tersedia?
SVG dengan warna, bingkai, keterangan, dan logo Anda (GET /codes/:id/image.svg, ukuran nominal 256 hingga 4096 px) serta PNG polos (GET /codes/:id/image.png, 256 hingga 2048 px). Keduanya menerima bearer, atau svg_download_url / png_download_url bertanda tangan yang disertakan pada setiap objek Code dan berfungsi selama 24 jam tanpa header. Tool MCP get_qr_image mengembalikan PNG secara inline beserta kedua tautan.
Bisakah saya mengubah kode QR setelah dicetak?
Ya, jika kodenya dinamis (url, phone, email, sms, location pada paket berbayar). Gunakan PATCH /codes/:id dengan destination_data baru; gambar tidak berubah, tetapi pemindaian berikutnya akan menuju tempat baru. Kode Wi-Fi, vCard, dan teks menyimpan kontennya di dalam gambar sehingga tidak dapat diubah.
Apa perbedaan antara short_url dan tujuan?
short_url adalah tautan di dalam gambar (go.example.com/menu). Tujuan adalah tempat pengalihan tautan tersebut (https://example.com/menu-fall). Anda mencetak short_url sekali dan dapat mengubah tujuan sesering yang Anda inginkan.
Bisakah kode menggunakan domain saya sendiri?
Ya. Premium dapat menghubungkan 1 domain, Business 5; tambahkan CNAME dan verifikasi di halaman Account. Business dapat memilih domain untuk setiap kode dengan domain_id. Nama tautan (slug) membuat jalur yang mudah dibaca di domain tersebut.
Informasi apa yang dicatat tentang orang yang memindai?
Jenis perangkat, negara, kota, perujuk, browser, sistem operasi, dan bahasa dari permintaan, serta hash harian satu arah untuk menghitung pengunjung unik. Tidak ada cookie dan alamat IP tidak disimpan. Cukup untuk membuat grafik, tetapi tidak cukup untuk mengidentifikasi siapa pun. Detail: https://qrflow.codes/privacy#scans
Apakah tersedia paket npm atau PyPI?
npm: npm install qrflow\ (https://www.npmjs.com/package/qrflow), tanpa dependensi, ESM dan CommonJS, tipe TypeScript lengkap, berjalan di Node 18+, Bun, Deno, dan Workers; paket ini membungkus setiap endpoint, mencoba ulang permintaan 429, serta menyertakan verifyWebhook/parseWebhook. Python: klien satu file di https://qrflow.codes/sdk/qrflow.py (hanya pustaka standar) dengan verify_webhook; paket PyPI akan menyusul.
Apakah ini berfungsi dengan Claude, ChatGPT, Cursor, dan Claude Code?
Ya. QRFLOW adalah server MCP di https://qrflow.codes/mcp. Tambahkan sebagai konektor, masuk sekali, lalu ajukan permintaan dengan bahasa biasa. Sebelas tool mencakup pembuatan, pengeditan, penjedaan, penamaan, bulk, analitik, gambar, dan domain.
Bisakah pengguna saya sendiri menghubungkan akun QRFLOW mereka ke aplikasi saya?
Ya, dengan OAuth 2.0. Daftarkan klien di /api/oauth/register (tidak perlu akun), arahkan pengguna ke /oauth/authorize dengan PKCE, lalu panggil API menggunakan token mereka. Kode akan masuk ke akun mereka sesuai paket yang digunakan.
Bagaimana cara menguji webhook di localhost?
Buka akses ke server pengembangan Anda melalui tunnel (cloudflared atau ngrok), lalu gunakan alamat https-nya sebagai URL webhook. Setelah itu, tekan Test di Account › Webhooks untuk menerima ping bertanda tangan. URL webhook harus berupa https publik; localhost dan alamat privat akan ditolak.
Apa yang terjadi pada integrasi saya jika saya membatalkan Business?
Kunci dan webhook tetap berfungsi selama 30 hari, lalu akan merespons dengan 402. Kode, pemindaian, dan domain tetap ada di akun. Berlangganan kembali akan mengaktifkan semuanya dengan kunci yang sama.
Bagaimana cara membuat kode ulasan Google, Instagram, Wi-Fi, atau PDF melalui API?
GET /catalog mencantumkan setiap jenis beserta kolomnya. Lalu, POST /codes dengan type dan kolom untuk jenis tersebut, serta tambahkan subtype untuk jenis berikut: { type: 'url', destination_data: { subtype: 'googlereview', placeId: 'ChIJ…' } }, { type: 'wifi', destination_data: { ssid, password, encryption: 'WPA' } }, { type: 'url', destination_data: { subtype: 'instagram', handle: 'acme' } }.
Bisakah API mengunggah logo ke kode?
Belum. Tambahkan logo di dasbor; image.svg akan menyertakannya dan has_logo memberi tahu Anda bahwa logo sudah ada. Warna, bingkai, dan keterangan semuanya dapat diatur melalui API.
Apakah API ini stabil?
v1 hanya menambahkan fitur; tidak pernah menghapus atau mengganti nama. Perubahan yang tidak kompatibel akan dirilis sebagai v2, sementara v1 tetap tersedia setidaknya selama dua belas bulan, dengan pemberitahuan 90 hari sebelumnya melalui email.
Untuk agen, alat, dan asisten yang membaca ini
Dapat dibaca mesin
Semua yang ada di halaman ini tersedia dalam format yang dapat diambil oleh perangkat lunak. Semuanya dihasilkan dari kode yang menyajikan API, jadi informasinya selalu mutakhir.
| URL | Isinya | |
|---|---|---|
| llms-full.txt | https://qrflow.codes/llms-full.txt | Seluruh referensi ini dalam format Markdown: konsep, setiap endpoint, setiap alat MCP, resep, pemecahan masalah, dan FAQ. Dihasilkan dari sumber yang sama dengan halaman ini. |
| developers.md | https://qrflow.codes/developers.md | Dokumen yang sama, untuk alat yang mengambil a.md. |
| llms.txt | https://qrflow.codes/llms.txt | Indeks situs untuk asisten, yang mengarahkan ke sini. |
| API dalam satu halaman | https://qrflow.codes/qr-code-api | Fungsi API, kapan pustaka sisi klien menjadi pilihan yang lebih baik, dan biayanya. Versi ringkas referensi ini, untuk membantu mengambil keputusan, bukan membangun. |
| openapi.json | https://qrflow.codes/api/v1/openapi.json | OpenAPI 3.1. Impor ke Postman, Insomnia, generator kode, atau ChatGPT Action. |
| Server MCP | https://qrflow.codes/mcp | Streamable HTTP, OAuth dengan pendaftaran dinamis atau kunci Business sebagai bearer. |
| server.json | https://qrflow.codes/.well-known/mcp/server.json | Manifes registri MCP. |
| Penemuan OAuth | https://qrflow.codes/.well-known/oauth-authorization-server | Metadata RFC 8414; dokumen protected-resource berada di sebelahnya. |
| Paket npm | https://www.npmjs.com/package/qrflow | npm install qrflow. Klien bertipe, tanpa dependensi, dengan verifikasi webhook. Klien Python satu file di https://qrflow.codes/sdk/qrflow.py. |
| GitHub | https://github.com/nativecodeapps/qrflow-sdk | Klien, snapshot OpenAPI, dan contoh siap dijalankan untuk webhook Next.js, Workers, Express, FastAPI, dan Flask. Masukan dan PR dipersilakan. |
Pertanyaan, ide, atau jenis kode yang sebaiknya kami tambahkan: hello@qrflow.codes. Ketentuan: /terms. Privasi: /privacy.