Bỏ qua để đến nội dung

Tổng quan API nền tảng

API nền tảng cho phép script và hệ thống bên thứ ba thay bạn quản lý tài khoản RouteAPI: truy vấn số dư, tạo và quản lý API Key, xem log của tài khoản (có xuất CSV/JSONL) và thống kê mức sử dụng.

Base URL: https://www.routeapi.ai/api/open/v1
Xác thực: Authorization: Bearer rat_xxxx — xem Xác thực API nền tảng để tạo và lưu Management Key.

Terminal window
curl https://www.routeapi.ai/api/open/v1/balance \
-H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

Mọi endpoint dưới /api/open/v1 đều dùng cùng header này. Phản hồi dùng body thống nhất { success, message, data }; định dạng đó, mã lỗi và giới hạn tần suất xem tại Lỗi và giới hạn.

Mọi trường số tiền đều tính theo tiền tệ hiển thị của trang, làm tròn hai chữ số thập phân (ví dụ 10.00); tiền tệ được trả về bởi Lấy số dư. Mỗi khoản tiền được làm tròn riêng, vì vậy tổng tiền có thể lệch tới 0,01 so với tổng các khoản tiền từng dòng.

Các endpoint dạng danh sách dùng chung cách phân trang theo số trang:

Tham sốKiểuMặc địnhMô tả
pinteger1Số trang, từ 1 đến 1000000
page_sizeinteger10Số mục mỗi trang, từ 1 đến 1000

p hoặc page_size được truyền rõ ràng phải nằm trong các khoảng trên. Giá trị không phải số nguyên, 0, số âm hoặc ngoài khoảng đều trả về 400 invalid_request; không bao giờ bị thay thế hay giới hạn một cách âm thầm. page / page_size trong phản hồi là giá trị thực tế được áp dụng.

Với các endpoint log, total chỉ đếm tối đa 10000 và luôn là 10000 khi có nhiều kết quả hơn; hãy lấy dữ liệu cũ hơn theo các khoảng thời gian ngắn hơn.

Không đặt dấu ; thô trong query string; hãy mã hóa thành %3B, nếu không toàn bộ yêu cầu trả về 400 invalid_request. Mã hóa % thành %25, dùng + hoặc %20 cho khoảng trắng.

Các đường dẫn dưới đây tương đối so với https://www.routeapi.ai/api/open/v1.

Phương thứcĐường dẫnMô tả
GET/balanceLấy số dư
Phương thứcĐường dẫnMô tả
GET/keysLiệt kê API Key
GET/keys/:idLấy một API Key
GET/keys/:id/keyXem API Key đầy đủ
POST/keysTạo API Key
PATCH/keys/:idCập nhật API Key
DELETE/keys/:idXóa API Key
Phương thứcĐường dẫnMô tả
GET/logsLấy log của tài khoản
GET/logs/exportXuất log
Phương thứcĐường dẫnMô tả
GET/usageLấy thống kê mức sử dụng
GET/usage/modelsLấy mức sử dụng theo mô hình
GET/usage/keysLấy mức sử dụng theo Key