Blue API 使用基於令牌的認證系統。
標頭
在執行任何查詢之前,設置 API 請求的標頭是至關重要的。這些標頭在所有請求中保持一致,只需一次性設置。它們用於對每個請求進行身份驗證。
所需的標頭是 Token-ID 和 Secret-ID,分別表示為 x-bloo-token-id
和 x-bloo-token-secret
。
此外,某些請求可能需要包含公司 ID x-bloo-company-id
和項目 ID x-bloo-project-id
以進行更具體的操作。
您可以在以下視頻中學習如何創建令牌和密鑰:
令牌 ID
令牌 ID 是您 API 訪問的唯一標識符。
要開始使用我們的 API,請單擊右上角的個人資料,在個人資料菜單下,您將找到 API 標籤。
在 API 標籤中,單擊“生成令牌”按鈕:
為令牌提供一個名稱,並根據需要設置到期日期。如果您設置了到期日期,則 API 令牌將在該日期後自動停止工作。
生成後,您將看到一個令牌 ID 和一個密鑰 ID。令牌 ID 將以 pat_
為前綴,以便於識別。
密鑰 ID
密鑰 ID 作為密碼,確保與 Blue 的 API 之間的安全通信。
請記住,出於安全原因,密鑰 ID 只顯示一次,因此請安全存儲以保持通過 API 訪問您的數據。為了最大限度地提高安全性,Blue 使用 bcrypt 哈希存儲您的密鑰,這意味著即使我們的團隊也無法在創建後檢索您的明文密鑰。
確保您妥善保管您的令牌 ID 和密鑰 ID,因為任何擁有這些憑證的人都可以訪問您在 Blue 的數據。
公司和項目 ID
這裡有一個視頻顯示如何在 Blue 中找到您的公司 ID 和項目 ID:
公司是 Blue 中的頂層實體。公司 ID 用於識別 Blue 中的公司。它們在 API 中用於指定要與之互動的公司。該 ID 與您訪問 Blue 中公司的 URL 中的公司 slug 相同:
app.blue.cc/company/{company-id}/
對於某些查詢和變更,您需要提供項目 ID。這是您要互動的項目的 ID。該 ID 與您訪問 Blue 中項目的 URL 中的項目 slug 相同:
app.blue.cc/company/{company-id}/project/{project-id}/