Ссылки

Получить все

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

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

Пример

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

Параметры	Детали	Описание
page	Опционально Integer	Номер страницы, с которой вы хотите получить результат. По умолчанию `1`.
results_per_page	Опционально Integer	Сколько результатов на странице. Допустимые значения: `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, "date": "2020-11-15 12:00:00" } ], "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, "date": "2020-11-15 12:00:00" } }

Создать

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

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

Параметры	Детали	Описание
type	Опционально Строка	`link`
location_url	Обязательно Строка	Целевой URL-адрес.
url	Опционально Строка	Алиас URL генерируемой ссылки. Оставьте пустым, чтобы сгенерировать случайно.
domain_id	Опционально Integer	-
project_id	Опционально Integer	-
pixels_ids	Опционально Массив Integer	-
schedule	Опционально Boolean	-
start_date	Опционально Строка	Доступно, когда: schedule = true
end_date	Опционально Строка	Доступно, когда: schedule = true
clicks_limit	Опционально Integer	-
expiration_url	Опционально Строка	-
sensitive_content	Опционально Boolean	-
http_status_code	Опционально Integer	Допустимые значения: `301`, `302`, `307`, `308`
app_linking_is_enabled	Опционально Boolean	-
cloaking_is_enabled	Опционально Boolean	-
cloaking_title	Опционально Строка	-
cloaking_favicon	Опционально File	-
cloaking_opengraph	Опционально File	-
password	Опционально Строка	-
forward_query_parameters_is_enabled	Опционально Boolean	-
utm_source	Опционально missing_translation: api_documentation.strings	-
utm_medium	Опционально missing_translation: api_documentation.strings	-
utm_campaign	Опционально missing_translation: api_documentation.strings	-
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	Опционально Integer	-
project_id	Опционально Integer	-
pixels_ids	Опционально Массив Integer	-
schedule	Опционально Boolean	-
start_date	Опционально Строка	Доступно, когда: schedule = true
end_date	Опционально Строка	Доступно, когда: schedule = true
clicks_limit	Опционально Integer	-
expiration_url	Опционально Строка	-
sensitive_content	Опционально Boolean	-
http_status_code	Опционально Integer	Допустимые значения: `301`, `302`, `307`, `308`
app_linking_is_enabled	Опционально Boolean	-
cloaking_is_enabled	Опционально Boolean	-
cloaking_title	Опционально Строка	-
cloaking_favicon	Опционально File	-
cloaking_opengraph	Опционально File	-
password	Опционально Строка	-
forward_query_parameters_is_enabled	Опционально Boolean	-
utm_source	Опционально missing_translation: api_documentation.strings	-
utm_medium	Опционально missing_translation: api_documentation.strings	-
utm_campaign	Опционально missing_translation: api_documentation.strings	-
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}' \