ventic APIキーの生成方法は?
venticプラットフォームとの統合リクエストを認証するには、APIキーが必要です。これらのキーはあなたの組織に固有のものであり、商品カタログやコマースサービスへの安全なアクセスを提供します。
APIキーの管理方法は以下の通りです。
1. デベロッパーパネルへのアクセス
venticアカウントにログインし、Settings > Developers セクションに移動します。そこに「API Keys」というタブがあります。
2. 新しいキーの作成
新しいキーを生成するには:
- “Create API Key” ボタンをクリックします。
- キーに分かりやすい名前を付けます(例:「Production - Main Store」や「Testing - Tanaka」)。
- 権限(スコープ)を選択します。キーには必要な権限のみを付与することをお勧めします(最小権限の原則)。
- “Generate” をクリックします。
3. キーの安全な保存
作成後、キーは一度だけ表示されます。
- 重要: キーをコピーして、安全な場所(パスワードマネージャーやシステムの安全なキー保管庫など)に保存してください。
- 注意: セキュリティ上の理由から、ウィンドウを閉じた後はキーの全内容を再表示することはできません。
4. リクエストでのキーの使用
ventic APIインターフェースに送信されるすべてのリクエストには、HTTPヘッダー X-API-Key にAPIキーを含める必要があります。
cURLを使用した例:
curl -X GET "https://api.ventic.ai/v1/products" \
-H "X-API-Key: your_api_key_here" \
-H "Accept: application/json"
5. キーのローテーションと無効化(リボケーション)
キーが漏洩した疑いがある場合は、直ちに無効化する必要があります。
- コントロールパネルで削除したいキーを選択し、“Revoke”(無効化)をクリックします。
- 無効化された後は、そのキーを使用したリクエストは拒否されます。
- 新しいキーを生成し、システムの構成を更新してください。
セキュリティに関する推奨事項
- ソースコード(GitHubなど)内にAPIキーを記述しないでください。環境変数(environment variables)を使用してください。
- テスト(Testing)環境と本番(Production)環境で別々のキーを使用してください。
- アクティブなキーのリストを定期的に確認し、使用されなくなったキーを削除してください。