Nuorodos

Autentifikacija

API raktas turi būti siunčiamas kaip Bearer token Authorization užklausos antraštėje. Gaukite savo API raktą.

Sąrašas

API galinis taškas

GET

https://href.lt/api/v1/links

Užklausos pavyzdys

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

Parametrai

Vardas

Tipas

Aprašymas

search

neprivaloma string

Paieškos užklausa.

search_by

neprivaloma string

Ieškoti pagal. Galimos reikšmės: title skirta Pavadinimas, alias skirta Slapyvardis, url skirta URL. Numatytoji reikšmė: title.

status

neprivaloma integer

Būsena. Galimos reikšmės: 0 skirta Visi, 1 skirta Aktyvus, 2 skirta Pasibaigęs, 3 skirta Išjungtas. Numatytoji reikšmė: 0.

space_id

neprivaloma integer

Erdvės ID.

domain_id

neprivaloma integer

Domeno ID.

pixel_id

neprivaloma integer

Pikselio ID.

sort_by

neprivaloma string

Rikiuoti pagal. Galimos reikšmės: id skirta Sukūrimo data, clicks skirta Paspaudimai, title skirta Pavadinimas, alias skirta Slapyvardis, url skirta URL. Numatytoji reikšmė: id.

sort

neprivaloma string

Rikiuoti. Galimos reikšmės: desc skirta Mažėjimo tvarka, asc skirta Didėjimo tvarka. Numatytoji reikšmė: desc.

per_page

neprivaloma integer

Rezultatai puslapyje. Galimos reikšmės: 10, 25, 50, 100. Numatytoji reikšmė: 10.

Rodyti

API galinis taškas

GET

https://href.lt/api/v1/links/{id}

Užklausos pavyzdys

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

Sukurti

API galinis taškas

POST

https://href.lt/api/v1/links

Užklausos pavyzdys

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

Parametrai

Vardas

Tipas

Aprašymas

url

būtina string

Paskirties URL.

domain_id

būtina integer

Domeno ID.

alias

neprivaloma string

Slapyvardis.

space_id

neprivaloma integer

Erdvės ID.

pixel_ids[]

neprivaloma array

Pikselių ID.

redirect_password

neprivaloma string

Nukreipimo slaptažodis.

sensitive_content

neprivaloma integer

Jautrus turinys. Galimos reikšmės: 0 skirta Ne, 1 skirta Taip. Numatytoji reikšmė: 0.

privacy

neprivaloma integer

Statistikos privatumas. Galimos reikšmės: 0 skirta Viešas, 1 skirta Privatus, 2 skirta Slaptažodis. Numatytoji reikšmė: 0.

password

neprivaloma string

Statistikos slaptažodis. Veikia tik kai laukas privacy nustatytas į 2.

active_period_start_at

neprivaloma string

Aktyvaus laikotarpio pradžios data Y-m-dTH:i:s formatu.

active_period_end_at

neprivaloma string

Aktyvaus laikotarpio pabaigos data Y-m-dTH:i:s formatu.

clicks_limit

neprivaloma integer

Paspaudimų riba.

expiration_url

neprivaloma string

Galiojimo pabaigos URL.

targets_type

neprivaloma string

Taikymas. Galimos reikšmės: continents skirta Continents, countries skirta Countries, operating_systems skirta Operating systems, browsers skirta Browsers, languages skirta Languages, devices skirta Devices, rotations skirta Rotations.

targets[index][key]

neprivaloma string

Laukui targets_type=country reikšmė turi būti ISO 3166-1 alpha-2 formatu.

Laukui targets_type=operating_systems galimos reikšmės: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

Laukui targets_type=browsers galimos reikšmės: 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.

Laukui targets_type=devices galimos reikšmės: Desktop, Mobile, Tablet, Watch, Television.

Laukui targets_type=languages reikšmė turi būti ISO 639-1 alpha-2 formatu.

Laukui targets_type=continents galimos reikšmės: AF skirta Africa, AN skirta Antarctica, AS skirta Asia, EU skirta Europe, NA skirta North America, OC skirta Oceania, SA skirta South America.

targets[index][value]

neprivaloma string

Paskirties URL.

Atnaujinti

API galinis taškas

PUT PATCH

https://href.lt/api/v1/links/{id}

Užklausos pavyzdys

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

Parametrai

Vardas

Tipas

Aprašymas

url

neprivaloma string

Paskirties URL.

alias

neprivaloma string

Slapyvardis.

space_id

neprivaloma integer

Erdvės ID.

pixel_ids[]

neprivaloma array

Pikselių ID.

redirect_password

neprivaloma string

Nukreipimo slaptažodis.

sensitive_content

neprivaloma integer

Jautrus turinys. Galimos reikšmės: 0 skirta Ne, 1 skirta Taip.

privacy

neprivaloma integer

Statistikos privatumas. Galimos reikšmės: 0 skirta Viešas, 1 skirta Privatus, 2 skirta Slaptažodis.

password

neprivaloma string

Statistikos slaptažodis. Veikia tik kai laukas privacy nustatytas į 2.

active_period_start_at

neprivaloma string

Aktyvaus laikotarpio pradžios data Y-m-dTH:i:s formatu.

active_period_end_at

neprivaloma string

Aktyvaus laikotarpio pabaigos data Y-m-dTH:i:s formatu.

clicks_limit

neprivaloma integer

Paspaudimų riba.

expiration_url

neprivaloma string

Galiojimo pabaigos URL.

targets_type

neprivaloma string

targets[index][key]

neprivaloma string

Laukui targets_type=country reikšmė turi būti ISO 3166-1 alpha-2 formatu.

Laukui targets_type=operating_systems galimos reikšmės: iOS, Android, Windows, OS X, Linux, Ubuntu, Chrome OS.

Laukui targets_type=devices galimos reikšmės: Desktop, Mobile, Tablet, Watch, Television.

Laukui targets_type=languages reikšmė turi būti ISO 639-1 alpha-2 formatu.

targets[index][value]

neprivaloma string

Paskirties URL.

Ištrinti

API galinis taškas

DELETE

https://href.lt/api/v1/links/{id}

Užklausos pavyzdys

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