Appearance
Tổng quan tài liệu API dành cho customer
Tài liệu API dành cho customer liệt kê các thao tác tích hợp được công khai cho tài khoản, cùng tham số, kết quả và ví dụ yêu cầu.
Mở tài liệu API
Mở Cài đặt tài khoản → API, sau đó chọn Xem tài liệu API đầy đủ.
Trang hiển thị URL gốc của chính hệ thống Mailix bạn đang sử dụng. Không sao chép URL từ một cài đặt Mailix khác.
Xác thực
Mỗi yêu cầu cần API token của người dùng. Cách khuyến nghị là header:
text
Authorization: Bearer YOUR_API_TOKENPhản hồi được trình bày ở định dạng JSON. Mã trạng thái phụ thuộc thao tác và kết quả; hãy kiểm tra cả mã HTTP lẫn nội dung phản hồi thay vì giả định mọi thành công đều có cùng một mã.
Các nhóm tài nguyên
Tài liệu customer hiện có các nhóm chính:
- xác thực;
- danh sách;
- chiến dịch;
- người đăng ký;
- thông báo API;
- phản hồi thông báo;
- tệp.
Chỉ dùng thao tác xuất hiện trong tài liệu customer. Tài liệu quản trị và các địa chỉ nội bộ không thuộc phạm vi token customer.
Đọc một thao tác
Mỗi mục có thể hiển thị:
- phương thức và đường dẫn;
- mô tả;
- tham số bắt buộc hoặc tùy chọn;
- giá trị mặc định;
- dạng kết quả;
- ví dụ lệnh.
Phân trang và giới hạn tốc độ
Một số danh sách nhận tham số page và per_page; hãy đọc đúng mục tương ứng. Giao diện thông báo API có giới hạn tốc độ và có thể trả về mã 429 khi vượt giới hạn, nhưng không công bố một con số chung. Giới hạn thực tế có thể phụ thuộc gói hoặc cấu hình.
An toàn khi tích hợp
- Chỉ cấp token của người dùng có quyền cần thiết.
- Không đặt token trong mã công khai hoặc ứng dụng chạy hoàn toàn trên trình duyệt.
- Bắt đầu bằng thao tác đọc trước khi dùng thao tác tạo, sửa hoặc xóa.
- Tạo lại token ngay nếu nghi ngờ bị lộ.
Khi yêu cầu không thành công
Kiểm tra URL gốc, header xác thực, phương thức, tham số bắt buộc và quyền của người dùng. Không hiển thị nguyên phản hồi có dữ liệu nhạy cảm cho người dùng cuối.