Dokumentasi API
Pautan
Cipta dan urus pautan pendek anda, peraturan penargetan, piksel, dan pengalihan.
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/links/
Contoh
curl --request GET \
--url 'https://rqrcode.com/api/links/' \
--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,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "contoh",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"pageviews": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2026-04-20 07:53:23"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/links?page=1",
"last": "https://rqrcode.com/api/links?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/links?page=1"
}
}
Titik akhir
GET https://rqrcode.com/api/links/{link_id}
Contoh
curl --request GET \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tiada parameter tambahan.
Contoh respons
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "contoh",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"pageviews": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2026-04-20 07:53:23"
}
}
Titik akhir
POST https://rqrcode.com/api/links
Contoh
curl --request POST \
--url 'https://rqrcode.com/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=contoh' \
--form 'location_url=https://rqrcode.com/'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| location_url |
Diperlukan
ui.admin.api_docs.common.types.Rentetan
|
URL destinasi. Tersedia apabila: is_bulk = 0 |
| location_urls |
Diperlukan
ui.admin.api_docs.common.types.Rentetan
|
URL destinasi. Tersedia apabila: is_bulk = 1 |
| url |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Alias URL yang dijana. Biarkan kosong untuk yang rawak. Tersedia apabila: is_bulk = 0 |
| is_bulk |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| domain_id |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| project_id |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| pixels_ids |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| schedule |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| start_date |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: schedule = true |
| end_date |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: schedule = true |
| pageviews_limit |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| expiration_url |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| password |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| forward_query_parameters_is_enabled |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| utm_source |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| utm_medium |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| utm_campaign |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| sensitive_content |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| http_status_code |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
Nilai yang dibenarkan: 301, 302, 307, 308 |
| app_linking_is_enabled |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| cloaking_is_enabled |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| cloaking_title |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| cloaking_meta_description |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| cloaking_custom_js |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| cloaking_favicon |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| cloaking_opengraph |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| targeting_type |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = continent_code |
| targeting_continent_code_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = continent_code |
| targeting_country_code_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = country_code |
| targeting_country_code_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = country_code |
| targeting_city_name_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = city_name |
| targeting_city_name_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = city_name |
| targeting_device_type_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = device_type |
| targeting_device_type_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = device_type |
| targeting_browser_language_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_language |
| targeting_browser_language_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_language |
| targeting_rotation_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = rotation |
| targeting_rotation_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = rotation |
| targeting_os_name_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = os_name |
| targeting_os_name_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = os_name |
| targeting_browser_name_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_name |
| targeting_browser_name_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_name |
Contoh respons
{
"data": {
"id": 1
}
}
Titik akhir
POST https://rqrcode.com/api/links/{link_id}
Contoh
curl --request POST \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0'
Parameter
| Parameter | Butiran | Penerangan |
|---|---|---|
| location_url |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
URL destinasi. |
| url |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Alias URL yang dijana. Biarkan kosong untuk yang rawak. |
| domain_id |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| project_id |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| pixels_ids |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| schedule |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| start_date |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: schedule = true |
| end_date |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: schedule = true |
| pageviews_limit |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
- |
| expiration_url |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| password |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| forward_query_parameters_is_enabled |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| utm_source |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| utm_medium |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| utm_campaign |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| sensitive_content |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| http_status_code |
Pilihan
ui.admin.api_docs.common.types.Nombor bulat
|
Nilai yang dibenarkan: 301, 302, 307, 308 |
| app_linking_is_enabled |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| cloaking_is_enabled |
Pilihan
ui.admin.api_docs.common.types.Benar/Palsu
|
- |
| cloaking_title |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| cloaking_meta_description |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| cloaking_custom_js |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
- |
| cloaking_favicon |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| cloaking_opengraph |
Pilihan
ui.admin.api_docs.common.types.Fail
|
- |
| targeting_type |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Nilai yang dibenarkan: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = continent_code |
| targeting_continent_code_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = continent_code |
| targeting_country_code_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = country_code |
| targeting_country_code_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = country_code |
| targeting_city_name_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = city_name |
| targeting_city_name_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = city_name |
| targeting_device_type_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = device_type |
| targeting_device_type_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = device_type |
| targeting_browser_language_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_language |
| targeting_browser_language_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_language |
| targeting_rotation_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = rotation |
| targeting_rotation_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = rotation |
| targeting_os_name_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = os_name |
| targeting_os_name_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = os_name |
| targeting_browser_name_key[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_name |
| targeting_browser_name_value[index] |
Pilihan
ui.admin.api_docs.common.types.Rentetan
|
Tersedia apabila: targeting_type = browser_name |
Contoh respons
{
"data": {
"id": 1
}
}
Titik akhir
DELETE https://rqrcode.com/api/links/{link_id}
Contoh
curl --request DELETE \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Parameter
Tiada parameter tambahan.
Contoh respons
Badan respons 200 kosong apabila berjaya.