Ссылки

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

API-эндпоинт:

GET 
https://yoopage.ru/api/v1/links

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

curl --location --request GET 'https://yoopage.ru/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
необязательный int
Результатов на страницу. Возможные значения: 10, 25, 50, 100. По умолчанию: 10.
Показать

API-эндпоинт:

GET 
https://yoopage.ru/api/v1/links/{id}

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

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

API-эндпоинт:

POST 
https://yoopage.ru/api/v1/links

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

curl --location --request POST 'https://yoopage.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}'
Параметр
Тип
Описание
url
обязательный string
Ссылка, которую нужно сократить.
domain_id
обязательный integer
ID домена, под которым будет сохранена ссылка.
alias
необязательный string
Псевдоним ссылки.
password
необязательный string
Пароль ссылки.
space_id
необязательный integer
ID пространства, под которым будет сохранена ссылка.
pixel_ids
необязательный array
The pixel IDs to be integrated in the link.
disabled
необязательный integer
Отключена ли ссылка или нет. Возможные значения: 0 для Активный, 1 для Отключенный. По умолчанию: 0.
privacy
необязательный integer
Открыта ли статистика по ссылке для общественности или нет. Возможные значения: 0 для Публичный, 1 для Частный, 2 для Пароль. По умолчанию: 0.
privacy_password
необязательный string
Пароль для страницы статистики. Работает только при значении privacy, установленном на 2.
expiration_url
необязательный string
Ссылка, на которую будет перенаправлен пользователь после истечения срока действия ссылки.
expiration_date
необязательный string
Дата истечения срока действия ссылки в формате YYYY-MM-DD.
expiration_time
необязательный string
Время истечения срока действия ссылки в формате HH:MM.
expiration_clicks
необязательный integer
Количество кликов, после которого ссылка должна истечь.
target_type
необязательный integer
Тип таргетинга. Возможные значения: 0 для Нет, 1 для География, 2 для Платформа, 4 для Ротация.
country[index][key]
необязательный string
Код целевой страны. Код должен соответствовать стандарту ISO 3166-1 alpha-2.
country[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
platform[index][key]
необязательный string
Название целевой платформы. Возможные значения: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
language[index][key]
необязательный string
Код целевого языка. Код должен соответствовать стандарту ISO 639-1 alpha-2.
language[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
rotation[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
Обновить

API-эндпоинт:

PUT PATCH 
https://yoopage.ru/api/v1/links/{id}

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

curl --location --request PUT 'https://yoopage.ru/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Параметр
Тип
Описание
url
необязательный string
Ссылка, которую нужно сократить.
alias
необязательный string
Псевдоним ссылки.
password
необязательный string
Пароль ссылки.
space_id
необязательный integer
ID пространства, под которым будет сохранена ссылка.
pixel_ids
необязательный array
The pixel IDs to be integrated in the link.
disabled
необязательный integer
Отключена ли ссылка или нет. Возможные значения: 0 для Активный, 1 для Отключенный.
privacy
необязательный integer
Открыта ли статистика по ссылке для общественности или нет. Возможные значения: 0 для Публичный, 1 для Частный, 2 для Пароль.
privacy_password
необязательный string
Пароль для страницы статистики. Работает только при значении privacy, установленном на 2.
expiration_url
необязательный string
Ссылка, на которую будет перенаправлен пользователь после истечения срока действия ссылки.
expiration_date
необязательный string
Дата истечения срока действия ссылки в формате YYYY-MM-DD.
expiration_time
необязательный string
Время истечения срока действия ссылки в формате HH:MM.
expiration_clicks
необязательный integer
Количество кликов, после которого ссылка должна истечь.
target_type
необязательный integer
Тип таргетинга. Возможные значения: 0 для Нет, 1 для География, 2 для Платформа, 4 для Ротация.
country[index][key]
необязательный string
Код целевой страны. Код должен соответствовать стандарту ISO 3166-1 alpha-2.
country[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
platform[index][key]
необязательный string
Название целевой платформы. Возможные значения: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.
platform[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
language[index][key]
необязательный string
Код целевого языка. Код должен соответствовать стандарту ISO 639-1 alpha-2.
language[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
rotation[index][value]
необязательный string
Ссылка, на которую будет перенаправлен пользователь.
Удалить

API-эндпоинт:

DELETE 
https://yoopage.ru/api/v1/links/{id}

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

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