安裝

安裝

TypeScript

npm install @imbrace/sdk
# or
yarn add @imbrace/sdk
# or
pnpm add @imbrace/sdk

需要 Node.js 18+（或任何支援原生 fetch 和 ReadableStream 的瀏覽器）。

Python

pip install imbrace
# or
uv add imbrace

需要 Python 3.9+。

初始化客戶端

TypeScript

import { ImbraceClient } from "@imbrace/sdk"

// 建構於 Imbrace — Imbrace 就是您的後端，終端使用者透過 OTP 登入
const client = new ImbraceClient({
  accessToken: process.env.IMBRACE_ACCESS_TOKEN,
  env: "stable",
})

客戶端是有狀態的 — 建立一次並在整個應用程式中重複使用。

Python

import os
from imbrace import ImbraceClient

# 建構於 Imbrace — Imbrace 就是您的後端，終端使用者透過 OTP 登入
with ImbraceClient(
    access_token=os.environ["IMBRACE_ACCESS_TOKEN"],
    env="stable",
) as client:
    me = client.platform.get_me()

Python 也匯出 AsyncImbraceClient（async with ...）用於非同步技術棧，如 FastAPI。

context manager 會自動關閉底層的 HTTP 連線池。

TypeScript

import { ImbraceClient } from "@imbrace/sdk"

// 包裝 Imbrace — Imbrace 是您後端內部的功能，您的使用者
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

# 包裝 Imbrace — Imbrace 是您後端內部的功能，您的使用者
with ImbraceClient(
    api_key=os.environ["IMBRACE_API_KEY"],
    organization_id=os.environ.get("IMBRACE_ORGANIZATION_ID"),
    env="stable",
) as client:
    me = client.platform.get_me()

Python 也匯出 AsyncImbraceClient（async with ...）用於非同步技術棧，如 FastAPI。

context manager 會自動關閉底層的 HTTP 連線池。

有關何時使用每種憑證，請參閱認證。如需逐步憑證設定（環境變數、dotenv、secrets），請參閱設定指南。

驗證

TypeScript

import { ImbraceClient } from "@imbrace/sdk"
console.log("SDK loaded:", typeof ImbraceClient) // "function"

Python

from imbrace import ImbraceClient
print("SDK ready:", ImbraceClient)

環境變數

SDK 不會自動讀取環境變數。請直接在建構函式中傳遞憑證，如果您將憑證存放在 .env 中，請使用載入器（dotenv / 您框架的環境變數處理）。

變數	用途
IMBRACE_API_KEY	您的 API 金鑰（組織層級憑證）
IMBRACE_ACCESS_TOKEN	使用者的存取令牌（每次連線的憑證）
IMBRACE_ORGANIZATION_ID	組織 ID — 在每個請求中作為 x-organization-id 傳遞
IMBRACE_GATEWAY_URL	覆寫閘道 URL（預設：https://app-gatewayv2.imbrace.co）

組織 ID 已編碼在 API 金鑰和存取令牌中。您可以選擇性地在建構函式中傳遞 organizationId（TypeScript）或 organization_id（Python）來覆寫它。詳情請參閱認證。

---

下一步

• 快速入門 → — 在 60 秒內完成您的第一次 API 呼叫
• 認證 → — 憑證類型、OTP 登入流程以及何時使用每種憑證
• 設定指南 → — 環境、環境變數和服務 URL 覆寫