Сілтемелер

Ескертпелер

Сарапшы деңгейі

API кілті сұраныстың Authorization тақырыбында Bearer токені ретінде жіберілуі тиіс. API кілтін алу.

Тізім

API соңғы нүктесі:

GET

https://qysqa.kz/api/v1/links

Сұраныс үлгісі:

curl --location --request GET 'https://qysqa.kz/api/v1/links' \
--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

Кеңістік 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 соңғы нүктесі:

GET

https://qysqa.kz/api/v1/links/{id}

Сұраныс үлгісі:

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

Сақтау

API соңғы нүктесі:

POST

https://qysqa.kz/api/v1/links

Сұраныс үлгісі:

curl --location --request POST 'https://qysqa.kz/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, Иә үшін 1. Әдепкі мәні: 0.

privacy

міндетті емес integer

Статистиканың құпиялылығы. Мүмкін мәндер: Жария үшін 0, Жеке үшін 1, Құпиясөз үшін 2. Әдепкі мәні: 0.

password

міндетті емес string

Статистика құпиясөзі. Тек privacy өрісі 2 мәніне тең болғанда жұмыс істейді.

active_period_start_at

міндетті емес string

Белсенді кезеңнің басталу күні (Y-m-d H:i форматында).

active_period_end_at

міндетті емес string

Белсенді кезеңнің аяқталу күні (Y-m-d H:i форматында).

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 форматында болуы тиіс.
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 өрісі үшін мүмкін мәндер: Africa үшін AF, Antarctica үшін AN, Asia үшін AS, Europe үшін EU, North America үшін NA, Oceania үшін OC, South America үшін SA.

targets[index][value]

міндетті емес string

Мақсатты URL.

Жаңарту

API соңғы нүктесі:

PUT PATCH

https://qysqa.kz/api/v1/links/{id}

Сұраныс үлгісі:

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

Параметр

Түрі

Сипаттама

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-d H:i форматында).

active_period_end_at

міндетті емес string

Белсенді кезеңнің аяқталу күні (Y-m-d H:i форматында).

clicks_limit

міндетті емес integer

Кликтер лимиті.

expiration_url

міндетті емес string

Мерзімі аяқталғаннан кейінгі URL.

targets_type

міндетті емес string

targets[index][key]

міндетті емес string

targets[index][value]

міндетті емес string

Мақсатты URL.

Жою

API соңғы нүктесі:

DELETE

https://qysqa.kz/api/v1/links/{id}

Сұраныс үлгісі:

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