Ссылки

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET
https://vk-cc.ru/api/v1/links

Пример запроса:

curl --location --request GET 'https://vk-cc.ru/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Формат
Описание
search
optional string
Поисковый запрос.
search_by
optional string
Поиск по. Possible values are: title for Заголовок, alias for Короткая ссылка, url for URL-адрес. Defaults to: title.
status
optional integer
Filter by status. Possible values are: 0 for Все, 1 for Активные, 2 for Истекшие, 3 for Отключенные. Defaults to: 0.
space
optional integer
Filter by space ID.
domain
optional integer
Filter by domain ID.
pixel
optional integer
Filter by pixel ID.
sort_by
optional string
Сортировать. Possible values are: id for Дата создания, clicks for Клики, title for Заголовок, alias for Короткая ссылка, url for URL-адрес. Defaults to: id.
sort
optional string
Сортировать. Possible values are: desc for По убыванию, asc for По возрастанию. Defaults to: desc.
per_page
optional int
Результатов на странице. Possible values are: 10, 25, 50, 100. Defaults to: 25.
Show

API endpoint:

GET
https://vk-cc.ru/api/v1/links/{id}

Пример запроса:

curl --location --request GET 'https://vk-cc.ru/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST
https://vk-cc.ru/api/v1/links

Пример запроса:

curl --location --request POST 'https://vk-cc.ru/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Parameter
Формат
Описание
url
required string
The link to be shortened.
domain
required integer
The domain ID the link to be saved under.
alias
optional string
The link alias.
password
optional string
The link password.
space
optional integer
The space ID the link to be saved under.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Whether the link is disabled or not. Possible values are: 0 for Активные, 1 for Отключенные. Defaults to: 0.
privacy
optional integer
Whether the link stats are public or not. Possible values are: 0 for Публичная, 1 for Частная, 2 for Пароль. Defaults to: 0.
privacy_password
optional string
The password for the statistics page. Only works with privacy set to 2.
expiration_url
optional string
The link where the user will be redirected once the link has expired.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
expiration_clicks
optional integer
The number of clicks after which the link should expire.
target_type
optional integer
The type of targeting. Possible values are: 0 for None, 1 for Geographic, 2 for Platform, 4 for Rotation.
country[index][key]
optional string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
optional string
The link where the user will be redirected to.
platform[index][key]
optional string
The name of the targeted platform. Possible values are: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
The link where the user will be redirected to.
language[index][key]
optional string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
The link where the user will be redirected to.
rotation[index][value]
optional string
The link where the user will be redirected to.
Update

API endpoint:

PUT PATCH
https://vk-cc.ru/api/v1/links/{id}

Пример запроса:

curl --location --request PUT 'https://vk-cc.ru/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Формат
Описание
url
optional string
The link to be shortened.
alias
optional string
The link alias.
password
optional string
The link password.
space
optional integer
The space ID the link to be saved under.
pixels
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Whether the link is disabled or not. Possible values are: 0 for Активные, 1 for Отключенные.
privacy
optional integer
Whether the link stats are public or not. Possible values are: 0 for Публичная, 1 for Частная, 2 for Пароль.
privacy_password
optional string
The password for the statistics page. Only works with privacy set to 2.
expiration_url
optional string
The link where the user will be redirected once the link has expired.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
expiration_clicks
optional integer
The number of clicks after which the link should expire.
target_type
optional integer
The type of targeting. Possible values are: 0 for None, 1 for Geographic, 2 for Platform, 4 for Rotation.
country[index][key]
optional string
The code of the targeted country. The code must be in ISO 3166-1 alpha-2 standard.
country[index][value]
optional string
The link where the user will be redirected to.
platform[index][key]
optional string
The name of the targeted platform. Possible values are: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
optional string
The link where the user will be redirected to.
language[index][key]
optional string
The code of the targeted language. The code must be in ISO 639-1 alpha-2 standard.
language[index][value]
optional string
The link where the user will be redirected to.
rotation[index][value]
optional string
The link where the user will be redirected to.
Удалить

API endpoint:

DELETE
https://vk-cc.ru/api/v1/links/{id}

Пример запроса:

curl --location --request DELETE 'https://vk-cc.ru/api/v1/links/{id}' \
--header 'Authorization: Bearer {api_key}'