Trang Quản lý API là nơi bạn theo dõi những khách hàng đã được xử lý hồ sơ tích hợp API: đang hoạt động, bị từ chối, tạm khóa hoặc đã thu hồi. Tại đây bạn lấy địa chỉ API và tài liệu API (PDF) để gửi cho khách, xem chi tiết từng khách, chọn loại dịch vụ khách được bán lại qua API, và tạm khóa, thu hồi hoặc mở lại quyền gọi API khi cần.
Nhóm menu Tích hợp API chỉ hiện khi Công ty đã bật chức năng này cho đại lý của bạn. Nếu bạn gõ thẳng đường dẫn khi chức năng chưa bật, trang sẽ báo "Chức năng Tích hợp API chưa được bật".
1. Tổng quan màn hình
Màn hình gồm 3 phần chính:
- Dòng địa chỉ API: Địa chỉ API của khách hàng bạn - địa chỉ mang tên miền riêng của bạn mà khách dùng để gọi API, kèm nút Tải tài liệu API (PDF).
- Thanh công cụ: chọn số dòng mỗi trang, ô tìm kiếm và 4 nút lọc trạng thái: Đã duyệt, Từ chối, Tạm khóa, Thu hồi.
- Bảng danh sách: mỗi dòng là một khách hàng tích hợp API.
Ý nghĩa các cột trong bảng
| Cột | Ý nghĩa |
|---|---|
| Khách hàng | Tên và email của khách. Bấm vào tên để mở trang chi tiết khách hàng. |
| Thương hiệu / Trang bán hàng | Tên thương hiệu và website mà khách dùng để bán lại dịch vụ của bạn. |
| Ngày gửi | Ngày khách gửi hồ sơ đăng ký API (hoặc ngày bạn kích hoạt cho khách). |
| Trạng thái | Tình trạng quyền gọi API của khách (xem bên dưới). |
| Thao tác | Nút Chỉnh sửa API mở cửa sổ chi tiết; nút mở danh sách thao tác đổi trạng thái. |
Các trạng thái
- Đã duyệt - khách đang gọi API bình thường.
- Bị từ chối - bạn đã từ chối hồ sơ đăng ký của khách. Bạn vẫn có thể Duyệt lại.
- Tạm khóa - khách tạm thời không gọi được API; ví và API key vẫn giữ nguyên.
- Đã thu hồi - khách mất quyền tích hợp API, toàn bộ API key đã bị hủy.
Mẹo: hồ sơ đang chờ duyệt không nằm ở trang này mà ở trang Hồ sơ đăng ký. Số trên menu Hồ sơ đăng ký cho biết còn bao nhiêu hồ sơ cần bạn xử lý.
2. Lấy địa chỉ API và tải tài liệu API cho khách
Khách tích hợp API cần 2 thứ để bắt đầu: địa chỉ API của bạn và tài liệu hướng dẫn gọi API. Cả hai đều có ở đầu trang.
- 1Xem ô Địa chỉ API của khách hàng bạn. Đây là địa chỉ khách sẽ gọi tới, mang tên miền riêng của bạn.
- 2Bấm Tải tài liệu API (PDF). Hệ thống tạo file trong vài giây (nút đổi thành Đang tạo PDF…) rồi tự tải về máy.
- 3Gửi file PDF cho khách. Tài liệu này giống bản khách tự tải trong trang Tích hợp API của khách, và các địa chỉ trong tài liệu đã được điền sẵn theo tên miền API của bạn.
Chưa có tên miền API? Nếu đầu trang hiện khung vàng "Chưa có tên miền API riêng cho đại lý", khách của bạn chưa thấy địa chỉ để gọi API. Hãy trỏ tên miền (ví dụ api.ten-mien-cua-ban) về máy chủ API rồi liên hệ Công ty để được cấu hình.
Khách có thể dùng key thử nghiệm để chạy thử trước khi bán thật - các lần gọi này không phát sinh tiền hay dịch vụ thật. Bạn xem được các lần gọi thử ở trang Nhật ký gọi API (chọn bộ lọc Key thử nghiệm).
3. Xem chi tiết và chọn loại dịch vụ khách được bán
Bấm nút (Chỉnh sửa API) ở dòng của khách để mở cửa sổ Chi tiết đăng ký API.
| Phần | Nội dung |
|---|---|
| Thông tin đăng ký | Trang bán hàng, mục đích sử dụng, người liên hệ kỹ thuật, nguồn tạo (Khách tự đăng ký hoặc Đại lý chủ động kích hoạt) và ngày gửi. |
| IP được phép gọi API | Danh sách địa chỉ IP máy chủ của khách. Chỉ các IP này mới gọi được API. Khách tự sửa danh sách ở trang Tích hợp API của khách. |
| Ví API | Số dư khách đang có để mua hàng qua API. Khi số dư lớn hơn 0 sẽ có nút Trừ số dư - bắt buộc nhập số tiền và lý do trừ. |
| Loại dịch vụ được phép bán | Các loại dịch vụ khách được mua qua API. Tích / bỏ tích rồi bấm Lưu (nút chỉ sáng lên khi có thay đổi). Phải chọn ít nhất 1 loại. |
| API Key | Các key khách đã tạo: tên, mã key, 4 ký tự cuối của secret, trạng thái, ngày tạo. Bạn chỉ xem được - khách tự tạo và thu hồi key ở trang Tích hợp API của khách. |
| Lịch sử trạng thái | Mọi lần đổi trạng thái: từ trạng thái nào sang trạng thái nào, lý do, thời gian và người thực hiện. |
Ở cuối cửa sổ, nút Nhật ký gọi API mở trang nhật ký đã lọc sẵn theo khách này.
Lưu ý: danh sách loại dịch vụ chỉ gồm những loại Công ty đã cấp cho đại lý của bạn. Khách đã bị thu hồi thì không chỉnh được loại dịch vụ.
4. Tạm khóa, thu hồi hoặc mở lại quyền gọi API
Bấm nút ở cột Thao tác. Các lựa chọn thay đổi theo trạng thái hiện tại của khách:
| Trạng thái hiện tại | Thao tác có thể chọn | Kết quả |
|---|---|---|
| Đã duyệt | Tạm khóa, Thu hồi | Tạm khóa: khách tạm thời không gọi được API, ví và key giữ nguyên. Thu hồi: xem hộp đỏ bên dưới. |
| Tạm khóa | Mở lại, Thu hồi | Mở lại: khách gọi API trở lại được ngay bằng các key cũ. |
| Đã thu hồi | Mở lại | Khách có lại quyền tích hợp API nhưng phải tạo key mới (key cũ đã bị hủy). |
| Bị từ chối | Duyệt lại | Mở cửa sổ duyệt như hồ sơ mới (xem bài Hồ sơ đăng ký). |
Các bước thực hiện:
- 1Chọn nút lọc trạng thái phù hợp (ví dụ Tạm khóa) để tìm khách, rồi bấm ở dòng của khách.
- 2Chọn Tạm khóa, Thu hồi hoặc Mở lại. Đọc kỹ khung cảnh báo trong cửa sổ hiện ra.
- 3Nhập Lý do - bắt buộc khi tạm khóa hoặc thu hồi, không bắt buộc khi mở lại. Lý do được gửi cho khách qua email / thông báo.
- 4Bấm nút xác nhận, ví dụ Xác nhận Thu hồi.
Thu hồi hủy vĩnh viễn toàn bộ API key của khách. Khách mất quyền tích hợp API và không tự gửi lại đăng ký được; số dư Ví API vẫn giữ nguyên. Chỉ bạn mới mở lại được, và khi mở lại khách phải tạo key mới. Nếu chỉ muốn chặn tạm thời, hãy dùng Tạm khóa.
5. Câu hỏi thường gặp
Khách báo bị lộ API key, tôi có thu hồi key giúp khách được không?
Bạn không thu hồi từng key được - việc này khách tự làm ở trang Tích hợp API của khách. Nếu cần chặn gấp, bạn có thể Tạm khóa khách để dừng mọi lần gọi API, chờ khách thu hồi key bị lộ rồi Mở lại.
Khách muốn bán thêm VPS nước ngoài hoặc VPS GPU qua API?
Mở chi tiết khách bằng nút , tích thêm loại dịch vụ ở phần Loại dịch vụ được phép bán rồi bấm Lưu. Loại nào không có trong danh sách nghĩa là đại lý của bạn chưa được Công ty cấp loại đó.
Tạm khóa thì số dư Ví API của khách có mất không?
Không. Cả tạm khóa và thu hồi đều giữ nguyên số dư Ví API. Tạm khóa giữ luôn API key, mở lại là khách dùng tiếp được ngay.
Khách hỏi lấy tài liệu API ở đâu?
Bấm Tải tài liệu API (PDF) ở đầu trang rồi gửi file cho khách. Khách đã được duyệt cũng tự tải được tài liệu này trong trang Tích hợp API của khách.