Blue APIはトークンベースの認証システムを使用しています。


ヘッダー

クエリを実行する前に、APIリクエストのヘッダーを設定することが重要です。これらのヘッダーはすべてのリクエストで一貫しており、一度の設定で済みます。これらはAPIへの各リクエストを認証するために使用されます。

必要なヘッダーは、x-bloo-token-idとして表されるToken-IDと、x-bloo-token-secretとして表されるSecret-IDです。

さらに、特定のリクエストでは、より具体的な操作のためにCompany-ID x-bloo-company-idとProject-ID x-bloo-project-idを含める必要があります。

トークンとシークレットの作成方法については、以下のビデオをご覧ください:

トークンID

トークンIDは、APIアクセスのためのあなたのユニークな識別子です。

APIを使用するには、右上のプロフィールをクリックし、プロフィールメニューの下にあるAPIタブを見つけてください。

API 2

APIタブで、「トークンを生成」ボタンをクリックします:

API 3

トークンの名前を入力し、必要に応じて有効期限を設定します。有効期限を設定した場合、その日付以降はAPIトークンは自動的に無効になります。

API 4

生成後、トークンIDとシークレットIDが表示されます。トークンIDは、識別を容易にするためにpat_でプレフィックスが付けられます。

シークレットID

シークレットIDはパスワードとして機能し、BlueのAPIとの安全な通信を確保します。

セキュリティ上の理由から、シークレットIDは一度だけ表示されるため、安全に保管してAPIを通じてデータにアクセスできるようにしてください。最大限のセキュリティのために、Blueはbcryptハッシュを使用してシークレットを保存しており、作成後は当社のチームでさえプレーンテキストのシークレットを取得することはできません。

API 5

セキュリティ警告


トークンIDとシークレットIDを安全に保管してください。これらの資格情報にアクセスできる人は、Blueのデータにアクセスできます。

会社およびプロジェクトID

Blueで会社IDとプロジェクトIDを見つける方法を示すビデオがあります:

会社はBlueの最上位のエンティティです。会社IDは、Blue内の会社を識別するために使用されます。APIでは、どの会社とやり取りするかを指定するために使用されます。IDは、Blueで会社を訪問したときのURL内の会社スラッグと同じです:

app.blue.cc/company/{company-id}/

特定のクエリやミューテーションでは、プロジェクトIDを提供する必要があります。これは、やり取りしたいプロジェクトのIDです。IDは、Blueでプロジェクトを訪問したときのURL内のプロジェクトスラッグと同じです:

app.blue.cc/company/{company-id}/project/{project-id}/

AIアシスタント

回答はAIを使用して生成されており、間違いが含まれる可能性があります。

どのようにお手伝いできますか?

Blueやこのドキュメントについて何でも聞いてください。

送信するにはEnterを押してください • 新しい行を作成するにはShift+Enterを押してください • ⌘Iで開く