Dành cho lập trình viên
Tài liệu Public API
Tích hợp Mailemdi với hệ thống của bạn: quản lý liên hệ, danh sách, chiến dịch, automation, gửi email giao dịch và đăng ký webhook.
Bắt đầu nhanh
- Base URL:
https://mailemdi.io.vn/api/v1 - Xác thực: gửi header
X-API-Key: <khóa của bạn>(tạo khóa trong Cài đặt → API keys). - Giới hạn: 120 request/phút mỗi khóa.
- Phạm vi: mọi dữ liệu tự động giới hạn theo workspace của khóa.
- Đặc tả máy-đọc: /api/v1/openapi (OpenAPI 3.1 — import vào Postman/Swagger).
curl https://mailemdi.io.vn/api/v1/contacts \ -H "X-API-Key: $MAILEMDI_API_KEY"
Liên hệ
- GET
/api/v1/contactsLiệt kê liên hệ - POST
/api/v1/contactsTạo liên hệ mới - POST
/api/v1/contacts/bulkTạo hàng loạt liên hệ (≤1000/lần) - GET
/api/v1/contacts/{id}Lấy 1 liên hệ - PATCH
/api/v1/contacts/{id}Cập nhật liên hệ - DELETE
/api/v1/contacts/{id}Xóa liên hệ
Chiến dịch
- GET
/api/v1/campaignsLiệt kê chiến dịch - GET
/api/v1/campaigns/{id}Lấy 1 chiến dịch (kèm số liệu mở/click/bounce) - POST
/api/v1/campaigns/{id}/sendKích hoạt gửi chiến dịch
Danh sách
- GET
/api/v1/listsLiệt kê danh sách - POST
/api/v1/listsTạo danh sách - GET
/api/v1/lists/{id}Lấy 1 danh sách - DELETE
/api/v1/lists/{id}Xóa danh sách - GET
/api/v1/lists/{id}/contactsLiệt kê thành viên trong danh sách - POST
/api/v1/lists/{id}/contactsThêm liên hệ vào danh sách - DELETE
/api/v1/lists/{id}/contactsXóa liên hệ khỏi danh sách
Phân khúc
- GET
/api/v1/segmentsLiệt kê phân khúc - GET
/api/v1/segments/{id}Lấy 1 phân khúc
Mẫu email
- GET
/api/v1/templatesLiệt kê mẫu email - POST
/api/v1/templatesTạo mẫu email - GET
/api/v1/templates/{id}Lấy 1 mẫu email (đầy đủ HTML) - PATCH
/api/v1/templates/{id}Cập nhật mẫu email - DELETE
/api/v1/templates/{id}Xóa mẫu email
Thẻ
- GET
/api/v1/tagsLiệt kê thẻ - POST
/api/v1/tagsTạo thẻ - GET
/api/v1/tags/{id}Lấy 1 thẻ - DELETE
/api/v1/tags/{id}Xóa thẻ
Automation
- GET
/api/v1/automationsLiệt kê automation - GET
/api/v1/automations/{id}Lấy 1 automation (kèm các bước) - POST
/api/v1/automations/{id}/enrollGhi danh liên hệ vào automation
Email giao dịch
- POST
/api/v1/transactionalGửi 1 email giao dịch - GET
/api/v1/transactional/logsLịch sử email giao dịch
Webhook
- GET
/api/v1/webhooksLiệt kê webhook - POST
/api/v1/webhooksĐăng ký webhook (secret chỉ trả 1 lần) - PATCH
/api/v1/webhooks/{id}Cập nhật webhook - DELETE
/api/v1/webhooks/{id}Xóa webhook
Suppression
- GET
/api/v1/suppressionsLiệt kê địa chỉ chặn gửi - POST
/api/v1/suppressionsThêm địa chỉ chặn gửi - DELETE
/api/v1/suppressions/{id}Bỏ địa chỉ chặn gửi
Thống kê
- GET
/api/v1/statsSố liệu tổng quan workspace
Sự kiện webhook
Đăng ký webhook qua POST /api/v1/webhooks. Payload được ký HMAC bằng secret (chỉ hiện 1 lần lúc tạo). Các sự kiện hỗ trợ:
contact.subscribedcontact.unsubscribedemail.sentemail.openedemail.clickedemail.bounced