跳到內容
群組GM API

取得 API 金鑰

API 金鑰用於驗證你對群組GM API 的存取權限。每把金鑰都有獨立的權限設定。

建立 API 金鑰

Section titled “建立 API 金鑰”

步驟 1：登入 Dashboard

Section titled “步驟 1：登入 Dashboard”

前往 Dashboard 並使用 LINE 帳號登入。

步驟 2：進入 API 金鑰頁面

Section titled “步驟 2：進入 API 金鑰頁面”

點擊側邊選單的「設定」>「API 金鑰」。

步驟 3：建立新金鑰

Section titled “步驟 3：建立新金鑰”
  1. 點擊「新增金鑰」按鈕
  2. 輸入金鑰名稱（例如：Production API）
  3. 選擇需要的權限
  4. 點擊「建立」

步驟 4：複製金鑰

Section titled “步驟 4：複製金鑰”

金鑰格式：gm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

權限說明

Section titled “權限說明”
權限說明可存取的 API
read:messages讀取訊息訊息備份、搜尋
read:members讀取成員成員列表、分析
read:media讀取媒體圖片、影片、檔案
write:assistant設定助理自動回覆、歡迎訊息、規則

最佳實踐

Section titled “最佳實踐”

依用途分開金鑰

Section titled “依用途分開金鑰”
Production API     → read:messages, read:members
Analytics Service  → read:messages, read:members
Backup Worker      → read:messages, read:media

定期輪換金鑰

Section titled “定期輪換金鑰”

建議每 90 天更換一次金鑰，步驟：

  1. 建立新金鑰
  2. 更新應用程式設定
  3. 確認新金鑰正常運作
  4. 刪除舊金鑰

安全存放

Section titled “安全存放”
Terminal window
# 使用環境變數
export GROUPGM_API_KEY="gm_xxxxx"


# 不要寫死在程式碼中
# ❌ 錯誤做法
api_key = "gm_xxxxx"


# ✅ 正確做法
api_key = os.environ.get("GROUPGM_API_KEY")

管理金鑰

Section titled “管理金鑰”

查看使用量

Section titled “查看使用量”

在 Dashboard 可以查看每把金鑰的：

  • 今日請求次數
  • 本月請求次數
  • 最後使用時間

刪除金鑰

Section titled “刪除金鑰”
  1. 找到要刪除的金鑰
  2. 點擊刪除按鈕
  3. 確認刪除

下一步

Section titled “下一步”

取得金鑰後，前往發送第一個請求測試連線。