Erdvės

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/spaces

Užklausos pavyzdys 

curl --location --request GET 'https://href.lt/api/v1/spaces' \
--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: name skirta Vardas. Numatytoji reikšmė: name.
sort_by
neprivaloma string
Rikiuoti pagal. Galimos reikšmės: id skirta Sukūrimo data, name skirta Vardas. 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/spaces/{id}

Užklausos pavyzdys 

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

API galinis taškas

POST 
https://href.lt/api/v1/spaces

Užklausos pavyzdys 

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

Parametrai

Vardas
Tipas
Aprašymas
name
būtina string
Vardas.
color
neprivaloma integer
Spalva. Galimos reikšmės: 1, 2, 3, 4, 5, 6. Numatytoji reikšmė: 1.
Atnaujinti

API galinis taškas

PUT PATCH 
https://href.lt/api/v1/spaces/{id}

Užklausos pavyzdys 

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

Parametrai

Vardas
Tipas
Aprašymas
name
neprivaloma string
Vardas.
color
neprivaloma integer
Spalva. Galimos reikšmės: 1, 2, 3, 4, 5, 6.
Ištrinti

API galinis taškas

DELETE 
https://href.lt/api/v1/spaces/{id}

Užklausos pavyzdys 

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