Blue API 使用基于令牌的认证系统。
头部
在执行任何查询之前,设置 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 哈希存储您的密钥,这意味着即使我们的团队在创建后也无法检索您的明文密钥。
确保您保持 Token ID 和 Secret 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}/