認証
APIキー
すべてのリクエストには Authorization ヘッダーでAPIキーを含める必要があります。
http
Authorization: Bearer YOUR_API_KEYヘッダーがない、またはキーが無効な場合、APIは 401 Unauthorized を返します。
ワークスペーススコープ
各APIキーは作成時に1つのワークスペースへ紐づきます。そのキーで行うリクエストは、そのワークスペース内でのみ動作します。アカウントが他のワークスペースのメンバーであっても、キーは他のワークスペースへアクセスできません。
アクセスルール
アクセスできる内容は、ワークスペース内のロールと各プロジェクトの参加状態によって決まります。
- ワークスペースメンバー（所有者、管理者、メンバー）は、ワークスペース全体に公開されたプロジェクトにアクセスできます。
- プロジェクトメンバー は、自分が参加しているプロジェクトにアクセスできます。
- 接続プロジェクトの参加者 は、他ワークスペースから共有されたプロジェクトにアクセスできます。
一部のエンドポイントでデータを書き込むには、最低限のプロジェクトロールが必要です。
| エンドポイント | 最小ロール |
|---|---|
| フォルダー作成 | 所有者、管理者、またはメンバー |
| フォルダー更新 | 所有者、管理者、またはメンバー |
| フォルダー削除 | 所有者、管理者、またはメンバー |
| マルチパートアップロード開始 | 所有者、管理者、またはメンバー |
| YouTubeファイルアップロード | 所有者、管理者、またはメンバー |
| マルチパートアップロード完了 | 所有者、管理者、またはメンバー |
| ファイル更新 | 所有者、管理者、またはメンバー |
| ファイル削除 | 所有者、管理者、またはメンバー |
| コメント作成 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| プロジェクトコメント作成 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| ファイルコメント添付ファイルアップロード開始 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| プロジェクトコメント添付ファイルアップロード開始 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| コメント添付ファイルアップロード完了 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| コメント添付ファイルアップロードキャンセル | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| コメント添付ファイル削除 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| レビュータグ更新 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| リアクション作成 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
| リアクション削除 | 所有者、管理者、メンバー、レビュアー、または制限付きレビュアー |
リソースへの読み取り権限はあるが書き込み権限がない場合、APIは 403 Forbidden を返します。
制限付きレビュアー
制限付きレビュアーには、制限付きアクセスが明示的に許可されたファイルのみ返されます。同じプロジェクト内の他のファイルは返されません。