Ссылки

Заметки
Экспертный уровень
API-ключ должен передаваться как Bearer-токен в заголовке Authorization запроса. Получить API-ключ.
Список

API-эндпоинт:

GET 
https://linkapp.kz/api/v1/links

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

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

API-эндпоинт:

GET 
https://linkapp.kz/api/v1/links/{id}

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

curl --location --request GET 'https://linkapp.kz/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Сохранить

API-эндпоинт:

POST 
https://linkapp.kz/api/v1/links

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

curl --location --request POST 'https://linkapp.kz/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
Целевой URL.
domain_id
обязательно integer
ID домена.
alias
необязательно string
Псевдоним.
space_id
необязательно integer
ID пространства.
pixel_ids[]
необязательно array
ID пикселей.
redirect_password
необязательно string
Пароль перенаправления.
sensitive_content
необязательно integer
Чувствительный контент. Возможные значения: 0 для Нет, 1 для Да. Значение по умолчанию: 0.
privacy
необязательно integer
Приватность статистики. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль. Значение по умолчанию: 0.
password
необязательно string
Пароль статистики. Работает только если поле privacy установлено в 2.
active_period_start_at
необязательно string
Дата начала периода активности в формате Y-m-d H:i.
active_period_end_at
необязательно string
Дата окончания периода активности в формате Y-m-d H:i.
clicks_limit
необязательно integer
Лимит кликов.
expiration_url
необязательно string
URL после истечения.
targets_type
необязательно string
Таргетинг. Возможные значения: continents для Continents, countries для Countries, operating_systems для Operating systems, browsers для Browsers, languages для Languages, devices для Devices, rotations для Rotations.
targets[index][key]
необязательно string
Для поля targets_type=country значение должно быть в формате ISO 3166-1 alpha-2.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
Для поля targets_type=browsers возможные значения: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
Для поля targets_type=devices возможные значения: Desktop, Mobile, Tablet, Watch, Television.
Для поля targets_type=languages значение должно быть в формате ISO 639-1 alpha-2.
Для поля targets_type=continents возможные значения: AF для Africa, AN для Antarctica, AS для Asia, EU для Europe, NA для North America, OC для Oceania, SA для South America.
targets[index][value]
необязательно string
Целевой URL.
Обновить

API-эндпоинт:

PUT PATCH 
https://linkapp.kz/api/v1/links/{id}

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

curl --location --request PUT 'https://linkapp.kz/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Параметр
Тип
Описание
url
необязательно string
Целевой URL.
alias
необязательно string
Псевдоним.
space_id
необязательно integer
ID пространства.
pixel_ids[]
необязательно array
ID пикселей.
redirect_password
необязательно string
Пароль перенаправления.
sensitive_content
необязательно integer
Чувствительный контент. Возможные значения: 0 для Нет, 1 для Да.
privacy
необязательно integer
Приватность статистики. Возможные значения: 0 для Публичный, 1 для Приватный, 2 для Пароль.
password
необязательно string
Пароль статистики. Работает только если поле privacy установлено в 2.
active_period_start_at
необязательно string
Дата начала периода активности в формате Y-m-d H:i.
active_period_end_at
необязательно string
Дата окончания периода активности в формате Y-m-d H:i.
clicks_limit
необязательно integer
Лимит кликов.
expiration_url
необязательно string
URL после истечения.
targets_type
необязательно string
Таргетинг. Возможные значения: continents для Continents, countries для Countries, operating_systems для Operating systems, browsers для Browsers, languages для Languages, devices для Devices, rotations для Rotations.
targets[index][key]
необязательно string
Для поля targets_type=country значение должно быть в формате ISO 3166-1 alpha-2.
For targets_type=operating_systems, the possible values are iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
Для поля targets_type=browsers возможные значения: Chrome, Chromium, Firefox, Firefox Mobile, Edge, Internet Explorer, Mobile Internet Explorer, Vivaldi, Brave, Safari, Opera, Opera Mini, Opera Mobile, Opera Touch, Yandex Browser, UC Browser, Samsung Internet, QQ Browser, BlackBerry Browser, Maxtho.
Для поля targets_type=devices возможные значения: Desktop, Mobile, Tablet, Watch, Television.
Для поля targets_type=languages значение должно быть в формате ISO 639-1 alpha-2.
Для поля targets_type=continents возможные значения: AF для Africa, AN для Antarctica, AS для Asia, EU для Europe, NA для North America, OC для Oceania, SA для South America.
targets[index][value]
необязательно string
Целевой URL.
Удалить

API-эндпоинт:

DELETE 
https://linkapp.kz/api/v1/links/{id}

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

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