Số dư nền tảng mở

Mô tả

Truy vấn số Credits khả dụng của tài khoản nền tảng mở hiện tại, hữu ích để thiết lập cảnh báo số dư.

Ghi chú dữ liệu: Dữ liệu số dư có thể có độ trễ ngắn; lấy kết quả thực tế từ API làm chuẩn.

Endpoint

• Phương thức: GET
• Path: /open/v1/credit/balance

Credits

• Chi phí: 0

Điều kiện tiên quyết

• Sử dụng API Key hợp lệ.
• Header phải gồm X-API-KEY, X-TIMESTAMP, X-SIGN.
• Request GET không có body; chuỗi ký là X-TIMESTAMP nối với chuỗi rỗng.

Tham số request

Không có path parameter, query parameter hoặc request body.

Request headers

Header	Bắt buộc	Mô tả
X-API-KEY	Có	API Key của bạn
X-TIMESTAMP	Có	Timestamp mili giây 13 chữ số hiện tại; lệch với giờ máy chủ không quá 5 phút
X-SIGN	Có	Chữ ký HMAC-SHA256 của X-TIMESTAMP + body rỗng bằng Secret ứng dụng

Xem 「Xác thực / Quy trình gọi đầy đủ」 để biết quy tắc ký đầy đủ.

Trường response

Chỉ các trường trong đối tượng data:

Trường	Kiểu	Kiểu trả về thực tế	Mô tả
balance	long	string	Tổng Credits khả dụng
buyBalance	long	string	Credits khả dụng từ mua
giveBalance	long	string	Credits khả dụng từ tặng
recentExpireTime	date	number / null	Thời điểm hết hạn của lô Credits gần nhất (timestamp ms); null khi không còn Credits
recentBalance	long	string	Số Credits trong lô sắp hết hạn gần nhất; "0" khi không còn Credits

Quan hệ trường

• balance = buyBalance + giveBalance.
• recentExpireTime và recentBalance dùng để biết thời điểm và số lượng Credits của lô gần nhất sắp hết hạn.
• Khi không còn Credits, balance, buyBalance, giveBalance, recentBalance đều là "0", recentExpireTime là null.

Ví dụ cURL (Linux/macOS)

curl --location --request GET 'https://api.valuescan.ai/api/open/v1/credit/balance' \
--header 'X-API-KEY: your-api-key' \
--header 'X-TIMESTAMP: 1785110400000' \
--header 'X-SIGN: xxxxx' \
--header 'Accept: application/json'

Ví dụ cURL (Windows CMD)

curl --location --request GET "https://api.valuescan.ai/api/open/v1/credit/balance" ^
--header "X-API-KEY: your-api-key" ^
--header "X-TIMESTAMP: 1785110400000" ^
--header "X-SIGN: xxxxx" ^
--header "Accept: application/json"

Ví dụ response thành công

{
    "code": 200,
    "message": "success",
    "data": {
        "balance": "15000",
        "recentExpireTime": 1785513600000,
        "recentBalance": "3000",
        "buyBalance": "10000",
        "giveBalance": "5000"
    },
    "requestId": "xxx-xxx-xxx"
}

Ví dụ response không còn số dư

{
    "code": 200,
    "message": "success",
    "data": {
        "balance": "0",
        "recentExpireTime": null,
        "recentBalance": "0",
        "buyBalance": "0",
        "giveBalance": "0"
    },
    "requestId": "xxx-xxx-xxx"
}

Lỗi thường gặp

Mã lỗi	Mô tả
20001	Thiếu API Key
20012	Timestamp request đã hết hạn
20021	Xác minh chữ ký thất bại
60001	Vượt giới hạn tần suất
70002	Quyền truy cập OpenAPI của người dùng hiện tại đã bị vô hiệu hóa