Tích hợp API sPortal: tự quản lý VPS, Proxy trên dashboard hoặc hệ thống riêng
Mục lục 1. API sPortal dành cho ai? 2. Làm được gì qua API? 3. Ví API: giao dịch và thanh toán qua Ví API 4. An toàn khi tích hợp 5. Thử trước trong sandbox, không mất tiền 6. Ba bước bắt đầu 7. Câu hỏi thường gặp
1. API sPortal dành cho ai?
API sPortal dành cho khách hàng của đại lý đã có website, dashboard hoặc phần mềm bán hàng riêng và có đội kỹ thuật. Thay vì đăng nhập cổng khách hàng để thao tác từng việc, hệ thống riêng gọi API để làm tự động. Đây là cách thứ hai trong bài Hai cách trở thành đại lý sPortal: webapp có sẵn hay tích hợp API.
- Đơn vị bán lại: đưa dịch vụ cloud vào website của mình, khách đặt mua là dịch vụ được tạo ngay.
- Doanh nghiệp dùng nhiều máy: quản lý hàng loạt VPS, Proxy từ dashboard nội bộ, tự gia hạn trước khi hết hạn.
- Nhà phát triển phần mềm: gắn việc tạo, bật tắt dịch vụ vào quy trình của sản phẩm.
2. Làm được gì qua API?
Các việc chính khi mua và dùng dịch vụ đều làm được qua API:
- Xem sản phẩm và giá theo nhóm giá đại lý áp cho Quý khách hàng, theo từng chu kỳ.
- Mua mới dịch vụ, theo dõi trạng thái đơn.
- Gia hạn, nâng cấp, bật hoặc tắt tự động gia hạn.
- Thao tác dịch vụ: bật, tắt, khởi động lại, cài lại; xem thông tin dịch vụ và ngày hết hạn.
- Quản lý ví: xem số dư, biến động, tạo lệnh nạp ví.
Kết quả được báo về hệ thống của Quý khách hàng qua webhook: đơn đã thanh toán, dịch vụ đã tạo xong hay tạo lỗi, đã gia hạn, sắp hết hạn, ví sắp hết tiền. Hệ thống không cần gọi đi gọi lại để hỏi trạng thái.
3. Ví API: giao dịch và thanh toán qua Ví API
Mua qua API phải chạy tự động, không thể chờ thanh toán thủ công cho từng đơn. Vì vậy tài khoản dùng API có Ví API trả trước: mọi giao dịch mua mới, gia hạn, nâng cấp đều trừ vào ví.
- Nạp tiền vào Ví API qua cổng khách hàng hoặc tạo lệnh nạp qua API. Tiền vào là ví được cộng tự động.
- Giá qua Ví API là giá chưa VAT. Nếu nạp có xuất hóa đơn, VAT được tính một lần lúc nạp, mua hàng bằng ví không tính thuế thêm. Có hoặc không xuất hóa đơn tùy loại tài khoản ngân hàng của đại lý.
- Tự đặt ngưỡng cảnh báo: ví xuống dưới mức đã đặt sẽ có email và webhook báo trước.
- Ví không đủ tiền thì API báo lỗi số dư, không tạo đơn, không trừ tiền.
Cần ước lượng thời gian tích hợp cho hệ thống của mình? Liên hệ Sale hoặc chat với chúng tôi để được tư vấn.
4. An toàn khi tích hợp
API có tác động tới tiền và dịch vụ thật, nên mỗi lần gọi đều được kiểm tra nhiều lớp:
- Chỉ IP đã khai mới gọi được. Quý khách hàng khai danh sách IP máy chủ khi đăng ký và tự sửa được sau đó.
- Mỗi request đều được ký bằng khóa bí mật. Khóa chỉ hiển thị một lần lúc tạo, có thể tạo khóa mới thay khóa cũ.
- Chống trừ tiền hai lần: gọi lại cùng một yêu cầu (ví dụ do ngắt kết nối mạng) chỉ trả lại kết quả cũ, ví không bị trừ thêm.
- Nhật ký gọi API hiển thị cho Quý khách hàng và đại lý, dễ tra khi có sự cố.
- Đại lý quản lý quyền dùng API: có thể tạm khóa, mở lại hoặc thu hồi. Khi bị khóa, số dư ví vẫn giữ nguyên.
5. Thử trước trong sandbox, không mất tiền
Trước khi chạy thật, Quý khách hàng thử toàn bộ luồng trong môi trường thử nghiệm (sandbox):
- Khóa thử riêng, tách hẳn khỏi khóa thật: khóa thử không thể chạm tới ví thật, dịch vụ thật hay hóa đơn.
- Ví thử 1.000.000 đ để mua, gia hạn, nâng cấp; dịch vụ thử tự chuyển trạng thái như dịch vụ thật.
- Kiểm tra chữ ký: hệ thống chỉ ra chỗ sai khi ký request, lỗi hay gặp nhất khi mới tích hợp.
- Gửi thử webhook theo từng loại sự kiện để kiểm tra phần nhận thông báo của hệ thống.
Dữ liệu thử tự xóa sau 7 ngày không dùng, hoặc tự xóa ngay để làm lại từ đầu.
6. Ba bước bắt đầu
- Gửi form đăng ký tích hợp API ngay trên cổng khách hàng, kèm thông tin kinh doanh, danh sách IP máy chủ và người liên hệ kỹ thuật. Xem hướng dẫn Tích hợp API.
- Chờ đại lý duyệt. Khi được duyệt, Quý khách hàng có Ví API, xem tài liệu API ngay trên trang Tích hợp API và tạo khóa API để kết nối.
- Thử rồi chạy thật. Thử với khóa thử trong sandbox (xem hướng dẫn Môi trường thử nghiệm), khi ổn thì nạp tiền vào Ví API (xem hướng dẫn Ví API) và chuyển sang khóa thật.
Toàn bộ hướng dẫn cho khách hàng có tại Tài liệu hướng dẫn sPortal.
7. Câu hỏi thường gặp
Hướng dẫn và tài liệu API xem ở đâu? Hướng dẫn sử dụng (đăng ký API, Ví API, môi trường thử nghiệm) được đăng công khai tại Tài liệu hướng dẫn sPortal. Tài liệu kỹ thuật để lập trình (danh mục API, cách ký request, mã lỗi) được cung cấp sau khi đại lý duyệt hồ sơ, ngay trên trang Tích hợp API của cổng khách hàng, kèm bản PDF để gửi cho lập trình viên.
Có bắt buộc là doanh nghiệp mới dùng được API không? Không bắt buộc. Cá nhân hay doanh nghiệp đều gửi form đăng ký được; phần hóa đơn khi nạp ví tùy loại khách và tài khoản ngân hàng của đại lý.
Nếu ví hết tiền khi đến hạn tự động gia hạn thì sao? Hệ thống không trừ tiền và báo cho Quý khách hàng qua email và webhook để nạp thêm. Quý khách hàng có thể đặt ngưỡng cảnh báo để được báo trước khi ví cạn.
Dùng API có tốn thêm chi phí không? Quý khách hàng chỉ trả tiền dịch vụ mua qua Ví API theo giá đại lý áp cho nhóm khách của mình. Giá cụ thể tùy từng đại lý.
Sẵn sàng đưa dịch vụ cloud vào hệ thống của riêng mình? Liên hệ Sale hoặc chat với chúng tôi để được tư vấn.
Cần tư vấn thêm về CSPaaS?
Gọi hoặc chat với đội ngũ, chúng tôi phản hồi trong giờ hành chính.