API Cloud VPS
API key
Gửi trong header api-key của mọi lệnh. Không chia sẻ API key cho người khác.
Luồng sử dụng
Luồng mua: lấy danh sách mục → gói của mục → OS (và tài nguyên thêm nếu cần) của gói → tạo đơn. Sau khi mua, gọi chi tiết đơn để lấy IP / tài khoản / mật khẩu (VPS có thể mất vài phút để cài hệ điều hành).
Chu kỳ thanh toán (billingCycle): monthly, quarterly, semi_annually, annually, biennially, triennially. Chỉ dùng chu kỳ có trong cycles của gói.
Luồng xác thực
- Gọi
POST /api/agency/get-tokenvới headerapi-keyđể nhậnauth-token(hiệu lực 8 giờ). - Gửi cả hai header
api-keyvàauth-tokenvới mọi lệnh khác. Token hết hạn thì lấy lại ở bước 1.
Thử tích hợp không mất tiền bằng khoá thử tại Sandbox API.
Giới hạn
- Số request mỗi phút theo cấu hình của API key (mặc định 60).
- Lệnh trừ tiền (mua, gia hạn): tối đa 5 lệnh / 10 giây mỗi loại và 20 lệnh / phút mỗi key.
- Gửi header
Idempotency-Key(vd UUID) với lệnh mua, gia hạn. Gửi lại cùng khoá và cùng nội dung trong 24 giờ nhận lại kết quả lần đầu, không trừ tiền lần 2. - Vượt giới hạn trả mã 429 kèm header
Retry-After(số giây chờ).
Định dạng phản hồi & mã lỗi
Phản hồi có dạng { error, data?, message?, meta }. error = 0 là thành công, khác 0 là mã lỗi trùng HTTP status. message là tiếng Việt, hiển thị thẳng cho người dùng được.
| 400 | Dữ liệu không hợp lệ hoặc thao tác không thực hiện được (vd số dư không đủ) |
| 401 | Thiếu hoặc sai api-key / auth-token |
| 403 | Thiếu scope, IP không được phép hoặc tài khoản bị khoá |
| 404 | Không tìm thấy |
| 409 | Đang có thao tác khác trên dịch vụ này |
| 429 | Vượt giới hạn request |
| 502 | Máy chủ chưa phản hồi, thử lại sau |
| 503 | Hệ thống bảo trì |
Địa chỉ API
Base URL
/api/agencyBody gửi lên dạng JSON, header Content-Type: application/json.