Alanlar - Geliştiriciler

Notlar

Uzman seviyesi

API anahtarı, isteğin Authorization başlığında Bearer token olarak gönderilmelidir. API anahtarınızı alın.

Liste

API uç noktası:

GET

http://shoort.in/api/v1/spaces

İstek örneği:

curl --location --request GET 'http://shoort.in/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parametre

Tür

Açıklama

search

opsiyonel string

Arama sorgusu.

search_by

opsiyonel string

Arama Kriteri. Olası değerler: İsim için name. Varsayılan: name.

sort_by

opsiyonel string

Şuna göre sırala. Olası değerler: Oluşturulma tarihi için id, İsim için name. Varsayılan: id.

sort

opsiyonel string

Sırala. Olası değerler: Azalan için desc, Artan için asc. Varsayılan: desc.

per_page

opsiyonel integer

Sayfa başına sonuç. Olası değerler: 10, 25, 50, 100. Varsayılan: 100.

Göster

API uç noktası:

GET

http://shoort.in/api/v1/spaces/{id}

İstek örneği:

curl --location --request GET 'http://shoort.in/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Mağaza

API uç noktası:

POST

http://shoort.in/api/v1/spaces

İstek örneği:

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

Parametre

Tür

Açıklama

name

gerekli string

Alan adı.

color

opsiyonel integer

Renk kodu. Olası değerler: 1, 2, 3, 4, 5, 6. Varsayılan: 1.

Güncelle

API uç noktası:

PUT PATCH

http://shoort.in/api/v1/spaces/{id}

İstek örneği:

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

Parametre

Tür

Açıklama

name

opsiyonel string

Alan adı.

color

opsiyonel integer

Renk kodu. Olası değerler: 1, 2, 3, 4, 5, 6.

Sil

API uç noktası:

DELETE

http://shoort.in/api/v1/spaces/{id}

İstek örneği:

curl --location --request DELETE 'http://shoort.in/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'