Dokumentasi API

Gawe kode QR lan barcode saka produk sampeyan nganggo REST API. Kirim JSON menyang /api/v1, entuk karya SVG sing dihosting, banjur dhaptar utawa nganyari sumber daya sing padha.

Gawe kode QR

POST /api/v1/qr-codes karo type, konten, lan desain opsional: werna, gaya modul, logo, mripat, lan pigura. Respons nyakup URL SVG sing dihosting.

{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}
Rujukan nggawe QR

Gawe barcode

POST /api/v1/barcodes karo simbologi, value, lan werna utawa ukuran opsional. Ana telung puluh papat jinis, saka Code 128 nganti EAN-13.

{
  "name": "Product SKU",
  "type": "C128",
  "value": "FORQR-1001",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "width_scale": 2,
  "height": 80,
  "display_text": true
}
Rujukan nggawe barcode

Autentikasi

Kirim kunci API minangka token Bearer ing saben panjaluk. Deleng utawa gawe maneh ing Dasbor → Akun → API.

Authorization: Bearer YOUR_API_KEY

URL dasar: https://forqrcode.com/api/v1

Watesan laju

Saben kunci API diwatesi 60 panjaluk per menit. Tanggapan kalebu header X-RateLimit-Limit, X-RateLimit-Remaining, lan X-RateLimit-Reset.

Kesalahan

Kesalahan nggunakake format JSON:API:

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

Kesalahan validasi bisa uga ngemot source.pointer.