Kính gửi quý khách hàng,
Với API của Zetamail, Hiện tại việc tích hợp gửi chiến dịch email hay gửi email giao dịch và thông báo từ các CRM hay nền tảng website bán hàng, website riêng hoặc 1 nền tảng có hỗ trợ giao thức API REST đã trở nên dễ dàng hơn.
Tài liệu này dành cho bộ phận kỹ thuật.
Để sử dụng API bạn cần đăng nhập vào tài khoản của bạn trên Zetamail để lấy xml_token / token và tham khảo các chức năng trên phần mềm, xem thêm về video mô tả các chức năng zetamail
Tải xuống Mẫu thư viện kết nối API: Ngôn ngữ PHP ( tải file đính kèm bên dưới ).
1 Số tham biến cần lưu ý:
- xml_token hoặc token: Giá trị này là Key thay thế cho mật khẩu truy cập, lấy từ trang Quản lý tài khoản https://app.zetamail.vn/admin/index.php?Page=ManageAccount
- ID: là định danh duy nhất bằng chữ số của các trường thông tin chính mà bạn muốn lấy dữ liệu hoặc chỉnh sửa, cập nhật.
- attachments[] / files[] : Định dạng upload file hỗ trợ upload nhiều file, mục đích upload file đính kèm khi gửi email ( chi tiết định dạng tham khảo HTML INPUT Kiểu File ).
Dữ liệu trả về:
Để biết dữ liệu trả về dạng HTTP Code có các mã lỗi dưới đây:
| Mã Lỗi | Mô tả |
| 200 | Gửi lên Thành công |
| 403 | Có lỗi khi xử lý thông tin gửi lên |
| 404 | Không tìm thấy / thiếu 1 số trường tham biến |
| > 500 | Có lỗi hệ thống của Zetamail |
Định dạng trả về là Json
Dưới đây là thông tin chi tiết về API theo từng chức năng:
Bạn nên cài đặt PostMan để hỗ trợ kiểm thử các tính năng này
| Mô tả về API | Đường dẫn | Ghi chú |
Quản lý các chiến dịch email marketing trên Zetamail | https://documenter.getpostman.com/view/766995/SVYurH67?version=latest | Hỗ trợ hiển thị, tạo, sửa, xoá các chiến dịch email marketing, Chi tiết về chức năng, Chi tiết kiểm tra: Menu -> Quản lý chiến dịch |
| Lấy thống kê các chiến dịch đã gửi, trả lời tự động, Thao tác tự động trên tài khoản zetamail: | https://documenter.getpostman.com/view/766995/S1TZyFyF?version=latest | Các thống kê này sẽ trả về thông tin các email mở mail, nhấp link trong danh sách, thông tin báo trả lại và các thống kê khác. |
Lấy thông tin danh sách liên hệ của Danh sách, thêm liên hệ, tạo danh sách. | https://documenter.getpostman.com/view/766995/S1EWPaWZ?version=latest | Chi tiết tính năng xem trên Menu -> Quản lý danh sách |
| Gửi email riêng lẻ hoặc gửi đến nhiều email trong một danh sách ( send campaign ) | https://documenter.getpostman.com/view/766995/SVYurH68?version=latest | Cung cấp khả năng gửi email riêng lẻ đến từng email và gửi đến nhiều email khách hàng trong danh sách. ( có hỗ trợ file đính kèm ) |
Lấy các thao tác tự động, dùng với mục đích gửi email theo sự kiện ( Giao dịch và thông báo ) | https://documenter.getpostman.com/view/766995/RWEfMePd | Chi tiết tính năng xem tại Menu -> Tiện ích -> Thao tác tự động *Lưu ý: với chức năng này, bạn cần tạo sự kiện trên phần mềm zetamail trước khi tiến hành gửi thư |
Mọi thông tin chi tiết vui lòng liên hệ nhóm hỗ trợ Zetamail để gặp bộ phận kỹ thuật để được hướng dẫn và giải đáp.
Trân trọng cảm ơn.