Dokumentasi API
Kod QR
Senaraikan, periksa, cipta, kemas kini, dan padam kod QR anda.
Pengesahan
Setiap permintaan mesti menghantar pengepala Authorization dengan token Bearer yang sepadan dengan kunci API admin.
Dapatkan kunci API.
Titik akhir
GET https://rqrcode.com/api/qr-codes/
Contoh
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| page |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
Nombor halaman yang anda ingin dapatkan hasilnya. Lalai kepada 1. |
| results_per_page |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
Berapa banyak hasil yang anda mahu setiap halaman. Nilai yang dibenarkan ialah: 10, 25, 50, 100, 250, 500, 1000. Lalai kepada 25. |
Contoh respons
{
"data": [
{
"id": 1,
"type": "url",
"name": "Nama contoh",
"qr_code": "https://rqrcode.com/uploads/qr_code/example.svg",
"qr_code_logo": null,
"qr_code_background": null,
"settings": {
"foreground_type": "color",
"foreground_color": "#000000",
"background_color": "#ffffff",
"custom_eyes_color": false,
"qr_code_logo_size": 25,
"size": 500,
"margin": 0,
"ecc": "L",
"url": "https://example.com",
"...": "..."
},
"embedded_data": "https://example.com",
"last_datetime": null,
"datetime": "2026-04-20 07:52:15"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/qr-codes?page=1",
"last": "https://rqrcode.com/api/qr-codes?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/qr-codes?page=1"
}
}
Titik akhir
GET https://rqrcode.com/api/qr-codes/{qr_code_id}
Contoh
curl --request GET \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tiada parameter tambahan.
Contoh respons
{
"data": {
"id": 1,
"type": "url",
"name": "Nama contoh",
"qr_code": "https://rqrcode.com/uploads/qr_code/example.svg",
"qr_code_logo": null,
"qr_code_background": null,
"settings": {
"foreground_type": "color",
"foreground_color": "#000000",
"background_color": "#ffffff",
"custom_eyes_color": false,
"qr_code_logo_size": 25,
"size": 500,
"margin": 0,
"ecc": "L",
"url": "https://example.com",
"...": "..."
},
"embedded_data": "https://example.com",
"last_datetime": null,
"datetime": "2026-04-20 07:52:15"
}
}
Titik akhir
POST https://rqrcode.com/api/qr-codes
Contoh
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Contoh' \
--form 'type=text' \
--form 'text=Helo!'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| link_id |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| project_id |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| name |
Diperlukan
ui.admin.api_docs.common.types.Rentetan
|
- |
| type |
Diperlukan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| is_bulk |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
Tersedia apabila: type = text |
| style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: square, dot, round, rounded, elastic_square, heart, diamond, star, triangle, hexagon, spaced_square, octagon, cross_x, curvy_x, rounded_cross, ninja, sun, shine, bold_plus, teardrop, corner_cut, randomized_square, bold_x |
| inner_eye_style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: square, circle, rounded, flower, leaf |
| foreground_type |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: color, gradient |
| foreground_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: foreground_type = color |
| foreground_gradient_style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: foreground_type = gradient |
| foreground_gradient_two |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: foreground_type = gradient |
| background_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| background_color_transparency |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| custom_eyes_color |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| eyes_inner_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: custom_eyes_color = 1 |
| eyes_outer_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: custom_eyes_color = 1 |
| qr_code_logo |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| qr_code_logo_size |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
5-35 |
| qr_code_background |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| qr_code_background_transparency |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
0-100 |
| qr_code_foreground |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| qr_code_foreground_transparency |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
0-100 |
| frame |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_bottom_text |
| frame_text |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| frame_text_size |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
-5 - 5 |
| frame_text_font |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt |
| frame_custom_colors |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| frame_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: frame_custom_colors = 1 |
| frame_text_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: frame_custom_colors = 1 |
| size |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
50-2000 |
| margin |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
0-25 |
| ecc |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: L, M, Q, H |
| text |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = text |
| url |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = url |
| phone |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = phone |
| sms |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = sms |
|
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = email | |
|
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = whatsapp | |
| facetime |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = facetime |
| event |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = event |
| location |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| wifi |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| crypto |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| vcard |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| paypal |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| upi |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| epc |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| pix |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| coupon |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| google_review |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
Contoh respons
{
"data": {
"id": 1
}
}
Titik akhir
POST https://rqrcode.com/api/qr-codes/{qr_code_id}
Contoh
curl --request POST \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Kemas kini'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| link_id |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| project_id |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| name |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| type |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: text, url, pdf, phone, sms, email, whatsapp, facetime, location, wifi, event, vcard, crypto, paypal, upi, epc, pix, coupon, google_review |
| style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: square, dot, round, rounded, elastic_square, heart, diamond, star, triangle, hexagon, spaced_square, octagon, cross_x, curvy_x, rounded_cross, ninja, sun, shine, bold_plus, teardrop, corner_cut, randomized_square, bold_x |
| inner_eye_style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: square, dot, rounded, diamond, flower, leaf |
| outer_eye_style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: square, circle, rounded, flower, leaf |
| foreground_type |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: color, gradient |
| foreground_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: foreground_type = color |
| foreground_gradient_style |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: vertical, horizontal, diagonal, inverse_diagonal, radial |
| foreground_gradient_one |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: foreground_type = gradient |
| foreground_gradient_two |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: foreground_type = gradient |
| background_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| background_color_transparency |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
0 - 100 |
| custom_eyes_color |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| eyes_inner_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: custom_eyes_color = 1 |
| eyes_outer_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: custom_eyes_color = 1 |
| qr_code_logo |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| qr_code_logo_size |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
5-35 |
| qr_code_background |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| qr_code_background_transparency |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
0-100 |
| qr_code_foreground |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| qr_code_foreground_transparency |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
0-100 |
| frame |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: circle_simple_bottom_text, round_simple_bottom_text, straight_simple_bottom_text, round_card_bottom_text, straight_bottom_text, straight_top_text, round_bottom_text, round_top_text, tooltip_bottom_text, tooltip_top_text, ribbon_bottom_text, ribbon_top_text, tooltip_snap_top_text, tooltip_snap_bottom_text, straight_semi_bordered_bottom_text, round_semi_bordered_bottom_text, hand_arrows_bottom_text, broken_ticket_bottom_text, smooth_ribbon_bottom_text |
| frame_text |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| frame_text_size |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
-5 -> 5 |
| frame_text_font |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: times_new_roman, georgia, courier, arial, helvetica, verdana, tahoma, trebuchet_ms, courier_new, monaco, comic_sans_ms, impact, luminari, baskerville, papyrus, brush_script_mt |
| frame_custom_colors |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| frame_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: frame_custom_colors = 1 |
| frame_text_color |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: frame_custom_colors = 1 |
| size |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
50-2000 |
| margin |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
0-25 |
| ecc |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: L, M, Q, H |
| text |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = text |
| url |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = url |
| phone |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = phone |
| sms |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = sms |
|
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = email | |
|
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = whatsapp | |
| facetime |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = facetime |
| event |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: type = event |
| location |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| wifi |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| crypto |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| vcard |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| paypal |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| upi |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| epc |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| pix |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| coupon |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
| google_review |
Pilihan
ui.admin.api_docs.common.types.Objek
|
- |
Contoh respons
{
"data": {
"id": 1
}
}
Titik akhir
DELETE https://rqrcode.com/api/qr-codes/{qr_code_id}
Contoh
curl --request DELETE \
--url 'https://rqrcode.com/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tiada parameter tambahan.
Contoh respons
Badan respons 200 kosong apabila berjaya.