Кеңістіктер

Ескертпелер
Сарапшы деңгейі
API кілті сұраныстың Authorization тақырыбында Bearer токені ретінде жіберілуі тиіс. API кілтін алу.
Тізім

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

GET 
https://qysqa.kz/api/v1/spaces

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

curl --location --request GET 'https://qysqa.kz/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Параметр
Түрі
Сипаттама
search
міндетті емес string
Іздеу сұранысы.
search_by
міндетті емес string
Іздеу түрі. Мүмкін мәндер: Аты үшін name. Әдепкі мәні: name.
sort_by
міндетті емес string
Сұрыптау. Мүмкін мәндер: Құрылған күні үшін id, Аты үшін name. Әдепкі мәні: id.
sort
міндетті емес string
Сұрыптау. Мүмкін мәндер: Кему ретімен үшін desc, Өсу ретімен үшін asc. Әдепкі мәні: desc.
per_page
міндетті емес integer
Бір беттегі нәтижелер. Мүмкін мәндер: 10, 25, 50, 100. Әдепкі мәні: 10.
Көрсету

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

GET 
https://qysqa.kz/api/v1/spaces/{id}

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

curl --location --request GET 'https://qysqa.kz/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Сақтау

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

POST 
https://qysqa.kz/api/v1/spaces

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

curl --location --request POST 'https://qysqa.kz/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Параметр
Түрі
Сипаттама
name
міндетті string
Аты.
color
міндетті емес integer
Түс. Мүмкін мәндер: 1, 2, 3, 4, 5, 6. Әдепкі мәні: 1.
Жаңарту

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

PUT PATCH 
https://qysqa.kz/api/v1/spaces/{id}

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

curl --location --request PUT 'https://qysqa.kz/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Параметр
Түрі
Сипаттама
name
міндетті емес string
Аты.
color
міндетті емес integer
Түс. Мүмкін мәндер: 1, 2, 3, 4, 5, 6.
Жою

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

DELETE 
https://qysqa.kz/api/v1/spaces/{id}

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

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