Документація 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": "pryklad",
"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": "pryklad",
"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=pryklad' \
--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 у разі успіху.