API sənədləri
Linklər
Qısa linklər, hədəfləmə qaydaları, piksellər və yönləndirmələr yaradın və idarə edin.
Autentifikasiya
Hər sorğu admin API açarına uyğun Bearer token ilə Authorization başlığını göndərməlidir.
API açarını əldə et.
Son nöqtə
GET https://rqrcode.com/api/links/
Nümunə
curl --request GET \
--url 'https://rqrcode.com/api/links/' \
--header 'Authorization: Bearer {api_key}'
Parametrlər
| Parametrlər | Detallar | Təsvir |
|---|---|---|
| page |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
Nəticələri almaq üçün istifadə olunan səhifə nömrəsi. Defolt olaraq 1. |
| results_per_page |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
Hər səhifədə nəticələrin sayı. İcazə verilən dəyərlər: 10, 25, 50, 100, 250, 500, 1000. Defolt olaraq 25. |
Cavab nümunəsi
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "numune",
"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"
}
}
Son nöqtə
GET https://rqrcode.com/api/links/{link_id}
Nümunə
curl --request GET \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrlər
Əlavə parametr yoxdur.
Cavab nümunəsi
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "numune",
"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"
}
}
Son nöqtə
POST https://rqrcode.com/api/links
Nümunə
curl --request POST \
--url 'https://rqrcode.com/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=numune' \
--form 'location_url=https://rqrcode.com/'
Parametrlər
| Parametrlər | Detallar | Təsvir |
|---|---|---|
| location_url |
Tələb olunur
ui.admin.api_docs.common.types.Mətn
|
Təyinat URL-i. Bu halda mövcuddur: is_bulk = 0 |
| location_urls |
Tələb olunur
ui.admin.api_docs.common.types.Mətn
|
Təyinat URL-i. Bu halda mövcuddur: is_bulk = 1 |
| url |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Yaradılan URL aliası. Təsadüfi dəyər üçün boş saxlayın. Bu halda mövcuddur: is_bulk = 0 |
| is_bulk |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| domain_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| project_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| pixels_ids |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| schedule |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| start_date |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: schedule = true |
| end_date |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: schedule = true |
| pageviews_limit |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| expiration_url |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| password |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| forward_query_parameters_is_enabled |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| utm_source |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| utm_medium |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| utm_campaign |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| sensitive_content |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| http_status_code |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
İcazə verilən dəyərlər: 301, 302, 307, 308 |
| app_linking_is_enabled |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| cloaking_is_enabled |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| cloaking_title |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| cloaking_meta_description |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| cloaking_custom_js |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| cloaking_favicon |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| cloaking_opengraph |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| targeting_type |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = continent_code |
| targeting_continent_code_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = continent_code |
| targeting_country_code_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = country_code |
| targeting_country_code_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = country_code |
| targeting_city_name_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = city_name |
| targeting_city_name_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = city_name |
| targeting_device_type_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = device_type |
| targeting_device_type_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = device_type |
| targeting_browser_language_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_language |
| targeting_browser_language_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_language |
| targeting_rotation_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = rotation |
| targeting_rotation_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = rotation |
| targeting_os_name_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = os_name |
| targeting_os_name_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = os_name |
| targeting_browser_name_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_name |
| targeting_browser_name_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_name |
Cavab nümunəsi
{
"data": {
"id": 1
}
}
Son nöqtə
POST https://rqrcode.com/api/links/{link_id}
Nümunə
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'
Parametrlər
| Parametrlər | Detallar | Təsvir |
|---|---|---|
| location_url |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Təyinat URL-i. |
| url |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Yaradılan URL aliası. Təsadüfi dəyər üçün boş saxlayın. |
| domain_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| project_id |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| pixels_ids |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| schedule |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| start_date |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: schedule = true |
| end_date |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: schedule = true |
| pageviews_limit |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
- |
| expiration_url |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| password |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| forward_query_parameters_is_enabled |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| utm_source |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| utm_medium |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| utm_campaign |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| sensitive_content |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| http_status_code |
İstəyə bağlı
ui.admin.api_docs.common.types.Tam ədəd
|
İcazə verilən dəyərlər: 301, 302, 307, 308 |
| app_linking_is_enabled |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| cloaking_is_enabled |
İstəyə bağlı
ui.admin.api_docs.common.types.Məntiqi dəyər
|
- |
| cloaking_title |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| cloaking_meta_description |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| cloaking_custom_js |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
- |
| cloaking_favicon |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| cloaking_opengraph |
İstəyə bağlı
ui.admin.api_docs.common.types.Fayl
|
- |
| targeting_type |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
İcazə verilən dəyərlər: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = continent_code |
| targeting_continent_code_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = continent_code |
| targeting_country_code_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = country_code |
| targeting_country_code_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = country_code |
| targeting_city_name_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = city_name |
| targeting_city_name_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = city_name |
| targeting_device_type_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = device_type |
| targeting_device_type_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = device_type |
| targeting_browser_language_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_language |
| targeting_browser_language_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_language |
| targeting_rotation_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = rotation |
| targeting_rotation_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = rotation |
| targeting_os_name_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = os_name |
| targeting_os_name_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = os_name |
| targeting_browser_name_key[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_name |
| targeting_browser_name_value[index] |
İstəyə bağlı
ui.admin.api_docs.common.types.Mətn
|
Bu halda mövcuddur: targeting_type = browser_name |
Cavab nümunəsi
{
"data": {
"id": 1
}
}
Son nöqtə
DELETE https://rqrcode.com/api/links/{link_id}
Nümunə
curl --request DELETE \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Parametrlər
Əlavə parametr yoxdur.
Cavab nümunəsi
Uğurlu olduqda boş 200 cavab gövdəsi.