Kode QR

Buat kode QR dengan logo, warna, gaya, dan jenis konten, lalu daftar atau perbarui.

Jenis yang didukung

Kirim type sebagai salah satu kunci ini. Bidang konten berubah sesuai jenis.

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

POST/api/v1/qr-codes

Buat kode QR

Kirim JSON di badan permintaan. name dan type wajib. Untuk jenis url, kirimkan url. Tambahkan style, warna, dan qr_code_logo agar cocok dengan kode dari studio. Jenis file tidak tersedia di API.

Nama	Tipe	Wajib	Bawaan	Deskripsi
name	string	Ya	—	Label yang disimpan pada sumber daya.
type	string	Ya	url	Jenis konten. Salah satu kunci QR yang didukung, kecuali file.
url	string	Tidak	—	URL tujuan. Wajib jika type adalah url.
text	string	Tidak	—	Teks biasa. Wajib jika type adalah text. Untuk teks massal, pisahkan baris di bidang ini.
url_dynamic	boolean	Tidak	false	Jika true, tautan pendek dibuat dan QR mengkodekan tautan itu agar tujuan bisa diubah nanti.
project_id	integer	Tidak	—	Proyek tempat sumber daya dilampirkan.
is_bulk	boolean	Tidak	false	Jika true dan type adalah text, satu QR dibuat per baris di text.
style	string	Tidak	square	Bentuk modul. Contoh: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Tidak	square	Bentuk pola pencari dalam. Contoh: square, dot, circle, rounded.
outer_eye_style	string	Tidak	square	Bentuk pola pencari luar. Contoh: square, circle, rounded, flower.
size	integer	Tidak	500	Ukuran gambar dalam piksel, 50–2000.
margin	integer	Tidak	0	Modul zona tenang, 0–25.
ecc	string	Tidak	M	Koreksi kesalahan: L, M, Q, atau H. Gunakan H saat menambahkan 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 gradien pertama.
foreground_gradient_two	string	Tidak	—	Warna HEX gradien kedua.
background_color	string	Tidak	#ffffff	Warna HEX latar. Tetap lebih terang daripada modul.
background_color_transparency	integer	Tidak	0	Transparansi latar, 0–100.
custom_eyes_color	boolean	Tidak	false	Jika true, mata memakai 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 gambar logo atau kunci file yang diunggah.
qr_code_logo_size	number	Tidak	25	Ukuran logo sebagai persen dari QR, 5–40.
frame	string	Tidak	—	Kunci bingkai opsional dari studio.
frame_text	string	Tidak	—	Keterangan yang digambar pada bingkai.

Bidang konten menurut jenis

Nama	Tipe	Wajib	Bawaan	Deskripsi
phone	string	Tidak	—	Nomor telepon jika type adalah phone.
sms	string	Tidak	—	Nomor telepon jika type adalah sms.
sms_body	string	Tidak	—	Isi pesan SMS.
email	string	Tidak	—	Penerima jika type adalah email.
email_subject	string	Tidak	—	Subjek email.
email_body	string	Tidak	—	Isi email.
whatsapp	string	Tidak	—	Nomor WhatsApp, hanya digit.
whatsapp_body	string	Tidak	—	Teks WhatsApp yang sudah terisi.
wifi_ssid	string	Tidak	—	Nama jaringan jika type adalah wifi.
wifi_password	string	Tidak	—	Kata sandi Wi-Fi.
wifi_encryption	string	Tidak	WPA	nopass, WEP, WPA, atau WPA/WPA2.
location_latitude	number	Tidak	—	Lintang jika type adalah location.
location_longitude	number	Tidak	—	Bujur jika type adalah location.
event	string	Tidak	—	Judul acara jika type adalah event.
event_start_datetime	string	Tidak	—	Tanggal-waktu ISO untuk awal acara.
vcard first_name / last_name / email	string	Tidak	—	Bidang vCard: first_name, last_name, email, dan kunci studio lainnya.

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 lainnya

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

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

Daftar kode QR

Nama	Tipe	Wajib	Deskripsi
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 kode QR

Nama	Tipe	Wajib	Deskripsi
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}

Perbarui kode QR

Nama	Tipe	Wajib	Bawaan	Deskripsi
id	integer	Ya	—	—
name	string	Tidak	—	Label yang disimpan pada sumber daya.
type	string	Tidak	url	Jenis konten. Salah satu kunci QR yang didukung, kecuali file.
url	string	Tidak	—	URL tujuan. Wajib jika type adalah url.
text	string	Tidak	—	Teks biasa. Wajib jika type adalah text. Untuk teks massal, pisahkan baris di bidang ini.
url_dynamic	boolean	Tidak	false	Jika true, tautan pendek dibuat dan QR mengkodekan tautan itu agar tujuan bisa diubah nanti.
project_id	integer	Tidak	—	Proyek tempat sumber daya dilampirkan.
is_bulk	boolean	Tidak	false	Jika true dan type adalah text, satu QR dibuat per baris di text.
style	string	Tidak	square	Bentuk modul. Contoh: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Tidak	square	Bentuk pola pencari dalam. Contoh: square, dot, circle, rounded.
outer_eye_style	string	Tidak	square	Bentuk pola pencari luar. Contoh: square, circle, rounded, flower.
size	integer	Tidak	500	Ukuran gambar dalam piksel, 50–2000.
margin	integer	Tidak	0	Modul zona tenang, 0–25.
ecc	string	Tidak	M	Koreksi kesalahan: L, M, Q, atau H. Gunakan H saat menambahkan 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 gradien pertama.
foreground_gradient_two	string	Tidak	—	Warna HEX gradien kedua.
background_color	string	Tidak	#ffffff	Warna HEX latar. Tetap lebih terang daripada modul.
background_color_transparency	integer	Tidak	0	Transparansi latar, 0–100.
custom_eyes_color	boolean	Tidak	false	Jika true, mata memakai 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 gambar logo atau kunci file yang diunggah.
qr_code_logo_size	number	Tidak	25	Ukuran logo sebagai persen dari QR, 5–40.
frame	string	Tidak	—	Kunci bingkai opsional dari studio.
frame_text	string	Tidak	—	Keterangan yang digambar 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}

Hapus kode QR

Nama	Tipe	Wajib	Deskripsi
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 ditampilkan dalam bahasa Inggris. Ganti YOUR_API_KEY dengan kunci akun Anda.