API 認証

本ページでは、MaiAgent API を利用する際の認証方法と取得方法をご紹介します

MaiAgent では、API キーを使用して認証を行います。

認証方式

すべての API リクエストでは、HTTP Header に API Key を以下の形式で含める必要があります。

const headers = {
  "Authorization": "Api-Key YOUR_API_KEY_HERE",
  "Content-Type": "application/json"
}

API キーの取得方法

MaiAgent の管理画面にログインしたうえで、以下の手順に従って操作してください。

1. 右上の「ユーザー名」プルダウンメニューをクリックします

2. 「アカウント」をクリックして個人情報ページに移動します

1. ページを API キーページに切り替えます。

1. 「API キー」をコピーして確認できます。

• セキュリティに関する注意：API キーは適切に保管し、公開の場で共有しないでください

• キー形式の説明：API キーは英数字の組み合わせです

エラー処理

認証エラーが発生した場合、API は 401 Unauthorized の HTTP エラーコードを返します。

• API Key が無効または欠落している

{
  "detail": "Authentication credentials were not provided."
}

修正方法：リクエストヘッダーに正しい Authorization フィールドが含まれているかを確認してください。形式は次のようになります： Authorization: Api-Key YOUR_API_KEY

• API Key の形式が誤っている

{
  "detail": "Invalid API key format."
}

修正方法：API Key の形式が正しいかを確認してください。Bearer ではなく正しいプレフィックス Api-Key を使用しているか、また API Key 自体に余分なスペースや文字が含まれていないかを確認してください。