Knowledge Base

Tổng quan

Cập nhật: 4 Tháng 1, 2026

01. Tổng quan (Introduction)

Chào mừng đến với hệ thống API của AMX. Tài liệu này cung cấp các thông tin cơ bản để bạn có thể bắt đầu tích hợp.

Hệ thống hỗ trợ giao thức HTTPS để đảm bảo bảo mật.

Base URL: https://<tenant>.amx.vn/api/v1 (hoặc tên miền riêng của đối tác + /api/v1)
Protocol: HTTPS
Data Format: JSON (application/json)

Ví dụ: https://store.amx.vn/api/v1/products

Chúng tôi sử dụng cơ chế xác thực qua API Key cho việc hiển thị nội dung lên Website hoặc Mobile App.

  AMX-API-KEY: <your_api_key_here>

Lấy API Key: Vui lòng liên hệ quản trị viên hệ thống để được cấp key cho Tenant của bạn.

Tất cả các API endpoint v1 đều trả về dữ liệu theo cấu trúc chuẩn sau:

HTTP Status Code: 200

{
  "success": true,
  "data": { ... },    // Object hoặc Array dữ liệu chính
  "message": "Thao tác thành công" // Optional
}

HTTP Status Code: 4xx hoặc 5xx

{
   "success": false,
   "message": "Mô tả chi tiết lỗi",
   "error": "STACK_TRACE_OR_CODE" // Chỉ hiện trong môi trường develop/debug
}

Hệ thống sử dụng các mã HTTP Status Code tiêu chuẩn:

| Code | Ý nghĩa | Mô tả |

| :--- | :--- | :--- |

| 200 | OK | Request thành công. |

| 201 | Created | Tài nguyên mới đã được tạo thành công. |

| 400 | Bad Request | Dữ liệu gửi lên không hợp lệ (thiếu field, sai format). |

| 401 | Unauthorized | Sai API Key hoặc Token hết hạn/không hợp lệ. |

| 403 | Forbidden | Bạn không có quyền truy cập tài nguyên này. |

| 404 | Not Found | Endpoint hoặc Resource không tồn tại. |

| 405 | Method Not Allowed | Sai method (VD: dùng GET cho endpoint POST). |

| 429 | Too Many Requests | Gửi quá nhiều request trong thời gian ngắn. |

| 500 | Server Error | Lỗi nội bộ hệ thống. |

Để đảm bảo hiệu năng, hệ thống có giới hạn số lượng request từ một IP trong một khoảng thời gian nhất định.

Nếu vượt quá giới hạn, bạn sẽ nhận được mã lỗi 429.