Skip to content

認証

API キー

すべてのリクエストは Authorization ヘッダーに API キーを含める必要があります:

http
Authorization: Bearer YOUR_API_KEY

ヘッダーが存在しないか、キーが無効な場合、API は 401 Unauthorized を返します。

ワークスペーススコープ

各 API キーは作成時に 1 つのワークスペースに紐づけられます。そのキーで行うリクエストは、そのワークスペースのみで動作します。たとえアカウントが他のワークスペースのメンバーであっても、他のワークスペースにはアクセスできません。

アクセスルール

アクセスできる範囲は、ワークスペースおよび個々のプロジェクトにおけるあなたのロールによって異なります:

  • ワークスペースメンバー(Owner、Manager、Member)は、ワークスペース全体に公開されているプロジェクトにアクセスできます。
  • プロジェクトメンバーは、所属するプロジェクトに常にアクセスできます。
  • 連携プロジェクトの参加者は、別のワークスペースから共有されたプロジェクトにアクセスできます。

データを書き込むには、最低限のプロジェクトロールが必要なエンドポイントがあります:

エンドポイント最低必要ロール
コメント作成Owner、Manager、Member、Reviewer、または RestrictedReviewer
ステータス更新Owner、Manager、Member、Reviewer、または RestrictedReviewer
リアクション追加Owner、Manager、Member、Reviewer、または RestrictedReviewer
リアクション削除Owner、Manager、Member、Reviewer、または RestrictedReviewer

リソースへの読み取りアクセスはあるが書き込みアクセスがない場合、API は 403 Forbidden を返します。

制限付きレビュアー

制限付きレビュアー(RestrictedReviewer)は、明示的に制限アクセス対象としてマークされたバージョンのみを受け取ります。同じプロジェクト内の他のバージョンは返されません。