Посилання

Автентифікація

API-ключ потрібно надсилати як Bearer-токен у заголовку Authorization запиту. Отримайте свій API-ключ.

Список

API endpoint

GET

https://1cut.pw/api/v1/links

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

curl --location --request GET 'https://1cut.pw/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameters

Ім’я

Тип

Опис

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. За замовчуванням: 10.

Показати

API endpoint

GET

https://1cut.pw/api/v1/links/{id}

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

curl --location --request GET 'https://1cut.pw/api/v1/links/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Створення

API endpoint

POST

https://1cut.pw/api/v1/links

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

curl --location --request POST 'https://1cut.pw/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}' \
--data-urlencode 'domain={id}'

Parameters

Ім’я

Тип

Опис

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.

Для targets_type=operating_systems можливі значення: 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 endpoint

PUT PATCH

https://1cut.pw/api/v1/links/{id}

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

curl --location --request PUT 'https://1cut.pw/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Parameters

Ім’я

Тип

Опис

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

targets[index][key]

необов’язково string

Для targets_type=country значення має бути у форматі ISO 3166-1 alpha-2.

Для targets_type=operating_systems можливі значення: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

Для targets_type=devices можливі значення: Desktop, Mobile, Tablet, Watch, Television.

Для targets_type=languages значення має бути у форматі ISO 639-1 alpha-2.

targets[index][value]

необов’язково string

Цільовий URL.

Видалити

API endpoint

DELETE

https://1cut.pw/api/v1/links/{id}

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

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