Ссылки

Примечания

Уровень эксперта

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

Список

Конечная точка API:

GET

https://www.goo.vc/api/v1/links?ru

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

curl --location --request GET 'https://www.goo.vc/api/v1/links?ru' \
--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

Фильтр по идентификатору пространства.

domain_id

дополнительно integer

Фильтр по идентификатору домена.

pixel_id

дополнительно integer

Фильтр по идентификатору пикселя.

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://www.goo.vc/api/v1/links/{id}?ru

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

curl --location --request GET 'https://www.goo.vc/api/v1/links/{id}?ru' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Магазин

Конечная точка API:

POST

https://www.goo.vc/api/v1/links?ru

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

curl --location --request POST 'https://www.goo.vc/api/v1/links?ru' \
--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

Идентификатор домена, под которым будет сохранена ссылка.

alias

дополнительно string

Псевдоним ссылки.

password

дополнительно string

Пароль ссылки.

space_id

дополнительно integer

Идентификатор места, под которым будет сохранена ссылка.

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://www.goo.vc/api/v1/links/{id}?ru

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

curl --location --request PUT 'https://www.goo.vc/api/v1/links/{id}?ru' \
--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

Идентификатор места, под которым будет сохранена ссылка.

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://www.goo.vc/api/v1/links/{id}?ru

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

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