Tài liệu API
Sử dụng API để tích hợp với hệ thống một cách dễ dàng
Thông tin chung
- Địa chỉ gốc (Endpoint):
https://dichvudev.fun/api.php - Phương thức hỗ trợ: GET và POST (tất cả hành động đều hỗ trợ cả hai)
- Định dạng dữ liệu: JSON (UTF-8)
- Mã hóa: UTF-8
Xác thực
Tất cả yêu cầu đều cần token để xác thực người dùng. Token được cấp trong trang Hồ sơ cá nhân (tab API Token).
Gửi token qua tham số api_token trong URL hoặc dữ liệu POST:
Định dạng phản hồi
Mọi phản hồi đều có cấu trúc JSON chung:
Danh sách hành động
1. Lấy danh sách sản phẩm
Mô tả: Lấy danh sách sản phẩm đang bán, có phân trang và lọc theo danh mục.
Tham số
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| category_id | integer | Không | Lọc theo ID danh mục (nếu không có thì lấy tất cả) |
| page | integer | Không | Số trang hiện tại (mặc định: 1) |
| limit | integer | Không | Số sản phẩm mỗi trang, tối đa 50 (mặc định: 10) |
Ví dụ request
Ví dụ response (thành công)
2. Lấy chi tiết sản phẩm
Mô tả: Lấy thông tin chi tiết của một sản phẩm cụ thể.
Tham số
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| product_id | integer | Có | ID của sản phẩm cần xem |
Ví dụ request
Ví dụ response (thành công)
Ví dụ response (không tìm thấy)
3. Kiểm tra đơn hàng
Mô tả: Lấy thông tin chi tiết của một đơn hàng mà bạn đã mua.
Tham số
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| order_id | integer | Có | ID của đơn hàng cần kiểm tra |
Ví dụ request
Ví dụ response (thành công)
account_info (thông tin tài khoản) bị ẩn đi để bảo mật. Nếu bạn muốn xem, hãy đăng nhập và xem trong lịch sử đơn hàng.
4. Mua hàng
Mô tả: Thực hiện mua một sản phẩm. Hành động này sẽ trừ tiền từ số dư của bạn và trả về thông tin tài khoản (nếu sản phẩm được xử lý tự động).
Tham số
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| product_id | integer | Có | ID của sản phẩm cần mua |
| quantity | integer | Không | Số lượng tài khoản cần mua (mặc định: 1) |
| payment_type | string | Có | "xu" hoặc "vnd" |
Ví dụ request (dạng JSON – khuyến nghị)
Ví dụ request (dạng form-data hoặc query string)
Ví dụ response (thành công – sản phẩm tự động)
Ví dụ response (thành công – sản phẩm cần xử lý thủ công)
Ví dụ response (lỗi – không đủ số dư)
Ví dụ response (lỗi – hết hàng)
5. Lấy số dư tài khoản
Mô tả: Lấy số dư hiện tại của tài khoản (cả VNĐ và Xu).
Tham số
Không có tham số bắt buộc ngoài api_token.
Ví dụ request
Ví dụ response (thành công)
Mã lỗi HTTP
| Mã | Ý nghĩa |
|---|---|
| 200 | Thành công |
| 400 | Dữ liệu đầu vào không hợp lệ (thiếu tham số, sai kiểu dữ liệu) |
| 401 | Token không hợp lệ hoặc đã hết hạn |
| 404 | Không tìm thấy tài nguyên (sản phẩm, đơn hàng) |
| 429 | Quá nhiều yêu cầu (vượt giới hạn rate limit) |
| 500 | Lỗi máy chủ nội bộ |
Giới hạn tốc độ (Rate Limit)
Mỗi token được phép gọi tối đa 30 yêu cầu mỗi phút. Nếu vượt quá, API sẽ trả về mã lỗi 429 với thông báo:
Lưu ý bảo mật
- Luôn sử dụng HTTPS trong môi trường sản xuất để bảo vệ token và dữ liệu.
- Không chia sẻ token với bất kỳ ai.
- Token được mã hóa bằng bcrypt trong cơ sở dữ liệu, không thể giải mã ngược.
- Hạn chế gửi token qua URL nếu không cần thiết, ưu tiên gửi qua Header hoặc dữ liệu POST.
- Thường xuyên kiểm tra và xóa các token không sử dụng trong trang hồ sơ.
Hỗ trợ
Nếu bạn gặp vấn đề khi sử dụng API, vui lòng liên hệ bộ phận hỗ trợ qua:
- Email: support@dichvudev.fun
- Hoặc đặt câu hỏi trong nhóm hỗ trợ của hệ thống.
Chúng tôi sẽ phản hồi trong thời gian sớm nhất.