API 參考

純粹的 REST,沒有任何意外。

可預期的資源、標準動詞、游標分頁。以下速率限制是伺服器實際強制執行的數值,而非理想值。

Bearer 權杖 僅支援 JSON 請求上限 4 MB
公開的 /v1 介面尚未開放。 下方的引擎今日已在運行 — 角色、核准、部署與稽核紀錄皆由伺服器端強制執行。尚未完成的是穩定的公開合約:帶版本的路徑、OpenAPI 文件,以及十二個月的淘汰保證。此處記載的形態已經固定,發布前不會變更。

身分驗證

Bearer 權杖,範圍限定於工作區。權杖繼承建立者的角色 — 編輯者的權杖無論呼叫什麼都無法核准。此規則由伺服器端強制執行,而非在用戶端。

請求
curl https://api.untactit.com/v1/assets \
  -H "Authorization: Bearer $TOKEN"

登入本身僅支援 SSO(SAML 或 OIDC)。我們從不保存密碼,因此沒有密碼端點,也沒有可外洩的內容。

分頁

採用游標分頁,而非位移分頁。請傳入 cursor 延續上一次回應的值,直到 has_more 為 false 為止。每頁最多 100 筆。

回應
{
  "data": [ /* up to 100 items */ ],
  "has_more": true,
  "next_cursor": "cur_01H8X..."
}

資源

六項資源。角色需求由伺服器強制執行,當你權限不足時,錯誤訊息會指明所需角色。

資源涵蓋範圍最低角色
assets 列出、讀取、建立、更新。每項資產皆保有完整版本歷程。viewer / editor
approvals 提案、核准、駁回。遵循貴工作區的核准政策。editor / approver
deployments 規劃、執行、試跑,並讀取包含偏移在內的部署狀態。審核者
targets 已連接的平台及其範圍。admin
members 工作區成員與角色指派。admin
audit 稽核紀錄,可依操作者、動作與時間篩選。支援 CSV 匯出。admin

錯誤

機器可讀,且具體明確。

錯誤會帶有穩定的 code 可供你據以分支處理。當問題出在權限時,回應會指明可行的角色 — 讓你無須猜測即可修正。

  • 403 insufficient role — 包含所需角色與實際角色
  • 413 酬載超過 4 MB
  • 429 已達速率限制
  • 409 conflict — 版本在你操作期間已變更
403
{
  "error": {
    "code": "insufficient_role",
    "message": "Approving requires the approver role.",
    "required_role": "approver",
    "actual_role": "editor",
    "request_id": "req_01H8X..."
  }
}

請附上 request_id 在支援信件中附上,我們就能找出確切的呼叫,而不必請你重現問題。


速率限制

以工作區為單位的權杖桶,並依路徑群組套用。持續速率會不斷補充;突發額度則是閒置後可一次消耗的量。

300/分鐘

讀取與資產寫入。 突發額度 50。足以持續同步完整清冊,並在編輯時隨手儲存而無須顧慮。

30/分鐘

結構性變更。 突發額度 5。適用於角色變更、工作區設定,以及任何會改變權限歸屬的操作。

12–120/分鐘

部署、執行與外部呼叫。 依作業成本調整。一次部署無論觸及多少台機器,都只算一次呼叫。

超過 4 MB 的請求會以 413 拒絕。具備具體使用模式的企業版工作區可調高上限 — 請描述你的工作負載,我們會據以評估規模,而不是給出毫無依據的數字。


API 常見問題

公開 API 何時開放?

目前沒有可對外承諾的日期。引擎今日已在運行;尚待完成的是穩定的合約與其淘汰保證。若 API 存取是貴團隊評估的必要條件,請告訴我們 — 這會提高它的優先順序。

是否提供沙箱環境?

沒有獨立的沙箱。請在免費方案下建立第二個工作區作為測試環境 — 行為完全相同,且不會危及正式環境資料。

版本將如何管理?

放在路徑中。破壞性變更會以新版本發布,並與舊版重疊十二個月。新增欄位可能不另行通知即出現,因此請以防禦性方式解析。

是否會提供 OpenAPI 規格?

會,且由與實作相同的來源產生,因此不會與實際行為脫節。人工維護的規格書終究會變成一份說謊的文件。

你的代理在跑什麼,不必再用猜的。

連接一個工作區,大約十分鐘,團隊實際在用的每一項技能、規則與記憶就全部看得到。

免費開始 與我們談談

免信用卡,直接搭配你現有的工具。