Ссылки

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

API-точка входа:

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

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

curl --location --request GET 'https://nnm.by/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
Фильтр по идентификатору пикселя.
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://nnm.by/api/v1/links/{id}

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

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

API-точка входа:

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

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

curl --location --request POST 'https://nnm.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
Ссылка, которую нужно укоротить.
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://nnm.by/api/v1/links/{id}

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

curl --location --request PUT 'https://nnm.by/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://nnm.by/api/v1/links/{id}

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

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