Ссылки

Записи
Уровень эксперта
Ключ API должен быть отправлен как токен носителя в заголовке авторизации запроса. Получить ваш API ключ.
Список

API запрос:

GET
https://clik.by/api/v1/links

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

curl --location --request GET 'https://clik.by/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
search
optional string
Поисковый запрос.
search_by
optional string
Поиск по. Возможные значения: title для Название, alias для Текст сокращения, url для URL. Дефолтные: title.
status
optional integer
Filter by status. Возможные значения: 0 для Все, 1 для Active, 2 для Expired, 3 для Недоступность. Дефолтные: 0.
space_id
optional integer
Filter by space ID.
domain_id
optional integer
Filter by domain ID.
pixel_id
optional integer
Filter by pixel ID.
sort_by
optional string
Сортировать по. Возможные значения: id для Дата создания, clicks для Клики, title для Название, alias для Текст сокращения, url для URL. Дефолтные: id.
sort
optional string
Сортировка. Возможные значения: desc для По убыванию, asc для По возрастанию. Дефолтные: desc.
per_page
optional integer
Результатов на страницу. Возможные значения: 10, 25, 50, 100. Дефолтные: 10.
Показать

API запрос:

GET
https://clik.by/api/v1/links/{id}

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

curl --location --request GET 'https://clik.by/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Получить

API запрос:

POST
https://clik.by/api/v1/links

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

curl --location --request POST 'https://clik.by/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'
Параметр
Тип
Описание
url
обязательно string
The link to be shortened.
domain_id
обязательно integer
The domain ID the link to be saved under.
alias
optional string
The link alias.
password
optional string
The link password.
space_id
optional integer
The space ID the link to be saved under.
pixel_ids
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Whether the link is disabled or not. Возможные значения: 0 для Active, 1 для Недоступность. Дефолтные: 0.
privacy
optional integer
Whether the link stats are public or not. Возможные значения: 0 для Публичная, 1 для Приватная, 2 для Пароль. Дефолтные: 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. Возможные значения: 0 для Без условий, 1 для Geographic, 2 для Платформа, 4 для Ротация.
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. Возможные значения: 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 запрос:

PUT PATCH
https://clik.by/api/v1/links/{id}

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

curl --location --request PUT 'https://clik.by/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Параметр
Тип
Описание
url
optional string
The link to be shortened.
alias
optional string
The link alias.
password
optional string
The link password.
space_id
optional integer
The space ID the link to be saved under.
pixel_ids
optional array
The pixel IDs to be integrated in the link.
disabled
optional integer
Whether the link is disabled or not. Возможные значения: 0 для Active, 1 для Недоступность.
privacy
optional integer
Whether the link stats are public or not. Возможные значения: 0 для Публичная, 1 для Приватная, 2 для Пароль.
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. Возможные значения: 0 для Без условий, 1 для Geographic, 2 для Платформа, 4 для Ротация.
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. Возможные значения: 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 запрос:

DELETE
https://clik.by/api/v1/links/{id}

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

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