Загвараар илгээх
Имэйлийн загвар Maildy-д хадгалагдсан, харин нэр, захиалгын дугаар зэрэг өөрчлөгддөг хэсгийг таны апп бөглөх үед энэ хүсэлтийг ашиглана. Гарчиг, агуулгаа апп-аасаа бүтнээр нь илгээх бол Имэйл илгээх хүсэлтийг ашиглана уу.
POST https://app.maildy.mn/api/v2/sendWithTemplate
Эхлэхийн өмнө
Pro эсвэл Enterprise багц, баталгаажсан илгээх домэйн, илгээх эрхтэй API түлхүүр хэрэгтэй. Имэйл илгээх хуудасны «Эхлэхийн өмнө» хэсгийг үзнэ үү.
1-р алхам: Загвар хадгалах
- Мессеж хэсгийг нээж, ердийнхөөрөө имэйл үүсгэнэ.
- Таны апп-аас утга орох газар бүрт давхар хаалтад хувьсагч бичнэ. Жишээ нь
{{firstName}},{{orderId}}. Хувьсагчийг гарчиг болон агуулгын аль алинд ашиглаж болно.
Гарчиг: Таны {{orderId}} дугаартай захиалга баталгаажлаа
Агуулга: Сайн байна уу, {{firstName}}. Таны захиалга {{deliveryDate}}-нд хүргэгдэнэ.
2-р алхам: Загварын ID-г олох
Мессеж хэсэгт загварын мөрийн цэсийг нээгээд API-аар имэйл илгээх-ийг сонгоно. Нээгдэх самбарт загварын ID, загварт олдсон хувьсагчид, мөн хэд хэдэн хэл дээрх хуулахад бэлэн код харагдана.
3-р алхам: Хүсэлт илгээх
API түлхүүрээ X-Api-Key толгойд илгээнэ.
curl -X POST 'https://app.maildy.mn/api/v2/sendWithTemplate' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"messageId": 123,
"to": ["[email protected]"],
"from": "[email protected]",
"variables": {
"firstName": "Бат",
"orderId": "12345",
"deliveryDate": "10-р сарын 24"
}
}'
Хүсэлтийн талбарууд
| Талбар | Төрөл | Тайлбар | |
|---|---|---|---|
messageId | тоо | Заавал | 2-р алхамд олсон загварын ID. |
to | текстийн жагсаалт | Заавал | Хүлээн авагчийн хаягууд. Жагсаалтын хаяг бүр имэйлийг хүлээн авна. |
from | текст | Заавал биш | Илгээгчийн хаяг, жишээ нь [email protected]. Баталгаажсан домэйн дээрх хаяг байх ёстой. Орхивол эхний баталгаажсан домэйны noreply@ хаягаас илгээнэ. |
variables | объект | Заавал биш | Загварын хувьсагчийн утгууд. Түлхүүр нь хаалтгүй хувьсагчийн нэр, утга нь түүнийг орлох текст. |
attachments | объектын жагсаалт | Заавал биш | Имэйлд хавсаргах файлууд. Хавсралт хэсгийг үз. |
Хувьсагч хэрхэн бөглөгддөг вэ
- Нэр том, жижиг үсгийн хувьд яг таарах ёстой.
{{firstName}}-ийг"firstName"бөглөнө,"firstname"бөглөхгүй. - Утга илгээгээгүй хувьсагч имэйлд хаалттайгаа бичигдсэн хэвээр үлдэнэ. Хувьсагч бүрт утга илгээнэ үү.
- Утгыг таны илгээсэн хэлбэрээр нь оруулдаг тул утга доторх HTML хадгалагдана. Хэрэв утганд таны хэрэглэгчийн бичсэн текст орж байвал илгээхээсээ өмнө escape хийнэ үү.
Хавсралт
Нэхэмжлэх, хуулга зэрэг PDF болон бусад файл хавсаргах бол хүсэлтэд attachments нэмнэ. Жагсаалтын нэг мөр нь нэг файл:
{
"messageId": 123,
"to": ["[email protected]"],
"attachments": [
{
"filename": "huulga-2026-10.pdf",
"content": "JVBERi0xLjcKJeLjz9MK..."
}
]
}
| Талбар | Төрөл | Тайлбар | |
|---|---|---|---|
filename | текст | Заавал | Хүлээн авагчид харагдах файлын нэр, өргөтгөлтэйгөө. |
content | текст | Заавал | Файл өөрөө, base64 хэлбэрээр кодлогдсон. |
contentType | текст | Заавал биш | Файлын MIME төрөл, жишээ нь application/pdf. Орхивол файлын нэрийн өргөтгөлөөс тодорхойлно. |
Нэг имэйлд 10 хүртэл файл, нийт 8 MB хүртэл хавсаргаж болно (base64 болгохоос өмнөх хэмжээгээр). to талбарт хэд хэдэн хаяг байвал хүлээн авагч бүрт бүх файл очно.
Файлын нэр эсвэл агуулга байхгүй, base64 буруу, эсвэл хэмжээ хязгаараас хэтэрсэн бол хүсэлт 400 хариу буцаана. Аль файл буруу байгааг message хэлэх ба имэйл илгээгдэхгүй.
Хариу
Амжилттай илгээвэл хоосон биетэй 200 OK хариу ирнэ. Амжилттай хариуны биеийг JSON гэж уншиж болохгүй.
Хүсэлт амжилтгүй болбол хариуны бие нь JSON объект байх ба message талбар нь алдааг тайлбарлана.
| Төлөв | Хэзээ гардаг вэ |
|---|---|
| 400 | to хоосон, from хаяг баталгаажсан домэйн дээр биш, эсвэл хавсралт буруу. |
| 401 | X-Api-Key толгой байхгүй, эсвэл түлхүүр буруу, идэвхгүй болсон. |
| 403 | Түлхүүрт илгээх эрх байхгүй, эсвэл бүртгэл түдгэлзсэн. Илгээх хандалт эсвэл Бүрэн хандалт бүхий түлхүүр ашиглана уу. |
| 404 | Таны бүртгэлд энэ messageId-тай загвар байхгүй. |
| 429 | Таны бүртгэлийн имэйлийн эрх дууссан. |
| 500 | Бүртгэл API-аар илгээх боломжгүй байна: багцад ороогүй, эсвэл баталгаажсан домэйн байхгүй. Аль нь болохыг message хэлнэ. |
Хязгаар нь загваргүй илгээхтэй адил.
Кодын жишээ
JavaScript
const response = await fetch('https://app.maildy.mn/api/v2/sendWithTemplate', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
messageId: 123,
to: ['[email protected]'],
variables: { firstName: 'Бат', orderId: '12345' }
})
})
if (!response.ok) {
const error = await response.json()
console.error(response.status, error.message)
}
Python
import requests
response = requests.post(
'https://app.maildy.mn/api/v2/sendWithTemplate',
headers={'X-Api-Key': 'YOUR_API_KEY'},
json={
'messageId': 123,
'to': ['[email protected]'],
'variables': {'firstName': 'Бат', 'orderId': '12345'},
},
)
if response.status_code != 200:
print(response.status_code, response.json().get('message'))
$1{}