Dokumentasi API

Cipta kod QR dan kod bar daripada produk anda dengan REST API. Hantar JSON ke /api/v1, terima karya SVG yang dihoskan, kemudian senaraikan atau kemas kini sumber yang sama.

Cipta kod QR

POST /api/v1/qr-codes dengan type, kandungan dan reka bentuk pilihan: warna, gaya modul, logo, mata dan bingkai. Respons merangkumi URL SVG yang dihoskan.

{
  "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 cipta QR

Cipta kod bar

POST /api/v1/barcodes dengan simbologi, value serta warna atau saiz pilihan. Tiga puluh empat jenis tersedia, daripada Code 128 hingga 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 cipta kod bar

Pengesahan

Hantar kunci API sebagai token Bearer dalam setiap permintaan. Lihat atau jana semula di Papan Pemuka → Akaun → API.

Authorization: Bearer YOUR_API_KEY

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

Had kadar

Setiap kunci API dihadkan kepada 60 permintaan seminit. Respons termasuk header X-RateLimit-Limit, X-RateLimit-Remaining dan X-RateLimit-Reset.

Ralat

Ralat menggunakan format JSON:API:

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

Ralat pengesahan mungkin termasuk source.pointer.