取得 API 金鑰

API 金鑰（api_...）讓您的後端可以在沒有使用者連線的情況下呼叫 Imbrace。有關何時使用 API 金鑰與存取令牌，請參閱認證。

---

從 UI 取得 API 金鑰

步驟 1 — 登入 Imbrace 入口網站，然後導覽至 GovernCore → Generate External Token。

步驟 2 — 點擊 Generate Token 以簽發新的 API 金鑰。

步驟 3 — 複製產生的金鑰。它以 api_ 開頭，且僅顯示一次。

---

透過 SDK 生成（程式化）

當您需要從程式碼產生金鑰時使用，例如在自動化佈建期間。您必須先用存取令牌進行認證（透過 OTP 或密碼）。

TypeScript

// 需要使用存取令牌初始化的客戶端
const res = await client.auth.getThirdPartyToken(30) // 30 天後過期
const apiKey = res.apiKey.apiKey  // "api_..."

Python

# 需要使用存取令牌初始化的客戶端
res = client.auth.get_third_party_token(expiration_days=30)
api_key = res["apiKey"]["apiKey"]  # "api_..."

回應形狀（下方為完整欄位 — 為簡潔起見省略內部欄位）：

{
  "apiKey": {
    "_id": "...",
    "apiKey": "api_...",
    "organization_id": "...",
    "user_id": "...",
    "is_active": true,
    "expired_at": "2025-08-01T00:00:00.000Z",
    "created_at": "2025-07-01T00:00:00.000Z",
    "updated_at": "2025-07-01T00:00:00.000Z",
    "is_temp": false
  },
  "expires_in": 2592000
}

---

使用金鑰

將金鑰傳遞給客戶端建構函式：

TypeScript

import { ImbraceClient } from "@imbrace/sdk";

const client = new ImbraceClient({
  apiKey: process.env.IMBRACE_API_KEY!,
  organizationId: process.env.IMBRACE_ORGANIZATION_ID,
  env: "stable",
});

Python

import os
from imbrace import ImbraceClient

client = ImbraceClient(
    api_key=os.environ["IMBRACE_API_KEY"],
    organization_id=os.environ.get("IMBRACE_ORGANIZATION_ID"),
    env="stable",
)