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
  • pdf
  • image
  • audio
  • app
  • instagram
  • facebook
  • telegram
  • tiktok
  • twitter
  • linkedin
  • youtube
  • spotify
  • 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.

NamaTipeWajibBawaanDeskripsi
namestringYa—Label yang disimpan pada sumber daya.
typestringYaurlJenis konten. Salah satu kunci QR yang didukung, kecuali file.
urlstringTidak—URL tujuan. Wajib jika type adalah url.
textstringTidak—Teks biasa. Wajib jika type adalah text. Untuk teks massal, pisahkan baris di bidang ini.
url_dynamicbooleanTidakfalseJika true, tautan pendek dibuat dan QR mengkodekan tautan itu agar tujuan bisa diubah nanti.
project_idintegerTidak—Proyek tempat sumber daya dilampirkan.
is_bulkbooleanTidakfalseJika true dan type adalah text, satu QR dibuat per baris di text.
stylestringTidaksquareBentuk modul. Contoh: square, dot, rounded, heart, hexagon.
inner_eye_stylestringTidaksquareBentuk pola pencari dalam. Contoh: square, dot, circle, rounded.
outer_eye_stylestringTidaksquareBentuk pola pencari luar. Contoh: square, circle, rounded, flower.
sizeintegerTidak500Ukuran gambar dalam piksel, 50–2000.
marginintegerTidak0Modul zona tenang, 0–25.
eccstringTidakMKoreksi kesalahan: L, M, Q, atau H. Gunakan H saat menambahkan logo.
foreground_typestringTidakcolorcolor atau gradient.
foreground_colorstringTidak#000000Warna modul sebagai HEX.
foreground_gradient_stylestringTidakhorizontalvertical, horizontal, diagonal, inverse_diagonal, atau radial.
foreground_gradient_onestringTidak—Warna HEX gradien pertama.
foreground_gradient_twostringTidak—Warna HEX gradien kedua.
background_colorstringTidak#ffffffWarna HEX latar. Tetap lebih terang daripada modul.
background_color_transparencyintegerTidak0Transparansi latar, 0–100.
custom_eyes_colorbooleanTidakfalseJika true, mata memakai eyes_inner_color dan eyes_outer_color.
eyes_inner_colorstringTidak#000000Warna HEX mata dalam.
eyes_outer_colorstringTidak#000000Warna HEX mata luar.
qr_code_logostringTidak—URL gambar logo atau kunci file yang diunggah.
qr_code_logo_sizenumberTidak25Ukuran logo sebagai persen dari QR, 5–40.
framestringTidak—Kunci bingkai opsional dari studio.
frame_textstringTidak—Keterangan yang digambar pada bingkai.

Bidang konten menurut jenis

NamaTipeWajibBawaanDeskripsi
phonestringTidak—Nomor telepon jika type adalah phone.
smsstringTidak—Nomor telepon jika type adalah sms.
sms_bodystringTidak—Isi pesan SMS.
emailstringTidak—Penerima jika type adalah email.
email_subjectstringTidak—Subjek email.
email_bodystringTidak—Isi email.
whatsappstringTidak—Nomor WhatsApp, hanya digit.
whatsapp_bodystringTidak—Teks WhatsApp yang sudah terisi.
wifi_ssidstringTidak—Nama jaringan jika type adalah wifi.
wifi_passwordstringTidak—Kata sandi Wi-Fi.
wifi_encryptionstringTidakWPAnopass, WEP, WPA, atau WPA/WPA2.
location_latitudenumberTidak—Lintang jika type adalah location.
location_longitudenumberTidak—Bujur jika type adalah location.
eventstringTidak—Judul acara jika type adalah event.
event_start_datetimestringTidak—Tanggal-waktu ISO untuk awal acara.
vcard first_name / last_name / emailstringTidak—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
NamaTipeWajibDeskripsi
pageintegerTidakPage number (default 1)
results_per_pageintegerTidakItems per page (default 25, max 100)
searchstringTidakSearch term
search_bystringTidakColumn to search
order_bystringTidakSort column
order_typestringTidakasc or desc
datetime_startstringTidakISO datetime filter start
datetime_endstringTidakISO datetime filter end
project_idintegerTidak—
typestringTidak—
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
NamaTipeWajibDeskripsi
idintegerYa—
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
NamaTipeWajibBawaanDeskripsi
idintegerYa——
namestringTidak—Label yang disimpan pada sumber daya.
typestringTidakurlJenis konten. Salah satu kunci QR yang didukung, kecuali file.
urlstringTidak—URL tujuan. Wajib jika type adalah url.
textstringTidak—Teks biasa. Wajib jika type adalah text. Untuk teks massal, pisahkan baris di bidang ini.
url_dynamicbooleanTidakfalseJika true, tautan pendek dibuat dan QR mengkodekan tautan itu agar tujuan bisa diubah nanti.
project_idintegerTidak—Proyek tempat sumber daya dilampirkan.
is_bulkbooleanTidakfalseJika true dan type adalah text, satu QR dibuat per baris di text.
stylestringTidaksquareBentuk modul. Contoh: square, dot, rounded, heart, hexagon.
inner_eye_stylestringTidaksquareBentuk pola pencari dalam. Contoh: square, dot, circle, rounded.
outer_eye_stylestringTidaksquareBentuk pola pencari luar. Contoh: square, circle, rounded, flower.
sizeintegerTidak500Ukuran gambar dalam piksel, 50–2000.
marginintegerTidak0Modul zona tenang, 0–25.
eccstringTidakMKoreksi kesalahan: L, M, Q, atau H. Gunakan H saat menambahkan logo.
foreground_typestringTidakcolorcolor atau gradient.
foreground_colorstringTidak#000000Warna modul sebagai HEX.
foreground_gradient_stylestringTidakhorizontalvertical, horizontal, diagonal, inverse_diagonal, atau radial.
foreground_gradient_onestringTidak—Warna HEX gradien pertama.
foreground_gradient_twostringTidak—Warna HEX gradien kedua.
background_colorstringTidak#ffffffWarna HEX latar. Tetap lebih terang daripada modul.
background_color_transparencyintegerTidak0Transparansi latar, 0–100.
custom_eyes_colorbooleanTidakfalseJika true, mata memakai eyes_inner_color dan eyes_outer_color.
eyes_inner_colorstringTidak#000000Warna HEX mata dalam.
eyes_outer_colorstringTidak#000000Warna HEX mata luar.
qr_code_logostringTidak—URL gambar logo atau kunci file yang diunggah.
qr_code_logo_sizenumberTidak25Ukuran logo sebagai persen dari QR, 5–40.
framestringTidak—Kunci bingkai opsional dari studio.
frame_textstringTidak—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
NamaTipeWajibDeskripsi
idintegerYa—
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.