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