Посилання

Примітки
Експертний рівень
Ключ API має бути надісланий у вигляді токену на пред'явника в заголовку авторизації запиту. Отримайте свій ключ API.
Список

Кінцева точка API:

GET 
https://goo.vc/api/v1/links?uk

Приклад запиту: 

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

Приклад запиту: 

curl --location --request GET 'https://goo.vc/api/v1/links/{id}?uk' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Магазин

Кінцева точка API:

POST 
https://goo.vc/api/v1/links?uk

Приклад запиту: 

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

Приклад запиту: 

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

Приклад запиту: 

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