nextX

SDK cho Node.js và Python

Gọi API với kiểu đầy đủ: đường dẫn, tham số và phản hồi được gợi ý ngay trong trình soạn thảo. Mã SDK sinh tự động từ tài liệu OpenAPI của cổng này, nên luôn khớp với API đang chạy.

Ngôn ngữGóiCàiPhiên bản
Node.js / TypeScript@nextxai/sdknpm install @nextxai/sdk0.1.1
Pythonnextx-sdkpip install nextx-sdk0.1.1

Node.js / TypeScript

Phiên bản 0.1.1 · Trang gói · Mã nguồn

Cài đặt
npm install @nextxai/sdk
Gọi bằng API key
import { createNextXClient, SANDBOX_URL } from "@nextxai/sdk";

const nx = createNextXClient({ apiKey: process.env.NEXTX_API_KEY!, baseUrl: SANDBOX_URL });

const { data, error } = await nx.GET("/api/v1/crm/contacts", {
  params: { query: { pageSize: 20 } },
});
if (error) throw new Error(`${error.status} ${error.title}`);
Ứng dụng OAuth: truyền access token (có thể là hàm để lấy token mới mỗi lần gọi)
const nx = createNextXClient({ accessToken: () => tokenStore.current() });

Python

Phiên bản 0.1.1 · Trang gói · Mã nguồn

Cài đặt
pip install nextx-sdk
Gọi bằng API key
import os
from nextx_sdk import create_client, SANDBOX_URL
from nextx_sdk.api.crm import contacts_list

nx = create_client(api_key=os.environ["NEXTX_API_KEY"], base_url=SANDBOX_URL)  # production: PROD_URL (https://api.nextx.vn)
page = contacts_list.sync(client=nx, page_size=20)

Mỗi thao tác là một module trong nextx_sdk.api.<phân hệ>: .sync() trả dữ liệu, .sync_detailed() kèm status code, .asyncio() cho mã async.

Lưu ý

  • API key gửi ở header X-Api-Key; access token OAuth gửi Authorization: Bearer. SDK tự đặt đúng header.
  • Mặc định gọi production. Thử nghiệm dùng sandbox với khoá sandbox — khoá sandbox không gọi được production và ngược lại.
  • Phiên bản theo Semantic Versioning, tách khỏi phiên bản API: máy so OpenAPI cũ và mới để quyết mức tăng; thay đổi phá vỡ phải có người duyệt. Chi tiết ở VERSIONING.md trong kho mã nguồn.
  • Bản xem trước theo API sandbox: npm i @nextxai/sdk@beta · pip install --pre nextx-sdk — có thể đổi bất kỳ lúc nào.
  • Ngôn ngữ khác: tải openapi.json và sinh client bằng công cụ OpenAPI bạn quen dùng.

Chính sách phiên bản →