Линкове

Бележки

Експертно ниво

API ключът трябва да бъде изпратен като Bearer token в Authorization header на заявката. Вземете вашия API ключ.

Списък

API крайна точка:

GET

https://short.bg/api/v1/links

Примерна заявка:

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

Параметър

Тип

Описание

search

по избор string

Заявка за търсене.

search_by

по избор string

Търсене по. Възможните стойности са: title for Заглавие, alias for Псевдоним, url for URL адрес. По подразбиране: title.

status

по избор integer

Статус. Възможните стойности са: 0 for Всички, 1 for Активен, 2 for Изтекъл, 3 for Деактивиран. По подразбиране: 0.

space_id

по избор integer

ID на групата.

domain_id

по избор integer

ID на домейна.

pixel_id

по избор integer

ID на пиксела.

sort_by

по избор string

Сортирай по. Възможните стойности са: id for Дата на създаване, clicks for Кликове, title for Заглавие, alias for Псевдоним, url for URL адрес. По подразбиране: id.

sort

по избор string

Сортиране. Възможните стойности са: desc for Низходящо, asc for Възходящо. По подразбиране: desc.

per_page

по избор integer

Резултати на страница. Възможните стойности са: 10, 25, 50, 100. По подразбиране: 10.

Покажи

API крайна точка:

GET

https://short.bg/api/v1/links/{id}

Примерна заявка:

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

Запази

API крайна точка:

POST

https://short.bg/api/v1/links

Примерна заявка:

curl --location --request POST 'https://short.bg/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 for Не, 1 for Да. По подразбиране: 0.

privacy

по избор integer

Поверителност на статистиката. Възможните стойности са: 0 for Публичен, 1 for Частен, 2 for Парола. По подразбиране: 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 for Continents, countries for Countries, operating_systems for Operating systems, browsers for Browsers, languages for Languages, devices for Devices, rotations for 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 for Africa, AN for Antarctica, AS for Asia, EU for Europe, NA for North America, OC for Oceania, SA for South America.

targets[index][value]

по избор string

URL на назначението.

Актуализирай

API крайна точка:

PUT PATCH

https://short.bg/api/v1/links/{id}

Примерна заявка:

curl --location --request PUT 'https://short.bg/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 for Не, 1 for Да.

privacy

по избор integer

Поверителност на статистиката. Възможните стойности са: 0 for Публичен, 1 for Частен, 2 for Парола.

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[index][value]

по избор string

URL на назначението.

Изтриване

API крайна точка:

DELETE

https://short.bg/api/v1/links/{id}

Примерна заявка:

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