API 參考
工作區GET

攞目前工作區

回傳同 X-Api-Key 請求標頭關聯嘅工作區。請求內容入面唔使再傳 workspace_id。

https://api.unifyport.ai/v1/workspace

請求標頭

X-Api-Key
string必填

工作區 API Key,工作區會由呢個標頭解析得出嚟。

路徑參數

呢個介面冇路徑參數。

請求內容

呢個介面唔需要 JSON 請求內容。

回應內容

name
string

工作區嘅顯示名稱。

status
string

工作區嘅生命週期狀態,例如 active。

metadata
object

你自己存喺工作區上面嘅環境標籤。

account_quota
number

呢個工作區最多准開幾多個渠道帳號。

account_quota_unlimited
boolean

係 true 嗰陣帳號配額就係無限,account_quota 會唔理。

回應

200
200 OK

請求成功,回應內容嘅例子如上。

400
請求錯誤

請求內容、路徑或者參數無效。

401
未授權

X-Api-Key 請求標頭缺少或者無效。

409
衝突

目前操作同現有嘅渠道帳號或者資源衝突。

500
伺服器錯誤

服務遇到咗未預期嘅錯誤。

請求

curl -X GET https://api.unifyport.ai/v1/workspace \
  -H "X-Api-Key: <YOUR_API_KEY>"

回應

{
  "data": {
    "name": "Production Workspace",
    "status": "active",
    "metadata": {
      "env": "production"
    },
    "account_quota": 10,
    "account_quota_unlimited": false
  }
}