API документация
Връзки
Създавайте и управлявайте кратките си връзки, правилата за таргетиране, пикселите и пренасочванията.
Удостоверяване
Всяка заявка трябва да изпраща Authorization хедър с Bearer токен, който съответства на админ API ключа.
Вземи API ключ.
Крайна точка
GET https://rqrcode.com/api/links/
Пример
curl --request GET \
--url 'https://rqrcode.com/api/links/' \
--header 'Authorization: Bearer {api_key}'
Параметри
| Параметри | Подробности | Описание |
|---|---|---|
| page |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
Номерът на страницата, за която искате да получите резултатите. По подразбиране е 1. |
| results_per_page |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
Колко резултата искате на страница. Разрешените стойности са: 10, 25, 50, 100, 250, 500, 1000. По подразбиране е 25. |
Примерен отговор
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "primer",
"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"
}
}
Крайна точка
GET https://rqrcode.com/api/links/{link_id}
Пример
curl --request GET \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Параметри
Няма допълнителен параметър.
Примерен отговор
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "primer",
"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"
}
}
Крайна точка
POST https://rqrcode.com/api/links
Пример
curl --request POST \
--url 'https://rqrcode.com/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=primer' \
--form 'location_url=https://rqrcode.com/'
Параметри
| Параметри | Подробности | Описание |
|---|---|---|
| location_url |
Задължително
ui.admin.api_docs.common.types.Низ
|
URL на дестинацията. Налично когато: is_bulk = 0 |
| location_urls |
Задължително
ui.admin.api_docs.common.types.Низ
|
URL на дестинацията. Налично когато: is_bulk = 1 |
| url |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Генерираният URL псевдоним. Оставете празно за случаен. Налично когато: is_bulk = 0 |
| is_bulk |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| domain_id |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| project_id |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| pixels_ids |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| schedule |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| start_date |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: schedule = true |
| end_date |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: schedule = true |
| pageviews_limit |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| expiration_url |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| password |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| forward_query_parameters_is_enabled |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| utm_source |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| utm_medium |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| utm_campaign |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| sensitive_content |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| http_status_code |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
Разрешени стойности: 301, 302, 307, 308 |
| app_linking_is_enabled |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| cloaking_is_enabled |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| cloaking_title |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| cloaking_meta_description |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| cloaking_custom_js |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| cloaking_favicon |
Незадължително
ui.admin.api_docs.common.types.Файл
|
- |
| cloaking_opengraph |
Незадължително
ui.admin.api_docs.common.types.Файл
|
- |
| targeting_type |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Разрешени стойности: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = continent_code |
| targeting_continent_code_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = continent_code |
| targeting_country_code_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = country_code |
| targeting_country_code_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = country_code |
| targeting_city_name_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = city_name |
| targeting_city_name_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = city_name |
| targeting_device_type_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = device_type |
| targeting_device_type_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = device_type |
| targeting_browser_language_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_language |
| targeting_browser_language_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_language |
| targeting_rotation_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = rotation |
| targeting_rotation_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = rotation |
| targeting_os_name_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = os_name |
| targeting_os_name_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = os_name |
| targeting_browser_name_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_name |
| targeting_browser_name_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_name |
Примерен отговор
{
"data": {
"id": 1
}
}
Крайна точка
POST https://rqrcode.com/api/links/{link_id}
Пример
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'
Параметри
| Параметри | Подробности | Описание |
|---|---|---|
| location_url |
Незадължително
ui.admin.api_docs.common.types.Низ
|
URL на дестинацията. |
| url |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Генерираният URL псевдоним. Оставете празно за случаен. |
| domain_id |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| project_id |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| pixels_ids |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| schedule |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| start_date |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: schedule = true |
| end_date |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: schedule = true |
| pageviews_limit |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
- |
| expiration_url |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| password |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| forward_query_parameters_is_enabled |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| utm_source |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| utm_medium |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| utm_campaign |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| sensitive_content |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| http_status_code |
Незадължително
ui.admin.api_docs.common.types.Цяло число
|
Разрешени стойности: 301, 302, 307, 308 |
| app_linking_is_enabled |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| cloaking_is_enabled |
Незадължително
ui.admin.api_docs.common.types.Булева стойност
|
- |
| cloaking_title |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| cloaking_meta_description |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| cloaking_custom_js |
Незадължително
ui.admin.api_docs.common.types.Низ
|
- |
| cloaking_favicon |
Незадължително
ui.admin.api_docs.common.types.Файл
|
- |
| cloaking_opengraph |
Незадължително
ui.admin.api_docs.common.types.Файл
|
- |
| targeting_type |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Разрешени стойности: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = continent_code |
| targeting_continent_code_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = continent_code |
| targeting_country_code_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = country_code |
| targeting_country_code_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = country_code |
| targeting_city_name_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = city_name |
| targeting_city_name_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = city_name |
| targeting_device_type_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = device_type |
| targeting_device_type_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = device_type |
| targeting_browser_language_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_language |
| targeting_browser_language_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_language |
| targeting_rotation_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = rotation |
| targeting_rotation_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = rotation |
| targeting_os_name_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = os_name |
| targeting_os_name_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = os_name |
| targeting_browser_name_key[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_name |
| targeting_browser_name_value[index] |
Незадължително
ui.admin.api_docs.common.types.Низ
|
Налично когато: targeting_type = browser_name |
Примерен отговор
{
"data": {
"id": 1
}
}
Крайна точка
DELETE https://rqrcode.com/api/links/{link_id}
Пример
curl --request DELETE \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Параметри
Няма допълнителен параметър.
Примерен отговор
Празно тяло на отговор 200 при успех.