調用 API

應用程式的所有操作都是通過您可以自己調用的相同 HTTP API 進行的。每個端點都在 REST API 參考中列出；本頁面涵蓋您在任何端點之前需要的三件事。

身份驗證

發送身份令牌作為承載憑據：

curl -H "Authorization: Bearer <your-token>" \
     https://app.example.com/api/workflows

令牌來自登錄。沒有單獨的 API 密鑰要創建：您的 API 身份就是您的用戶身份，因此您在應用程式中可以訪問的任何東西都可以通過 curl 訪問，沒有其他方式。

每個端點都需要這個。 沒有匿名讀取：未提供憑據的請求在到達端點之前就被拒絕，不論端點是什麼。少數真正的公共路徑 — 價格列表、這些文檔 — 是由於明確決定而公開的，而不是因為身份驗證是可選的。

如果您屬於多個 workspace，請告訴我們請求所屬的那個：

curl -H "Authorization: Bearer <your-token>" \
     -H "X-Account-Id: <workspace-id>" \
     https://app.example.com/api/workflows

省略它，您將獲得您最早的 workspace。如果發送您不是成員的 workspace，您將獲得您最早的 workspace — 標頭在您已經屬於的 workspaces 中進行選擇，而不會授予您對不屬於您的 workspace 的訪問權限。

該標頭名為 X-Account-Id 是出於歷史原因；其值為 workspace id。在其他地方，這個詞指的是您自己的登錄。

您將只會看到您自己的 workspaces 的數據。一個集合端點將返回您的行，而沒有其他；請求某個您不是成員的 workspace 中的東西會被拒絕，而不是返回空結果。

如果您的組織運行多個品牌產品，您調用的主機選擇了哪一個。相同的憑據在兩個不同的主機上會看到兩套不同的 workspaces — 您在每個中的 workspaces。這是故意的：一個 workspace 屬於一個品牌，請求必須說明它是為了哪個品牌。

狀態	含義	該怎麼做
`401`	沒有憑據，或無效	重新登錄並使用新令牌重試
`402`	該 workspace 沒有有效的訂閱	讀取仍然有效；寫入需要計劃。請參見使用與計費
`403`	已經過身份驗證，但您無權修改	您不是該 workspace 的成員，或者該操作需要所有者
`404`	未找到 — 或者不屬於您	對於按名稱地址的資源，我們回答 404 而不是 403，以便響應不會確認某物存在
`429`	速率限制，或預付信用用盡	放慢速度；如果它顯示信用，請充值

了解 402 是值得的：未付款的 workspace 會變為只讀而不是關閉。您可以保留對已存在的一切的訪問權限，並且仍然可以導出它 — 您只不可以創建新的工作，直到再次有計劃為止。計費和成員資格端點仍然有效，因為那是您解決問題的方法。

兩類端點不是由已登錄的人調用，因此不使用您的令牌：

如果擁有的 workspace 沒有有效的訂閱，兩者都會明確拒絕，而不會降級為只讀。外部人員在他人網站上不應該顯示計費問題。