Chuyển đến nội dung

Cài Đặt

Cài Đặt

Terminal window
npm install @imbrace/sdk
# hoặc
yarn add @imbrace/sdk
# hoặc
pnpm add @imbrace/sdk

Yêu cầu Node.js 18+ (hoặc bất kỳ trình duyệt nào hỗ trợ native fetchReadableStream).

Khởi Tạo Client

import { ImbraceClient } from "@imbrace/sdk"
// Build on Imbrace — Imbrace IS your backend, end-users log in via OTP
const client = new ImbraceClient({
accessToken: "acc_your_token",
baseUrl: "https://app-gatewayv2.imbrace.co",
})

Client có trạng thái — tạo một lần và tái sử dụng trong toàn bộ ứng dụng.

Để biết khi nào dùng loại credential nào, xem Xác Thực. Để thiết lập credentials từng bước (env vars, dotenv, secrets), xem Hướng Dẫn Cài Đặt.

Kiểm Tra

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

Biến Môi Trường

SDK không tự đọc biến môi trường. Truyền credentials trực tiếp vào constructor và dùng loader (dotenv / cách xử lý env của framework) nếu bạn lưu chúng trong .env.

BiếnMục đích
IMBRACE_API_KEYAPI key của bạn (org-level credential)
IMBRACE_ACCESS_TOKENAccess token của user (per-session credential)
IMBRACE_BASE_URLOverride gateway URL (mặc định: https://app-gatewayv2.imbrace.co)

Org id được mã hoá trong cả API keys và access tokens — bạn không bao giờ cần truyền organizationId/organization_id cho SDK. Xem Xác Thực để biết thêm chi tiết.