空間

驗證
API 金鑰應以 Bearer 令牌形式在請求的授權標頭中傳送。 取得您的 API 金鑰.
列出

API 端點

GET 
https://ysd.lol/api/v1/spaces

請求範例 

curl --location --request GET 'https://ysd.lol/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Parameters

姓名
類型
說明
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://ysd.lol/api/v1/spaces/{id}

請求範例 

curl --location --request GET 'https://ysd.lol/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
建立

API 端點

POST 
https://ysd.lol/api/v1/spaces

請求範例 

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

Parameters

姓名
類型
說明
name
必要 string
姓名.
color
可選 integer
顏色. 可能的值為：1, 2, 3, 4, 5, 6。 預設為：1。
更新

API 端點

PUT PATCH 
https://ysd.lol/api/v1/spaces/{id}

請求範例 

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

Parameters

姓名
類型
說明
name
可選 string
姓名.
color
可選 integer
顏色. 可能的值為：1, 2, 3, 4, 5, 6。
刪除

API 端點

DELETE 
https://ysd.lol/api/v1/spaces/{id}

請求範例 

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