空间

备注
专家级
API 密钥应作为承载令牌发送到请求的授权标头中。 获取 API 密钥.
列表

API 端点:

GET 
https://gv.city/api/v1/spaces

请求示例: 

curl --location --request GET 'https://gv.city/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
参数
类型
描述
search
可选 string
搜索查询。
search_by
可选 string
搜索方式. 可用值：:value. 默认值为: name.
sort_by
可选 string
排序方式. 可用值：:value. 默认值为: id.
sort
可选 string
排序. 可用值：:value. 默认值为: desc.
per_page
可选 int
每页结果. 可用值：:value. 默认值为: 10.
显示

API 端点:

GET 
https://gv.city/api/v1/spaces/{id}

请求示例: 

curl --location --request GET 'https://gv.city/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
商店

API 端点:

POST 
https://gv.city/api/v1/spaces

请求示例: 

curl --location --request POST 'https://gv.city/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
参数
类型
描述
name
必需 string
空间名称。
color
可选 integer
颜色代码。 可用值：:value. 默认值为: 1.
更新

API 端点:

PUT PATCH 
https://gv.city/api/v1/spaces/{id}

请求示例: 

curl --location --request PUT 'https://gv.city/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
参数
类型
描述
name
可选 string
空间名称。
color
可选 integer
颜色代码。 可用值：:value.
删除

API 端点:

DELETE 
https://gv.city/api/v1/spaces/{id}

请求示例: 

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