Ссылки

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

API эндпоинт:

GET 
https://link.immiijo.com/api/v1/links

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

curl --location --request GET 'https://link.immiijo.com/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. По умолчанию: 25.
Показать

API эндпоинт:

GET 
https://link.immiijo.com/api/v1/links/{id}

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

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

API эндпоинт:

POST 
https://link.immiijo.com/api/v1/links

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

curl --location --request POST 'https://link.immiijo.com/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-dTH:i:s.
active_period_end_at
опционально string
Дата конца активности в Y-m-dTH:i:s.
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://link.immiijo.com/api/v1/links/{id}

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

curl --location --request PUT 'https://link.immiijo.com/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Тип
Описание
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-dTH:i:s.
active_period_end_at
опционально string
Дата конца активности в Y-m-dTH:i:s.
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://link.immiijo.com/api/v1/links/{id}

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

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