Caretは、リクエストの認証にAPIキーを使用します。APIキーは、ダッシュボードの[開発者設定]ページで確認および管理できます。
APIキーの作成
新しいAPIキーを生成するには、以下の手順に従ってください：
設定に移動
Caretワークスペースの開発者設定セクションに移動します。
キーの生成
「新しいAPIキーを作成」をクリックします。後で目的を識別しやすいように、わかりやすい名前を付けてください。
権限の割り当て
このキーがアクセスできる特定のスコープを選択します。最小権限の原則に従うことをお勧めします。
コピーして保存
APIキーをすぐにコピーしてください。セキュリティ上の理由から、再度表示することはできません。
APIキーには重要な権限が含まれています。GitHub、クライアントサイドのコード、公開フォーラムなどの公開された場所に共有しないでください。
APIキーの使用
すべてのAPIリクエストには、X-API-Key HTTPヘッダーにAPIキーを含める必要があります。
curl -X GET "https://api.caret.so/v1/me" \
-H "X-API-Key: your_api_key_here"
| スコープ | 説明 |
|---|
users | ユーザー情報の読み取りとワークスペースへの招待の管理。 |
tags | フォルダをタグとして一覧表示および管理（レガシーサポート）。 |
notes | 会議ノートとサマリーの読み取りおよび書き込み。 |
folders | ワークスペースフォルダの作成、更新、削除。 |
templates | 会議テンプレートとAIプロンプト設定の管理。 |
ベストプラクティス
- 統合ごとに1つのキー：異なるサービスや環境（例：開発用と本番用）には別々のAPIキーを使用してください。
- キーを定期的にローテーションする：潜在的な漏洩の影響を最小限に抑えるために、定期的にAPIキーを再生成してください。
- 環境変数を使用する：APIキーをソースファイルにハードコーディングするのではなく、環境変数に保存してください。
トラブルシューティング
認証エラーが発生した場合は、以下を確認してください：
- 401 Unauthorized：APIキーが不足しているか、無効であるか、取り消されています。
X-API-Keyヘッダーが正しくフォーマットされていることを確認してください。
- 403 Forbidden：APIキーは有効ですが、アクセスしようとしているエンドポイントに必要な権限がありません。
- 期限切れのキー：キーに有効期限があり、それを過ぎていないか確認してください。
