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 格式正確。檢查是否使用了正確的前綴 Api-Key 而非 Bearer，並確認 API Key 本身沒有多餘的空格或字元。