Ссылки

Получить все

Конечная точка

GET https://kapsy.ru/api/links/

Пример

curl --request GET \
--url 'https://kapsy.ru/api/links/' \
--header 'Authorization: Bearer {api_key}' \

Параметры	Детали	Описание
page	Необязательно Целое число	Номер страницы, с которой вы хотите получить результаты. По умолчанию `1`.
results_per_page	Необязательно Целое число	Сколько результатов вы хотите на страницу. Разрешенные значения: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. По умолчанию `25`.

Пример ответа

{
    "data": [
        {
            "id": 1,
            "project_id": null,
            "domain_id": 0,
            "type": "link",
            "url": "example",
            "location_url": "https://example.com/",
            "settings": {
                "password": null,
                "sensitive_content": false
            },
            "clicks": 10,
            "order": 0,
            "start_date": null,
            "end_date": null,
            "datetime": "2025-12-09 08:22:08",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://kapsy.ru/api/links?page=1",
        "last": "https://kapsy.ru/api/links?page=1",
        "next": null,
        "prev": null,
        "self": "https://kapsy.ru/api/links?page=1"
    }
}

Получить один

Конечная точка

GET https://kapsy.ru/api/links/{link_id}

Пример

curl --request GET \
--url 'https://kapsy.ru/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Пример ответа

{
    "data": {
        "id": 1,
        "project_id": null,
        "domain_id": 0,
        "type": "link",
        "url": "example",
        "location_url": "https://example.com/",
        "settings": {
            "password": null,
            "sensitive_content": false
        },
        "clicks": 10,
        "order": 0,
        "start_date": null,
        "end_date": null,
        "datetime": "2025-12-09 08:22:08",
    }
}

Параметры	Детали	Описание
type	Необязательно Строка	`link`
location_url	Обязательно Строка	URL назначения.Доступно, когда: is_bulk = 0
location_urls	Обязательно Строка	URL назначения.Доступно, когда: is_bulk = 1
url	Необязательно Строка	Псевдоним URL сгенерированной ссылки. Оставьте пустым для случайной генерации.Доступно, когда: is_bulk = 0
is_bulk	Необязательно Булево
domain_id	Необязательно Целое число	-
project_id	Необязательно Целое число	-
pixels_ids	Необязательно Массив Целое число	-
email_reports	Необязательно Массив	Идентификаторы обработчиков уведомлений
schedule	Необязательно Булево	-
start_date	Необязательно Строка	Доступно, когда: schedule = true
end_date	Необязательно Строка	Доступно, когда: schedule = true
clicks_limit	Необязательно Целое число	-
expiration_url	Необязательно Строка	-
sensitive_content	Необязательно Булево	-
http_status_code	Необязательно Целое число	Разрешенные значения: `301`, `302`, `307`, `308`
app_linking_is_enabled	Необязательно Булево	-
cloaking_is_enabled	Необязательно Булево	-
cloaking_title	Необязательно Строка	-
cloaking_meta_description	Необязательно Строка	-
cloaking_custom_js	Необязательно Строка	-
cloaking_favicon	Необязательно Файл	-
cloaking_opengraph	Необязательно Файл	-
password	Необязательно Строка	-
forward_query_parameters_is_enabled	Необязательно Булево	-
utm_source	Необязательно Строка	-
utm_medium	Необязательно Строка	-
utm_campaign	Необязательно Строка	-
targeting_type	Необязательно Строка	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Необязательно Строка	Доступно, когда: targeting_type = continent_code
targeting_continent_code_value[index]	Необязательно Строка	Доступно, когда: targeting_type = continent_code
targeting_country_code_key[index]	Необязательно Строка	Доступно, когда: targeting_type = country_code
targeting_country_code_value[index]	Необязательно Строка	Доступно, когда: targeting_type = country_code
targeting_city_name_key[index]	Необязательно Строка	Доступно, когда: targeting_type = city_name
targeting_city_name_value[index]	Необязательно Строка	Доступно, когда: targeting_type = city_name
targeting_device_type_key[index]	Необязательно Строка	Доступно, когда: targeting_type = device_type
targeting_device_type_value[index]	Необязательно Строка	Доступно, когда: targeting_type = device_type
targeting_browser_language_key[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_language
targeting_browser_language_value[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_language
targeting_rotation_key[index]	Необязательно Строка	Доступно, когда: targeting_type = rotation
targeting_rotation_value[index]	Необязательно Строка	Доступно, когда: targeting_type = rotation
targeting_os_name_key[index]	Необязательно Строка	Доступно, когда: targeting_type = os_name
targeting_os_name_value[index]	Необязательно Строка	Доступно, когда: targeting_type = os_name
targeting_browser_name_key[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_name
targeting_browser_name_value[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_name

curl --request POST \
--url 'https://kapsy.ru/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://kapsy.ru/' \

Пример ответа

{
    "data": {
        "id": 1
    }
}

Обновить

Конечная точка

POST https://kapsy.ru/api/links/{link_id}

Параметры	Детали	Описание
location_url	Необязательно Строка	URL назначения.
url	Необязательно Строка	Псевдоним URL сгенерированной ссылки. Оставьте пустым для случайной генерации.
domain_id	Необязательно Целое число	-
project_id	Необязательно Целое число	-
pixels_ids	Необязательно Массив Целое число	-
email_reports	Необязательно Массив	Идентификаторы обработчиков уведомлений
schedule	Необязательно Булево	-
start_date	Необязательно Строка	Доступно, когда: schedule = true
end_date	Необязательно Строка	Доступно, когда: schedule = true
clicks_limit	Необязательно Целое число	-
expiration_url	Необязательно Строка	-
sensitive_content	Необязательно Булево	-
http_status_code	Необязательно Целое число	Разрешенные значения: `301`, `302`, `307`, `308`
app_linking_is_enabled	Необязательно Булево	-
cloaking_is_enabled	Необязательно Булево	-
cloaking_title	Необязательно Строка	-
cloaking_meta_description	Необязательно Строка	-
cloaking_custom_js	Необязательно Строка	-
cloaking_favicon	Необязательно Файл	-
cloaking_opengraph	Необязательно Файл	-
password	Необязательно Строка	-
forward_query_parameters_is_enabled	Необязательно Булево	-
utm_source	Необязательно Строка	-
utm_medium	Необязательно Строка	-
utm_campaign	Необязательно Строка	-
targeting_type	Необязательно Строка	`continent_code` , `country_code` , `device_type` , `browser_language` , `rotation` , `os_name` , `browser_name`
targeting_continent_code_key[index]	Необязательно Строка	Доступно, когда: targeting_type = continent_code
targeting_continent_code_value[index]	Необязательно Строка	Доступно, когда: targeting_type = continent_code
targeting_country_code_key[index]	Необязательно Строка	Доступно, когда: targeting_type = country_code
targeting_country_code_value[index]	Необязательно Строка	Доступно, когда: targeting_type = country_code
targeting_city_name_key[index]	Необязательно Строка	Доступно, когда: targeting_type = city_name
targeting_city_name_value[index]	Необязательно Строка	Доступно, когда: targeting_type = city_name
targeting_device_type_key[index]	Необязательно Строка	Доступно, когда: targeting_type = device_type
targeting_device_type_value[index]	Необязательно Строка	Доступно, когда: targeting_type = device_type
targeting_browser_language_key[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_language
targeting_browser_language_value[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_language
targeting_rotation_key[index]	Необязательно Строка	Доступно, когда: targeting_type = rotation
targeting_rotation_value[index]	Необязательно Строка	Доступно, когда: targeting_type = rotation
targeting_os_name_key[index]	Необязательно Строка	Доступно, когда: targeting_type = os_name
targeting_os_name_value[index]	Необязательно Строка	Доступно, когда: targeting_type = os_name
targeting_browser_name_key[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_name
targeting_browser_name_value[index]	Необязательно Строка	Доступно, когда: targeting_type = browser_name

Пример

curl --request POST \
--url 'https://kapsy.ru/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \

Пример ответа

{
    "data": {
        "id": 1
    }
}

Удалить

Конечная точка

DELETE https://kapsy.ru/api/links/{link_id}

Пример

curl --request DELETE \
--url 'https://kapsy.ru/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \

Ссылки

Получить все

Получить один

Создать

Обновить

Удалить