Panduan API QR Code Developer
API QR Code memungkinkan pengguna untuk menghasilkan kode QR berkualitas tinggi secara programatik, atau mengintegrasikan pembuatan QR Code dalam jumlah besar dengan cepat. Ini menyediakan cara yang sederhana dan efisien untuk membuat QR Code untuk berbagai kasus penggunaan, seperti pembayaran otomatis, integrasi ke aplikasi, pembuatan label produk, dan masih banyak lagi. API ini mendukung berbagai opsi kustomisasi, termasuk ukuran, warna, bentuk, batas, jenis, dll. Pengembang dapat mengintegrasikannya ke dalam aplikasi mereka dengan melakukan permintaan HTTP dan menyediakan kunci API untuk otentikasi, atau menggunakan pustaka kami.
Kunci API
Kunci API untuk akun Anda dapat dibuat di halaman akun. Kunci API dapat disertakan dalam permintaan baik sebagai parameter URL, misalnya: https://genqrcode.com/api/public/generate?apikey=YOUR_API_KEY, atau dalam header GenQRCode-apikey. Untuk sisa panduan ini, kami akan menganggap penggunaan header, karena ini adalah opsi yang lebih aman, tetapi kedua metode dapat digunakan secara bergantian. Kunci API harus dianggap sebagai rahasia, dan Anda tidak boleh membagikannya dengan siapa pun.
Pembatasan laju
Pembatasan laju diterapkan untuk memastikan penggunaan API yang adil. Tingkat Gratis mencakup 180 token per jam. Kode QR normal memerlukan 1 token setiap satu, dengan batas maksimum 180 token per jam, yang setara dengan 1 QR Code setiap 20 detik. Selain itu, titik akhir panggilan cepat akan memakan 1/50 token, yang setara dengan 2,5 QR Code per detik. Titik akhir cepat ini disarankan ketika tidak ada kustomisasi kode QR yang diperlukan. Jika batas token terlampaui, kode status 429 akan dikembalikan, yang menunjukkan bahwa permintaan telah dibatasi kecepatannya.
Penggunaan beberapa akun untuk menghindari batas ini dilarang. Jika batas yang lebih tinggi dibutuhkan, silakan hubungi kami untuk harga.
Pustaka
API QR Code Statis
Jenis QR Code
Jenis QR Code adalah dasar dari setiap QR Code. Ini menentukan bagaimana data dikodekan dan bagaimana QR Code berperilaku saat dipindai. Memilih jenis yang tepat sangat penting, karena ini memengaruhi fungsionalitas QR Code Anda. Di bawah ini, Anda akan menemukan semua jenis yang tersedia untuk dipilih.
Text
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 0 For a Text QR Code |
text | String | false | Teks di dalam QR Code. |
WiFi
Parameter | Tipe | Opsional | Deskripsi | ||||||
---|---|---|---|---|---|---|---|---|---|
type | Int | false | Use 1 For a WiFi QR Code | ||||||
network | String | false | Nama jaringan Wi-Fi. | ||||||
password | String | true | Kata sandi Wi-Fi. | ||||||
hidden | String | true | Apakah jaringan Wi-Fi tersembunyi. | ||||||
encryption | String | true |
Enkripsi yang digunakan untuk jaringan Wi-Fi.
Nilai yang mungkin
|
SMS
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 2 For a SMS QR Code |
text | String | false | Pesan teks. |
number | String | false | Nomor telepon. |
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 3 For a Email QR Code |
String | true | Alamat email di kolom "Kepada". | |
subject | String | true | Subjek email. |
message | String | true | Pesan email. |
Phone
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 4 For a Phone QR Code |
number | String | false | Nomor telepon. |
Crypto
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 5 For a Crypto QR Code |
cryptotype | String | false | Tipe Crypto yang dikirim. |
address | String | false | Alamat Crypto penerima. |
amount | String | true | Jumlah crypto yang dikirim. |
vCard
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 6 For a vCard QR Code |
vc_first_name | String | false | Nama depan vCard. |
vc_last_name | String | false | Nama belakang vCard. |
vc_company | String | true | Perusahaan. |
vc_job | String | true | Pekerjaan. |
vc_street | String | true | Jalan. |
vc_city | String | true | Kota. |
vc_state | String | true | Provinsi. |
vc_zip | String | true | Kode pos. |
vc_country | String | true | Negara. |
vc_phone | String | true | Nomor telepon. |
vc_mobile | String | true | Nomor ponsel. |
vc_fax | String | true | Nomor faks. |
vc_website | String | true | URL situs web. |
vc_email | String | true | Alamat email. |
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 7 For a Whatsapp QR Code |
number | String | false | Nomor telepon. |
text | String | true | Pesan teks WhatsApp. |
vEvent
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 8 For a vEvent QR Code |
ve_summary | String | true | Ringkasan acara vEvent. |
ve_description | String | true | Deskripsi acara vEvent. |
ve_location | String | true | Lokasi acara vEvent. |
ve_timezone | String | true | Zona waktu mulai dan berakhirnya acara vEvent. Misalnya, gunakan "Asia/Jakarta" untuk zona waktu Jakarta. |
ve_url | String | true | URL acara vEvent. |
ve_start | String | true | Waktu mulai acara vEvent. Misalnya, gunakan "20250101T083000" untuk 1 Januari 2025 pukul 8:30. |
ve_end | String | true | Waktu berakhir acara vEvent. Misalnya, gunakan "20250101T093000" untuk 1 Januari 2025 pukul 9:30. |
Geo
Parameter | Tipe | Opsional | Deskripsi |
---|---|---|---|
type | Int | false | Use 9 For a Geo QR Code |
ge_latitude | String | false | Lintang untuk dienkode. |
ge_longitude | String | false | Bujur untuk dienkode. |
Contoh QR Code teks
URL | https://api.genqrcode.com/public/generate |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY |
Tubuh | { "type": 0, "text": "https://genqrcode.com" } |
Respon | ![]() |
Contoh QR Code Wi-Fi
URL | https://api.genqrcode.com/public/generate |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY |
Tubuh | { "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" } |
Respon | ![]() |
Parameter umum
Berikut adalah semua parameter umum yang dapat disesuaikan dan cara penggunaannya.
Parameter | Tipe | Nilai default | Deskripsi | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
imageformat | String | png |
Format gambar dari QR Code.
Nilai yang mungkin
|
||||||||||||||||||||
bordersize | Int | 4 | Ukuran batas di sekitar QR Code. | ||||||||||||||||||||
width | Int | 500 | Lebar QR Code. Ukuran maksimum 2000. | ||||||||||||||||||||
height | Int | 500 | Tinggi QR Code. Ukuran maksimum 2000. |
Parameter warna
Berikut adalah semua parameter warna yang dapat disesuaikan dan cara penggunaannya.
Parameter | Tipe | Nilai default | Deskripsi |
---|---|---|---|
color | String | #000000 | Warna QR Code. Format harus #RRGGBB atau #RRGGBBAA. Nilai RGBA dalam format heksadesimal, dari 00 hingga FF. |
custom_color_pattern | String | 1 | Pola warna yang digunakan. Misalnya, jika warnanya #ff0000, #00ff00, dan #0000ff, dan polanya 1,2,3,3,2,1, warna akan bergantian sesuai pola tersebut. Contoh akan diberikan nanti dalam panduan. |
background_color | String | #FFFFFF | Warna latar belakang QR Code. Untuk membuat latar belakang QR Code transparan, atur saluran alfa ke 00. Misalnya, #00000000. |
inner_eye_color | String | #000000 | Warna mata bagian dalam QR Code. |
outer_eye_color | String | #000000 | Warna mata bagian luar QR Code. |
frame_color | String | #000000 | Warna bingkai di sekitar QR Code. Bingkai harus diaktifkan agar ini berfungsi. |
Contoh QR Code berwarna
URL | https://api.genqrcode.com/public/generate |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY |
Tubuh | { "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" } |
Respon | ![]() |
Contoh QR Code dengan pola warna
URL | https://api.genqrcode.com/public/generate |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY |
Tubuh | { "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" } |
Respon | ![]() |
Parameter bingkai, bentuk, dan logo
Berikut adalah semua parameter bingkai, bentuk, dan logo yang dapat disesuaikan dan cara penggunaannya.
Parameter | Tipe | Nilai default | Deskripsi |
---|---|---|---|
style | Int | 0 |
Gaya kotak QR Code.
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
inner_eye_style | Int | 0 |
Gaya mata bagian dalam QR Code.
0
1
2
3
4
5
6
7
|
outer_eye_style | Int | 0 |
Gaya mata bagian luar QR Code.
0
1
2
3
4
5
6
|
frame_style | Int | 0 |
Gaya bingkai di sekitar QR Code.
0
1
2
3
4
5
6
7
8
9
10
11
12
13
|
frame_text | String | SCAN ME | Teks di dalam bingkai. Bingkai dengan teks harus dikonfigurasi sebelum ini terlihat. |
logo | String |
Logo yang digunakan di dalam QR Code.
youtube
![]()
wifi
![]()
google-maps
![]()
facebook
![]()
spotify
![]()
threads
![]()
zoom
![]()
instagram
![]()
linkedin
![]()
genqrcode
![]()
google-drive
![]()
airbnb
![]()
skype
![]()
snapchat
![]()
twitter
![]()
x-twitter
![]()
reddit
![]() |
|
logo_remove_background | Boolean | false | Apakah latar belakang di belakang logo harus dihapus. |
Contoh QR Code dengan logo dan bentuk
URL | https://api.genqrcode.com/public/generate |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY |
Tubuh | { "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true } |
Respon | ![]() |
Contoh logo kustom
Untuk menggunakan logo kustom, kita perlu mengunggah logo kita menggunakan permintaan data formulir multipart. Hasilnya dapat digunakan di bidang logo.
URL | https://api.genqrcode.com/public/upload/logo |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY Content-Type: multipart/form-data |
Respon | 586d0136af8a06e4a2b50cf9f2af0b72 |
API QR Code Cepat
API QR Code Cepat hanya memerlukan 1/50 token dari API normal. QR Code dioptimalkan untuk kecepatan dan ukuran unduhan. Meskipun mendukung semua Jenis QR Code, hanya beberapa parameter kustomisasi yang didukung.
Parameter QR Code Cepat
Berikut adalah semua parameter QR Code cepat yang dijelaskan dan cara penggunaannya.
Parameter | Tipe | Nilai default | Deskripsi | ||||
---|---|---|---|---|---|---|---|
imageformat | String | png |
Format gambar dari QR Code.
Nilai yang mungkin
|
||||
bordersize | Int | 4 | Ukuran batas di sekitar QR Code. | ||||
width | Int | 500 | Lebar QR Code. Akan secara otomatis menyesuaikan ke ukuran yang dikonfigurasi terdekat untuk menghindari artefak pemrosesan ulang. Ukuran maksimum 4000. | ||||
height | Int | 500 | Tinggi QR Code. Akan secara otomatis menyesuaikan ke ukuran yang dikonfigurasi terdekat untuk menghindari artefak pemrosesan ulang. Ukuran maksimum 4000. |
Contoh QR Code teks cepat
URL | https://api.genqrcode.com/public/fastgenerate |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY |
Tubuh | { "imageformat": "png", "type": 0, "text": "https://genqrcode.com" } |
Respon | ![]() |
API QR Code Batch Cepat
Contoh QR Code batch teks cepat
URL | https://api.genqrcode.com/public/fastbatch |
---|---|
Metode permintaan | POST |
Header | GenQRCode-apikey: API_KEY |
Tubuh | { "QR Code 1": { "text": "https://genqrcode.com", "type": 0, "width": 500, "bordersize": 4, "imageformat": "png", "height": 500 }, "QR Code 2": { "text": "https://genqrcode.com/dynamicview", "type": 0, "width": 500, "bordersize": 4, "imageformat": "png", "height": 500 }, "QR Code 3": { "text": "https://genqrcode.com/pricing", "type": 0, "width": 500, "bordersize": 4, "imageformat": "png", "height": 500 } } |
Respon | QR Codes in a zip file. |