Kode QR

Gawe kode QR karo logo, werna, gaya, lan jinis konten, banjur dhaptar utawa nganyari.

Jinis sing didhukung

Kirim type minangka salah siji kunci iki. Kolom konten ganti miturut jinis.

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

POST/api/v1/qr-codes

Gawe kode QR

Kirim JSON ing awak panjaluk. name lan type wajib. Kanggo jinis url, kirimake url. Tambahake style, werna, lan qr_code_logo supaya cocog karo kode saka studio. Jinis file ora kasedhiya ing API.

Jeneng	Jinis	Wajib	Bawaan	Katrangan
name	string	Ya	—	Label sing disimpen ing sumber daya.
type	string	Ya	url	Jinis konten. Salah siji kunci QR sing didhukung, kajaba file.
url	string	Ora	—	URL tujuan. Wajib nalika type iku url.
text	string	Ora	—	Teks biasa. Wajib nalika type iku text. Kanggo teks massal, pisahake baris ing kolom iki.
url_dynamic	boolean	Ora	false	Yen true, pranala cendhak digawe lan QR ngode pranala kasebut supaya tujuan bisa diganti mengko.
project_id	integer	Ora	—	Proyek kanggo masang sumber daya.
is_bulk	boolean	Ora	false	Yen true lan type iku text, siji QR digawe saben baris ing text.
style	string	Ora	square	Wangun modul. Conto: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Ora	square	Wangun pola pencari njero. Conto: square, dot, circle, rounded.
outer_eye_style	string	Ora	square	Wangun pola pencari njaba. Conto: square, circle, rounded, flower.
size	integer	Ora	500	Ukuran gambar ing piksel, 50–2000.
margin	integer	Ora	0	Modul zona sepi, 0–25.
ecc	string	Ora	M	Koreksi kesalahan: L, M, Q, utawa H. Gunakake H nalika nambah logo.
foreground_type	string	Ora	color	color utawa gradient.
foreground_color	string	Ora	#000000	Werna modul minangka HEX.
foreground_gradient_style	string	Ora	horizontal	vertical, horizontal, diagonal, inverse_diagonal, utawa radial.
foreground_gradient_one	string	Ora	—	Werna HEX gradien kapisan.
foreground_gradient_two	string	Ora	—	Werna HEX gradien kapindho.
background_color	string	Ora	#ffffff	Werna HEX latar. Tetep luwih padhang tinimbang modul.
background_color_transparency	integer	Ora	0	Transparansi latar, 0–100.
custom_eyes_color	boolean	Ora	false	Yen true, mripat nggunakake eyes_inner_color lan eyes_outer_color.
eyes_inner_color	string	Ora	#000000	Werna HEX mripat njero.
eyes_outer_color	string	Ora	#000000	Werna HEX mripat njaba.
qr_code_logo	string	Ora	—	URL gambar logo utawa kunci berkas sing diunggah.
qr_code_logo_size	number	Ora	25	Ukuran logo minangka persen saka QR, 5–40.
frame	string	Ora	—	Kunci pigura opsional saka studio.
frame_text	string	Ora	—	Katrangan sing digambar ing pigura.

Kolom konten miturut jinis

Jeneng	Jinis	Wajib	Bawaan	Katrangan
phone	string	Ora	—	Nomer telpon nalika type iku phone.
sms	string	Ora	—	Nomer telpon nalika type iku sms.
sms_body	string	Ora	—	Isi pesen SMS.
email	string	Ora	—	Panampa nalika type iku email.
email_subject	string	Ora	—	Judhul email.
email_body	string	Ora	—	Isi email.
whatsapp	string	Ora	—	Nomer WhatsApp, mung angka.
whatsapp_body	string	Ora	—	Teks WhatsApp sing wis diisi.
wifi_ssid	string	Ora	—	Jeneng jaringan nalika type iku wifi.
wifi_password	string	Ora	—	Tembung sandhi Wi-Fi.
wifi_encryption	string	Ora	WPA	nopass, WEP, WPA, utawa WPA/WPA2.
location_latitude	number	Ora	—	Lintang nalika type iku location.
location_longitude	number	Ora	—	Bujur nalika type iku location.
event	string	Ora	—	Judhul acara nalika type iku event.
event_start_datetime	string	Ora	—	Tanggal-wektu ISO kanggo wiwitan acara.
vcard first_name / last_name / email	string	Ora	—	Kolom vCard: first_name, last_name, email, lan kunci studio liyane.

Conto panjaluk

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
}'

Conto liyane

QR gradien

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"
}'

Conto tanggapan

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

Dhaptar kode QR

Jeneng	Jinis	Wajib	Katrangan
page	integer	Ora	Page number (default 1)
results_per_page	integer	Ora	Items per page (default 25, max 100)
search	string	Ora	Search term
search_by	string	Ora	Column to search
order_by	string	Ora	Sort column
order_type	string	Ora	asc or desc
datetime_start	string	Ora	ISO datetime filter start
datetime_end	string	Ora	ISO datetime filter end
project_id	integer	Ora	—
type	string	Ora	—

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

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

Waca siji kode QR

Jeneng	Jinis	Wajib	Katrangan
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}

Anyari kode QR

Jeneng	Jinis	Wajib	Bawaan	Katrangan
id	integer	Ya	—	—
name	string	Ora	—	Label sing disimpen ing sumber daya.
type	string	Ora	url	Jinis konten. Salah siji kunci QR sing didhukung, kajaba file.
url	string	Ora	—	URL tujuan. Wajib nalika type iku url.
text	string	Ora	—	Teks biasa. Wajib nalika type iku text. Kanggo teks massal, pisahake baris ing kolom iki.
url_dynamic	boolean	Ora	false	Yen true, pranala cendhak digawe lan QR ngode pranala kasebut supaya tujuan bisa diganti mengko.
project_id	integer	Ora	—	Proyek kanggo masang sumber daya.
is_bulk	boolean	Ora	false	Yen true lan type iku text, siji QR digawe saben baris ing text.
style	string	Ora	square	Wangun modul. Conto: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Ora	square	Wangun pola pencari njero. Conto: square, dot, circle, rounded.
outer_eye_style	string	Ora	square	Wangun pola pencari njaba. Conto: square, circle, rounded, flower.
size	integer	Ora	500	Ukuran gambar ing piksel, 50–2000.
margin	integer	Ora	0	Modul zona sepi, 0–25.
ecc	string	Ora	M	Koreksi kesalahan: L, M, Q, utawa H. Gunakake H nalika nambah logo.
foreground_type	string	Ora	color	color utawa gradient.
foreground_color	string	Ora	#000000	Werna modul minangka HEX.
foreground_gradient_style	string	Ora	horizontal	vertical, horizontal, diagonal, inverse_diagonal, utawa radial.
foreground_gradient_one	string	Ora	—	Werna HEX gradien kapisan.
foreground_gradient_two	string	Ora	—	Werna HEX gradien kapindho.
background_color	string	Ora	#ffffff	Werna HEX latar. Tetep luwih padhang tinimbang modul.
background_color_transparency	integer	Ora	0	Transparansi latar, 0–100.
custom_eyes_color	boolean	Ora	false	Yen true, mripat nggunakake eyes_inner_color lan eyes_outer_color.
eyes_inner_color	string	Ora	#000000	Werna HEX mripat njero.
eyes_outer_color	string	Ora	#000000	Werna HEX mripat njaba.
qr_code_logo	string	Ora	—	URL gambar logo utawa kunci berkas sing diunggah.
qr_code_logo_size	number	Ora	25	Ukuran logo minangka persen saka QR, 5–40.
frame	string	Ora	—	Kunci pigura opsional saka studio.
frame_text	string	Ora	—	Katrangan sing digambar ing pigura.

Conto panjaluk

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}

Busak kode QR

Jeneng	Jinis	Wajib	Katrangan
id	integer	Ya	—

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

Jeneng parameter lan conto JSON ditampilake ing basa Inggris. Ganti YOUR_API_KEY karo kunci akun sampeyan.