認証と API Key の設定

API の認証方式​

Asgard は X-API-KEY ヘッダーで API の認証を行います。すべての API リクエストに有効な API Key が必要です。

Request Header​

POST /generic/ns/{namespace}/bot-provider/{bot_provider_name}/message/sse
Content-Type: application/json
X-API-KEY: your-api-key-here

API Key の取得​

1. Asgard プラットフォームにログインします
2. 対象の Project を開きます
3. Integration > App の設定ページへ進みます
4. API Key を新規に作成するか、既存のものをコピーします

LLM Provider の API Key​

Asgard は複数の LLM Provider に対応しており、それぞれの API Key をプラットフォーム上で設定します。

設定の手順​

1. AI Brain > Completion Model または Embedding Model へ進みます
2. 対象の Provider を選びます
3. その API Key と Endpoint を入力します（Azure は追加の設定が必要です）
4. 接続をテストして設定が正しいことを確認します

詳しい手順は Completion Model の設定 と Embedding Model の設定 をご覧ください。

SDK での認証設定​

JavaScript SDK（@asgard-js/core）​

import { AsgardServiceClient } from '@asgard-js/core';
 
const client = new AsgardServiceClient({
  botProviderEndpoint:
    'https://api.asgard-ai.com/ns/{namespace}/bot-provider/{botProviderId}',
  apiKey: 'your-api-key', // 環境変数から読み込むことを推奨します
});

認証情報の渡し方は 2 通りあります。Direct Connect では apiKey をそのまま渡します。Backend Relay や独自の認証を使う場合は customHeaders（例: Authorization: Bearer <token>）を使います。詳しくはフロントエンド SDK の使い方をご覧ください。

React SDK（@asgard-js/react）​

React では <Chatbot> コンポーネントを使い、認証情報を config に入れます。

import { Chatbot } from '@asgard-js/react';
import '@asgard-js/react/style';
 
function App() {
  return (
    <Chatbot
      config={{
        botProviderEndpoint:
          'https://api.asgard-ai.com/ns/{namespace}/bot-provider/{botProviderId}',
        apiKey: process.env.REACT_APP_ASGARD_API_KEY, // 環境変数から読み込むことを推奨します
      }}
      customChannelId="user-123"
    />
  );
}

安全に扱うために​

環境変数での管理​

API Key はコードに直接書かず、環境変数に置いてください。

# .env
ASGARD_API_KEY=your-api-key-here

const apiKey = process.env.ASGARD_API_KEY;

バックエンド経由にする​

本番環境では、バックエンドのサービスを経由して API リクエストを転送し、API Key がフロントエンドに出ないようにしてください。

Key Rotation（キーの入れ替え）​

API Key は定期的に入れ替え、リスクを下げてください。

1. Asgard プラットフォームで新しい API Key を作ります
2. アプリケーション側の API Key の設定を更新します
3. 新しいキーが正しく動くことを確認してから、古いキーを無効にします

Rate Limits​

その他の制限はクォータと制限をご覧ください。

次に読む​

• メッセージ送信 API — エンドポイントの詳細な仕様
• 概要と選び方 — 4 つの統合方式の比較と選び方
• フロントエンド SDK の使い方 — フロントエンド SDK の導入と応用
• バックエンド SDK の使い方 — Backend Relay 方式のバックエンド SDK
• コード例 — よくある統合の例