Trang Nhật ký gọi API ghi lại từng lần khách hàng tích hợp API gửi yêu cầu tới hệ thống: khách làm gì, thành công hay lỗi, có tạo ra đơn hàng nào không, gọi từ IP nào và bằng API key nào. Đây là nơi đầu tiên bạn nên xem khi khách báo "gọi API không được".
1. Tổng quan màn hình
Mỗi dòng là một lần gọi API, lần mới nhất ở trên cùng. Trang chỉ để xem - không có thao tác nào làm thay đổi dữ liệu.
Ý nghĩa các cột trong bảng
| Cột | Ý nghĩa |
|---|---|
| Thời gian | Thời điểm khách gọi, chính xác tới giây. |
| Khách hàng | Tên và email khách. Bấm tên để mở trang chi tiết khách; bấm Chỉ xem khách này để lọc nhật ký của riêng khách đó. |
| Yêu cầu | Việc khách làm, ví dụ Xem danh sách sản phẩm, Tạo đơn hàng, Tạo đơn nạp ví, Gia hạn dịch vụ. Dòng nhỏ bên dưới là đường dẫn kỹ thuật, dùng khi trao đổi với bộ phận kỹ thuật của khách. Nhãn THỬ NGHIỆM nghĩa là khách gọi bằng key thử nghiệm. |
| Kết quả | Nhãn xanh 200 là thành công. Nhãn đỏ 403 là lỗi, kèm mã lỗi và giải thích ngắn bằng tiếng Việt. |
| Đơn hàng | Mã đơn hàng liên quan (nếu có). Bấm để mở đơn. |
| IP / API key | Địa chỉ IP gửi yêu cầu và tên API key khách đã dùng. |
| Xử lý | Thời gian hệ thống xử lý yêu cầu, tính bằng mili giây (ms). |
Nhật ký không lưu nội dung dữ liệu khách gửi, secret hay chữ ký - bạn yên tâm cho nhân viên hỗ trợ xem trang này.
2. Lọc và tìm lỗi
- Ô tìm kiếm: gõ tên khách, IP, mã lỗi hoặc mã đơn rồi bấm tìm.
- Loại key: Key thật (mặc định), Key thử nghiệm hoặc Tất cả key.
- Kết quả: nút Tất cả, Thành công, Lỗi.
- Nút : tải lại để xem các lần gọi mới nhất.
- Số dòng mỗi trang: 30, 50, 100, 200 hoặc 500.
Một số lỗi hay gặp và cách xử lý
| Mã lỗi (giải thích trên màn hình) | Nên làm gì |
|---|---|
| IP_NOT_ALLOWED IP không nằm trong danh sách IP | So IP ở cột IP / API key với danh sách IP của khách. Khách tự thêm IP ở trang Tích hợp API của khách. |
| API_SUSPENDED / API_REVOKED Quyền API đang bị tạm khóa / đã bị thu hồi | Khách đang bị tạm khóa hoặc thu hồi ở trang Quản lý API. Mở lại nếu phù hợp. |
| INSUFFICIENT_BALANCE Số dư Ví API không đủ | Nhắc khách nạp thêm Ví API. Theo dõi đơn nạp ở trang Nạp ví API. |
| SERVICE_TYPE_NOT_ALLOWED Loại dịch vụ không được bán qua API | Khách mua loại dịch vụ chưa được cho phép. Tích thêm loại đó trong chi tiết khách ở trang Quản lý API nếu bạn đồng ý. |
| WRONG_API_DOMAIN Gọi sai tên miền API | Khách đang gọi sai địa chỉ. Gửi lại khách địa chỉ API và tài liệu API (PDF) ở trang Quản lý API. |
| INVALID_SIGNATURE, INVALID_API_KEY, TIMESTAMP_EXPIRED, VALIDATION_ERROR | Lỗi trong cách khách viết chương trình (sai key, sai chữ ký, lệch giờ máy chủ, dữ liệu gửi lên sai). Chụp dòng nhật ký gửi bộ phận kỹ thuật của khách kèm tài liệu API. |
3. Xem các lần gọi thử nghiệm
Trước khi bán thật, khách thường dùng key thử nghiệm để chạy thử. Các lần gọi này không phát sinh tiền hay dịch vụ thật, nên mặc định bị ẩn để không làm rối nhật ký.
- 1Ở ô chọn loại key, đổi Key thật thành Key thử nghiệm (hoặc Tất cả key để xem cả hai).
- 2Các dòng gọi thử có nhãn THỬ NGHIỆM ở cột Yêu cầu.
Mẹo: khách báo "chạy thử thì được, chạy thật thì lỗi"? Chọn Tất cả key và Chỉ xem khách này để so sánh hai loại gọi cạnh nhau.
4. Xem nhật ký của riêng một khách
Có 2 cách:
- Trên trang này, bấm Chỉ xem khách này dưới tên khách ở bất kỳ dòng nào.
- Ở trang Quản lý API, mở chi tiết khách rồi bấm nút Nhật ký gọi API ở cuối cửa sổ.
Khi đang lọc, phía trên bảng hiện dòng "Đang xem nhật ký của khách …". Bấm Xem tất cả khách để bỏ lọc.
5. Câu hỏi thường gặp
Khách báo gọi API không được nhưng nhật ký không có dòng nào?
Kiểm tra ô loại key - có thể khách đang gọi bằng key thử nghiệm, hãy chọn Tất cả key. Nếu vẫn trống, có thể yêu cầu của khách chưa tới được hệ thống; nhắc khách kiểm tra lại địa chỉ API trong tài liệu API (PDF).
Khách tạo đơn qua API, làm sao xem đơn đó?
Ở dòng Tạo đơn hàng thành công, bấm mã đơn ở cột Đơn hàng để mở trang chi tiết đơn.
Gọi bằng key thử nghiệm có trừ tiền Ví API của khách không?
Không. Các lần gọi có nhãn THỬ NGHIỆM không phát sinh tiền hay dịch vụ thật.