Kod QR

Cipta kod QR dengan logo, warna, gaya dan jenis kandungan, kemudian senaraikan atau kemas kini.

Jenis yang disokong

Hantar type sebagai salah satu kunci ini. Medan kandungan berubah mengikut jenis.

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

Cipta kod QR

Hantar JSON dalam badan permintaan. name dan type diperlukan. Untuk jenis url, hantar url. Tambah style, warna dan qr_code_logo untuk menandingi kod yang direka di studio. Jenis file tidak tersedia pada API.

Nama	Jenis	Diperlukan	Lalai	Penerangan
name	string	Ya	—	Label yang disimpan pada sumber.
type	string	Ya	url	Jenis kandungan. Salah satu kunci QR yang disokong, kecuali file.
url	string	Tidak	—	URL destinasi. Diperlukan apabila type ialah url.
text	string	Tidak	—	Teks biasa. Diperlukan apabila type ialah text. Untuk teks pukal, asingkan baris dalam medan ini.
url_dynamic	boolean	Tidak	false	Jika true, pautan pendek dicipta dan QR mengekod pautan itu supaya destinasi boleh diubah kemudian.
project_id	integer	Tidak	—	Projek untuk melampirkan sumber.
is_bulk	boolean	Tidak	false	Jika true dan type ialah text, satu QR dicipta bagi setiap baris dalam text.
style	string	Tidak	square	Bentuk modul. Contoh: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Tidak	square	Bentuk corak pencari dalam. Contoh: square, dot, circle, rounded.
outer_eye_style	string	Tidak	square	Bentuk corak pencari luar. Contoh: square, circle, rounded, flower.
size	integer	Tidak	500	Saiz imej dalam piksel, 50–2000.
margin	integer	Tidak	0	Modul zon senyap, 0–25.
ecc	string	Tidak	M	Pembetulan ralat: L, M, Q atau H. Guna H apabila menambah logo.
foreground_type	string	Tidak	color	color atau gradient.
foreground_color	string	Tidak	#000000	Warna modul sebagai HEX.
foreground_gradient_style	string	Tidak	horizontal	vertical, horizontal, diagonal, inverse_diagonal atau radial.
foreground_gradient_one	string	Tidak	—	Warna HEX kecerunan pertama.
foreground_gradient_two	string	Tidak	—	Warna HEX kecerunan kedua.
background_color	string	Tidak	#ffffff	Warna HEX latar. Kekalkan lebih cerah daripada modul.
background_color_transparency	integer	Tidak	0	Ketelusan latar, 0–100.
custom_eyes_color	boolean	Tidak	false	Jika true, mata menggunakan eyes_inner_color dan eyes_outer_color.
eyes_inner_color	string	Tidak	#000000	Warna HEX mata dalam.
eyes_outer_color	string	Tidak	#000000	Warna HEX mata luar.
qr_code_logo	string	Tidak	—	URL imej logo atau kunci fail yang dimuat naik.
qr_code_logo_size	number	Tidak	25	Saiz logo sebagai peratus QR, 5–40.
frame	string	Tidak	—	Kunci bingkai pilihan daripada studio.
frame_text	string	Tidak	—	Kapsyen dilukis pada bingkai.

Medan kandungan mengikut jenis

Nama	Jenis	Diperlukan	Lalai	Penerangan
phone	string	Tidak	—	Nombor telefon apabila type ialah phone.
sms	string	Tidak	—	Nombor telefon apabila type ialah sms.
sms_body	string	Tidak	—	Badan mesej SMS.
email	string	Tidak	—	Penerima apabila type ialah email.
email_subject	string	Tidak	—	Subjek e-mel.
email_body	string	Tidak	—	Badan e-mel.
whatsapp	string	Tidak	—	Nombor WhatsApp, digit sahaja.
whatsapp_body	string	Tidak	—	Teks WhatsApp yang telah diisi.
wifi_ssid	string	Tidak	—	Nama rangkaian apabila type ialah wifi.
wifi_password	string	Tidak	—	Kata laluan Wi-Fi.
wifi_encryption	string	Tidak	WPA	nopass, WEP, WPA atau WPA/WPA2.
location_latitude	number	Tidak	—	Latitud apabila type ialah location.
location_longitude	number	Tidak	—	Longitud apabila type ialah location.
event	string	Tidak	—	Tajuk acara apabila type ialah event.
event_start_datetime	string	Tidak	—	Tarikh-masa ISO untuk mula acara.
vcard first_name / last_name / email	string	Tidak	—	Medan vCard: first_name, last_name, email dan kunci studio lain.

Contoh permintaan

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "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
}'

Contoh lanjut

QR kecerunan

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

QR Wi-Fi

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

Contoh respons

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

Senaraikan kod QR

Nama	Jenis	Diperlukan	Penerangan
page	integer	Tidak	Page number (default 1)
results_per_page	integer	Tidak	Items per page (default 25, max 100)
search	string	Tidak	Search term
search_by	string	Tidak	Column to search
order_by	string	Tidak	Sort column
order_type	string	Tidak	asc or desc
datetime_start	string	Tidak	ISO datetime filter start
datetime_end	string	Tidak	ISO datetime filter end
project_id	integer	Tidak	—
type	string	Tidak	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

Baca satu kod QR

Nama	Jenis	Diperlukan	Penerangan
id	integer	Ya	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

Kemas kini kod QR

Nama	Jenis	Diperlukan	Lalai	Penerangan
id	integer	Ya	—	—
name	string	Tidak	—	Label yang disimpan pada sumber.
type	string	Tidak	url	Jenis kandungan. Salah satu kunci QR yang disokong, kecuali file.
url	string	Tidak	—	URL destinasi. Diperlukan apabila type ialah url.
text	string	Tidak	—	Teks biasa. Diperlukan apabila type ialah text. Untuk teks pukal, asingkan baris dalam medan ini.
url_dynamic	boolean	Tidak	false	Jika true, pautan pendek dicipta dan QR mengekod pautan itu supaya destinasi boleh diubah kemudian.
project_id	integer	Tidak	—	Projek untuk melampirkan sumber.
is_bulk	boolean	Tidak	false	Jika true dan type ialah text, satu QR dicipta bagi setiap baris dalam text.
style	string	Tidak	square	Bentuk modul. Contoh: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Tidak	square	Bentuk corak pencari dalam. Contoh: square, dot, circle, rounded.
outer_eye_style	string	Tidak	square	Bentuk corak pencari luar. Contoh: square, circle, rounded, flower.
size	integer	Tidak	500	Saiz imej dalam piksel, 50–2000.
margin	integer	Tidak	0	Modul zon senyap, 0–25.
ecc	string	Tidak	M	Pembetulan ralat: L, M, Q atau H. Guna H apabila menambah logo.
foreground_type	string	Tidak	color	color atau gradient.
foreground_color	string	Tidak	#000000	Warna modul sebagai HEX.
foreground_gradient_style	string	Tidak	horizontal	vertical, horizontal, diagonal, inverse_diagonal atau radial.
foreground_gradient_one	string	Tidak	—	Warna HEX kecerunan pertama.
foreground_gradient_two	string	Tidak	—	Warna HEX kecerunan kedua.
background_color	string	Tidak	#ffffff	Warna HEX latar. Kekalkan lebih cerah daripada modul.
background_color_transparency	integer	Tidak	0	Ketelusan latar, 0–100.
custom_eyes_color	boolean	Tidak	false	Jika true, mata menggunakan eyes_inner_color dan eyes_outer_color.
eyes_inner_color	string	Tidak	#000000	Warna HEX mata dalam.
eyes_outer_color	string	Tidak	#000000	Warna HEX mata luar.
qr_code_logo	string	Tidak	—	URL imej logo atau kunci fail yang dimuat naik.
qr_code_logo_size	number	Tidak	25	Saiz logo sebagai peratus QR, 5–40.
frame	string	Tidak	—	Kunci bingkai pilihan daripada studio.
frame_text	string	Tidak	—	Kapsyen dilukis pada bingkai.

Contoh permintaan

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

Padam kod QR

Nama	Jenis	Diperlukan	Penerangan
id	integer	Ya	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Nama parameter dan contoh JSON dipaparkan dalam bahasa Inggeris. Gantikan YOUR_API_KEY dengan kunci akaun anda.