コンテンツにスキップ

APIアクセス設定

プログラムでワークスペースにアクセスしたい場合は、APIキーを作成できます。このガイドでは、APIキーの取得と管理方法を説明します。

APIキーを取得

ステップ1: APIキー管理にアクセス

  1. ワークスペースに入る
  2. 「APIキー」タブ(API Keys)をクリック

ステップ2: 新しいキーを作成

「新規発行」ボタン(Issue New)をクリックします。

重要

  • 「新しいAPIキーを発行」ダイアログに表示されます:「ワークスペースリソースにアクセスするための新しいAPIキーを作成します。完全なキーは一度だけ表示されます。」
  • 作成後すぐにキーをコピーして安全に保存してください。

ステップ3: キーを設定

ダイアログに入力:

  • キー名(必須): キーを識別しやすい名前を付ける(例:「本番環境」、「テスト用」)
    • 入力しない場合、「キー名を入力してください」というエラーメッセージが表示されます
  • 有効期限(オプション): 「有効期限を選択」ボタンをクリックしてキーの有効期間を設定
    • 空白のままにすると期限なし
    • 日付選択ボタン(カレンダーアイコン付き)をクリックして日付を選択

ステップ4: キーを発行して保存

「キーを発行」ボタンをクリックすると、システムが完全なAPIキーを表示します。

重要

  • キーは作成時に一度だけ表示されます。すぐにコピーして安全に保存してください。
  • 紛失した場合は、新しいキーを作成する必要があります。

「コピー」ボタンをクリックして完全なキーをコピーし、「完了」をクリックします。

APIキーを管理

作成したキーを表示

「APIキー」タブ(API Keys)で、作成したすべてのキーを確認できます:

  • 名前: キーの識別名
  • キープレフィックス: キーの最初の数文字(識別用)
  • 作成日時: キーが作成された日付
  • 有効期限: キーが失効する日付(設定されている場合)

キーを取り消し

キーが漏洩したり、不要になった場合:

  1. 取り消すキーを見つける
  2. 「取り消し」ボタン(Revoke)をクリック
  3. 取り消しを確認

注意

取り消し後、そのキーを使用したすべてのリクエストが失敗します。そのキーを使用しているすべてのアプリケーションを更新してください。

セキュリティのベストプラクティス

キーを保護

  • フロントエンドコードでAPIキーを使用しない
  • バージョン管理システム(Gitなど)にキーをコミットしない
  • 環境変数を使用してキーを保存
  • 異なる環境(開発、テスト、本番)に異なるキーを使用
  • 定期的に使用していないキーを確認して取り消し

環境変数を使用

# .envファイル(Gitにコミットしない)
CODEER_API_KEY=your-api-key-here

# Pythonの例
import os
api_key = os.environ.get('CODEER_API_KEY')

有効期限を設定

キーに合理的な有効期限を設定することをお勧めします:

  • 一時的なテスト: 数日または数週間に設定
  • 本番使用: セキュリティポリシーに従って設定、例: 四半期ごとにローテーション

APIの使用

APIキーを取得したら、APIドキュメントをご覧ください：

公式API例

完全な動作例については、公式サンプルプロジェクトを参照してください： https://github.com/codeer-ai/codeer-api-examples

サンプルには以下が含まれます：

  • Chat APIの完全なデモンストレーション
  • Server-Sent Events (SSE)によるリアルタイムストリーミングレスポンス
  • Python / PHP / JavaScriptの多言語サンプル
  • GET_APIKEY.md: APIキー取得の補足説明

よくある質問

APIキーで何ができますか?

APIキーは、エージェントとの会話、設定の管理など、ワークスペースリソースにプログラムでアクセスするために使用されます。

キーを紛失したらどうなりますか?

キーは回復できません。紛失したキーを取り消して、新しいキーを作成してください。

複数のキーを作成できますか?

はい。異なる用途や環境に異なるキーを作成することをお勧めします。追跡と管理が容易になります。

キーが期限切れになるとどうなりますか?

期限切れ後、そのキーを使用したリクエストは拒否されます。新しいキーを作成してアプリケーションを更新する必要があります。