API pembaruan QR Code
Digunakan untuk memperbarui konfigurasi dan desain QR code yang sudah ada.
Anda dapat mengubah URL, teks, nomor telepon, serta warna, gaya, logo, dan berbagai opsi lainnya. QR code akan diperbarui langsung tanpa perlu dibuat ulang.
Gunakan API ini jika ingin mengubah pengaturan tanpa membuat QR code baru.
/api/link/v1/update/qr
{
"linkId": "K56t",
"domain": "https://vvd.bz",
"type": "url",
"url": "https://www.instagram.com/vivoldiglobal",
"logoType": "U",
"logo": "https://example.com/images/picture/logo/20260425/500x500.png",
"foreground": "#0269D1FF"
}
Request Parameters
- linkId string required
-
ID link.
Jika URL adalah “https://vvd.im/myBrandQR”, maka ID link adalah
myBrandQR. - domain string required
- Default:https://vvd.bz
- Domain link. Jika menggunakan domain kustom, Anda dapat menentukannya di sini.
- type string
-
Enum:
urltextphoneemailsmswifi
-
Tipe QR code.
- url: URL website
- text: Teks
- phone: Nomor telepon
- email: Email (penerima, subjek, isi)
- sms: SMS (nomor penerima, pesan)
- wifi: Akses Wi-Fi (nama jaringan, keamanan, kata sandi)
Jika
typedihilangkan, tipe saat ini tetap digunakan. Hanya saat mengubahtypeke tipe lain Anda harus mengirim juga kolom wajib untuk tipe baru; untuk tipe yang sama, cukup kirim kolom yang ingin diubah. Kolom yang tidak dikirim tetap menggunakan nilai saat ini. Nama kolom lamaqrEml,qrEmlTtl,qrEmlBody,qrSmsPhnNo,qrSmsBody,qrWifiSsid,qrWifiEncrypt,qrWifiPwdmasih diterima tetapi akan dihapus. Gunakan nama di atas. Mengirim kolom yang sama dengan kedua nama akan menghasilkan error 400. - url string
-
URL tujuan saat QR dipindai.
Wajib jika
typeadalahurl. Harus berupa URL lengkap http atau https.
Maksimum2,000 bytes.
Saat pembaruan, kolom ini wajib hanya jika mengubah ke tipe tersebut; jika tipenya tetap, kolom ini boleh dihilangkan (nilai saat ini tetap digunakan). - text string
-
Teks yang dimasukkan ke dalam QR code.
Digunakan saat
typeadalahtextdan akan ditampilkan langsung saat dipindai.
Cocok untuk pesan, kode, atau instruksi. Tampilan bisa berbeda tergantung perangkat.
Maksimum65,535 bytes. - phone string
-
Nomor telepon yang dihubungkan saat QR dipindai.
Digunakan saat
typeadalahphonedan akan membuka layar panggilan.
Maksimum32 karakter. Disarankan menyertakan kode negara.
Jikatypeadalahsms, ini adalah nomor penerima pesan dan wajib diisi. Tanda hubung (-) dihapus saat disimpan.
Saat pembaruan, kolom ini wajib hanya jika mengubah ke tipe tersebut; jika tipenya tetap, kolom ini boleh dihilangkan (nilai saat ini tetap digunakan). - email string
-
Alamat penerima email yang dibuat saat dipindai.
Wajib jikatypeadalahemail. Panjang maksimum:128 karakter.
Saat pembaruan, kolom ini wajib hanya jika mengubah ke tipe tersebut; jika tipenya tetap, kolom ini boleh dihilangkan (nilai saat ini tetap digunakan). - emailSubject string
-
Subjek email. Digunakan jika
typeadalahemail. Panjang maksimum:256 karakter. Saat pembaruan, mengirim string kosong akan mengosongkan nilai. - emailBody string
-
Isi email. Digunakan jika
typeadalahemail. Panjang maksimum:65,535 bytes. Saat pembaruan, mengirim string kosong akan mengosongkan nilai. - message string
-
Isi pesan SMS. Digunakan jika
typeadalahsms; kirim nomor penerima diphone.
Panjang maksimum:128 karakter. Saat pembaruan, mengirim string kosong akan mengosongkan nilai. - wifiSsid string
-
Nama jaringan Wi-Fi (SSID). Wajib jika
typeadalahwifi. Panjang maksimum:64 karakter.
Saat pembaruan, kolom ini wajib hanya jika mengubah ke tipe tersebut; jika tipenya tetap, kolom ini boleh dihilangkan (nilai saat ini tetap digunakan). - wifiEncryption string
-
Enum:
WPAWEPnopass
-
Jenis keamanan Wi-Fi. Digunakan jika
typeadalahwifi.- WPA: WPA/WPA2/WPA3
- WEP: WEP
- nopass: Tanpa kata sandi
wifi, nilainyaWPAjika dihilangkan; jika tipenya sudahwifi, nilai saat ini tetap digunakan. - wifiPassword string
-
Kata sandi Wi-Fi. Digunakan jika
typeadalahwifi; spasi di awal dan akhir dihapus saat disimpan.
Panjang maksimum:32 karakter. Biarkan kosong jika keamanannyanopass. Saat pembaruan, mengirim string kosong akan mengosongkan nilai. - logoType string
- Default:N
-
Enum:
NCU
-
Tipe logo di tengah QR code.
- N: Tanpa logo
- C: Logo default organisasi
- U: Logo upload pengguna
Logo meningkatkan brand awareness.
Fitur ini tersedia mulai paket Personal. - logo string
-
URL gambar logo di tengah QR code.
Digunakan saat
logoTypeadalahU. Harus dapat diakses publik.
Disarankan berbentuk persegi dan PNG transparan.
Maksimum 500x500 px. - foreground string
-
Warna utama QR code (HEX). Default hitam.
Pastikan kontras cukup dengan background.
Default: #000000FF - background string
-
Warna background QR code (HEX). Default putih.
Background terlalu gelap dapat menurunkan akurasi scan.
Default: #FFFFFFFF - markerColor string
-
Warna marker posisi QR code.
Default: #000000FF - markerBorderColor string
-
Warna border marker.
Default: #000000FF - style string
- Gaya visual QR code. Lihat preview di dashboard.
- markerStyle string
- Gaya marker QR code. Mendukung berbagai bentuk.
- grpIdx integer
- ID grup untuk manajemen QR code.
- ttl string
- Judul internal.
- memo string
- Catatan internal (tidak terlihat oleh pengguna).
- qrBypassYn string
-
Y: langsung ke URL (tanpa tracking)
N: lewat short link (tracking aktif) - pushNotifyYn string
- Notifikasi push saat scan.
- mailNotifyYn string
- Notifikasi email saat scan.
- delYmdt datetime
- Tanggal penghapusan otomatis.
{
"code": 0,
"message": "",
"result": null
}
Response Parameters
- code integer
- Kode respons: 0 = Berhasil, nilai lainnya = Error
- message string
- Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
- result null
Kapan menggunakan API ini
Gunakan API pembaruan QR Code dalam situasi berikut:
- Saat perlu mengubah URL tujuan dari QR code yang sudah didistribusikan
- Saat ingin memperbarui desain seperti warna, logo, atau gaya
- Saat ingin mengubah konten atau pengaturan tanpa menghapus QR code
- Saat perlu memperbarui desain QR dalam skala besar, misalnya saat rebranding
sehingga Anda dapat memperbarui konten tanpa mengganti QR yang sudah dicetak atau digunakan pada media offline.
Contoh penggunaan
API pembaruan QR Code cocok untuk berbagai kebutuhan:
- Media cetak & banner: Ubah hanya URL tujuan dari QR yang sudah didistribusikan untuk menghemat biaya cetak ulang
- Rebranding: Perbarui desain QR secara massal mengikuti warna brand terbaru
- Operasional event: Ganti halaman tujuan sesuai periode tanpa mengubah QR
- Toko & meja: Arahkan QR yang sudah ada ke halaman menu baru saat terjadi perubahan
Cocok digunakan saat QR code yang sudah tersebar perlu tetap dimanfaatkan.
Hal yang perlu diperhatikan
Perhatikan hal berikut saat memperbarui QR code:
-
Ubah
foreground(warna utama) danbackground(warna latar) secara bersamaan.
Mengubah hanya latar dapat menurunkan akurasi pemindaian karena kurangnya kontras. -
Gunakan
backgroundterang seperti #FFFFFF (putih).
Latar gelap dapat membuat pola QR sulit dikenali. - Saat mengubah
type, sertakan parameter data yang sesuai. - Mengubah grup dengan
grpIdxakan memindahkan QR ke grup baru dan menghapusnya dari grup sebelumnya.