Yardım › Tərtibatçılar üçün
Göndərmə API-si
Öz tətbiq və saytlarınızdan, öz ünvanlarınızdan, öz şablonlarınızla məktub göndərin.
Tətbiqləriniz, saytlarınız və skriptləriniz bir HTTPS sorğusu ilə təşkilatınızın ünvanlarından məktub göndərə bilər: sifariş təsdiqləri, parol sıfırlamaları, əlaqə formaları, hesabatlar. Bu məktublar SendHaste-də yazdığınız məktublar kimi göndərilir.
| Sorğu | Nə edir |
|---|---|
POST https://sendhaste.com/api/v1/emails | Bir məktub göndərir: öz məzmununuz və ya dəyərlərlə şablonlarınızdan biri. |
GET https://sendhaste.com/api/v1/templates | Şablonlara qoşulmuş məktubları və hər birinin istifadə etdiyi dəyərləri sadalayır. |
GET https://sendhaste.com/api/v1/senders | Açarın göndərə biləcəyi ünvanları sadalayır. |
GET https://sendhaste.com/api/v1/openapi.json | Bütün API Postman, kod generatorları və digər proqramçı alətləri üçün OpenAPI 3.1 faylı kimi. Açar lazım deyil. |
1. API açarı yarat
- Təşkilat super admini Parametrlər → API açarları bölməsini açır.
- API açarı yarat düyməsini basın, ona ad verin (məs., Saytdakı əlaqə forması) və Göndərmə ünvanı seçin: domenlərinizdəki istənilən ünvan, bir domendəki istənilən ünvan və ya yalnız bir ünvan. Açar yarat düyməsini klikləyin.
- Pəncərədə yeni açar, onun adı və göndərdiyi ünvanla birlikdə göstərilir. Kopyala, sonra Hazırdır düyməsini klikləyin. Açar
sh_ilə başlayır və yalnız bir dəfə göstərilir: itsə, onu ləğv edin və yenisini yaradın.
Bir domendən avtomatik e-poçtlar üçün (sifariş təsdiqləri, bildirişlər, hesabatlar) Parametrlər → Domenlər bölməsini açın, domeni seçin və yourdomain.com üçün API açarı yarat düyməsini klikləyin: açar həmin domendəki istənilən ünvandan göndərə bilər, başqa heç yerdən yox. Əvvəlcə göndərən ünvan üçün poçt qutusu əlavə edin, məsələn noreply@yourdomain.com. Yalnız göndərən məhdudlaşdırılır: e-poçtlar şirkətinizdə və ya ondan kənarda istənilən şəxsə gedə bilər.
Açarı serverinizdə, parametrdə və ya mühit dəyişənində saxlayın. Onu heç vaxt veb səhifəyə, mobil tətbiqə və ya açıq kod repozitoriyasına qoymayın: ona sahib olan hər kəs sizin adınızdan məktub göndərə bilər. Açar sızsa, Ləğv et düyməsini klikləyin: o dərhal işləməyi dayandırır.
2. Məktub göndərin
https://sendhaste.com/api/v1/emails ünvanına POST sorğusu göndərin; açar Authorization: Bearer sh_… başlığında, məktub isə JSON şəklində olsun:
curl https://sendhaste.com/api/v1/emails \
-H "Authorization: Bearer sh_your_key" \
-H "Content-Type: application/json" \
-d '{
"from": "Your Company <info@yourcompany.com>",
"to": ["client@example.com"],
"subject": "Your booking is confirmed",
"html": "<p>Thank you! See you on <b>Monday</b>.</p>",
"text": "Thank you! See you on Monday."
}'const res = await fetch("https://sendhaste.com/api/v1/emails", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.SENDHASTE_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({
from: "Your Company <info@yourcompany.com>",
to: "client@example.com",
subject: "Your booking is confirmed",
text: "Thank you! See you on Monday.",
}),
});
const result = await res.json(); // { id, from, to, recipients } or { error: { code, message } }3. Öz şablonlarınızı göndərin
Məktubu kodunuzda yazmaq əvəzinə onu Şablonlar bölməsində bir dəfə hazırlayın və saytınız onu adı ilə göndərsin: xoş gəldin məktubu, parolun sıfırlanması, sifariş təsdiqi. Məktubu sonra dəyişmək üçün şablonu redaktə edin və ya adı başqa şablona qoşun; saytda heç nə dəyişmir.
- Şablonlar bölməsində məktubu hazırlayın. Saytınızdan gələn dəyərin yerinə
{{params.first_name}}yazın; xətdən sonra, dəyər olmadıqda nə istifadə olunacağı:{{params.first_name|there}}. Mövzuda, mətndə, düymə və keçid ünvanlarında işləyir. - Org Super Admin Parametrlər → API açarları bölməsini açır, Saytlarınızın göndərdiyi məktublar altında Məktub qoş düyməsini basır, Məktub adı yazır (məs.
welcome), Şablon seçir, Göndərən altında domenlərinizdəki bütün ünvanları, bir domeni və ya bir ünvanı seçir və Qoş düyməsini basır. - Test göndər altında, necə göründüyünü görmək üçün onu bir neçə dəyərlə özünüzə göndərin.
- Saytınız adla birlikdə
template, dəyərlərlə birlikdəparamsgöndərir.subjectgöndərməsəniz, şablonun mövzusu istifadə olunur.
curl https://sendhaste.com/api/v1/emails \
-H "Authorization: Bearer sh_your_key" \
-H "Content-Type: application/json" \
-d '{
"from": "Your Shop <hello@yourshop.com>",
"to": "aysel@example.com",
"template": "welcome",
"params": { "first_name": "Aysel", "verify_url": "https://yourshop.com/verify?t=8f2c" }
}'- Hazır teqlər də işləyir:
{{first_name}},{{name}},{{company}},{{email}}.{{email}}ilk Kimə ünvanıdır; adlar göndərsənizparamsiçindən, əks halda şəxsin SendHaste-dəki kontaktından götürülür. - Dəyərlər mətn kimi qoyulur: dəyərdəki HTML yazıldığı kimi görünür, keçid dəyəri isə https://, http:// və ya mailto: ilə başlamalıdır.
- Ehtiyat dəyəri olmayan çatışmayan dəyər boş qalır, ona görə əvvəlcə Test göndər ilə yoxlayın.
Nümunə: yeni qeydiyyatlar üçün xoş gəldin məktubu
- Welcome adlı şablon yaradın: mövzusu
Welcome, {{params.first_name|there}}!, başlığıHi {{params.first_name|there}}və{{params.verify_url}}ünvanına aparan düymə. - Onu Parametrlər → API açarları bölməsində
welcomeadı ilə qoşun və ünvanınızdan göndərən açar yaradın. - Açarı saytınızın parametrlərində saxlayın (məsələn,
SENDHASTE_API_KEYmühit dəyişənində). - Saytınızın yeni istifadəçini saxladığı yerdə sorğunu göndərin. Dilinizi seçin:
await fetch("https://sendhaste.com/api/v1/emails", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.SENDHASTE_API_KEY}`, "Content-Type": "application/json" },
body: JSON.stringify({
from: "Your Shop <hello@yourshop.com>",
to: user.email,
template: "welcome",
params: { first_name: user.firstName, verify_url: verifyUrl },
}),
});$ch = curl_init("https://sendhaste.com/api/v1/emails");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("SENDHASTE_API_KEY"), "Content-Type: application/json"],
CURLOPT_POSTFIELDS => json_encode([
"from" => "Your Shop <hello@yourshop.com>",
"to" => $user["email"],
"template" => "welcome",
"params" => ["first_name" => $user["first_name"], "verify_url" => $verifyUrl],
]),
]);
$result = json_decode(curl_exec($ch), true);import os, requests
requests.post(
"https://sendhaste.com/api/v1/emails",
headers={"Authorization": f"Bearer {os.environ['SENDHASTE_API_KEY']}"},
json={
"from": "Your Shop <hello@yourshop.com>",
"to": user.email,
"template": "welcome",
"params": {"first_name": user.first_name, "verify_url": verify_url},
},
timeout=10,
)Məktubu istifadəçi saxlanandan sonra göndərin və uğursuz məktubun qeydiyyatı dayandırmasına imkan verməyin: xətanı qeyd edib davam edin. Cavabdakı id bizə yazsanız, məktubu tapmağa kömək edir.
Şablonlarınızın siyahısı
Eyni açarla GET https://sendhaste.com/api/v1/templates Parametrlər → API açarları bölməsində qoşulmuş məktubları və hər birinin istifadə etdiyi dəyərləri qaytarır:
{"data": [{"name": "welcome", "template_name": "Welcome", "subject": "Welcome, {{params.first_name|there}}!", "params": ["first_name", "verify_url"], "updated_at": "…", "scope": "domain", "for": "yourshop.com"}]}| Sahə | Nədir |
|---|---|
name | template kimi nə göndərilir. |
template_name | Şablonun SendHaste-dəki adı. |
subject | Şablonun mövzusu, teqləri hələ doldurulmayıb. |
params | Şablonun istifadə etdiyi {{params.…}} adları: bunları params içində göndərin. |
updated_at | Şablonun son dəyişdirildiyi vaxt. |
scope | Kim üçün qoşulub: organization (domenlərinizdəki bütün ünvanlar), domain və ya address. |
for | Qoşulduğu domen və ya ünvan; bütün təşkilat üçün null. |
Kodunuz bunu işə düşəndə və ya testdə çağıraraq göndərdiyi hər məktubun qoşulu olduğunu və bütün dəyərlərini aldığını yoxlaya bilər.
Hər məktub domenlərinizdəki bütün ünvanlar, bir domen və ya bir ünvan üçün qoşulur (Göndərən). Açar yalnız göndərə bildiyi ünvanlar üçün olan məktubları göstərir və göndərir, buna görə müxtəlif domenlərdəki saytların hər biri öz məktublarını görür. Eyni ad hər səviyyə üçün qoşula bilər: info@yourshop.com ünvanından göndərilən məktub həmin ünvanınkını, yoxdursa domeninkini, o da yoxdursa təşkilatınkını istifadə edir.
Ünvanlarınızı sadalayın
Eyni açarla GET https://sendhaste.com/api/v1/senders onun göndərə biləcəyi ünvanları qaytarır. Bundan istifadə edin ki, insanlar Kimdən ünvanını kodunuza yazmaq əvəzinə seçə bilsinlər.
{"data": [{"address": "info@yourcompany.com"}, {"address": "noreply@yourcompany.com"}], "domains": [{"domain": "yourcompany.com"}]}| Sahə | Nədir |
|---|---|
data | Açarın göndərə biləcəyi, poçt qutusu olan bütün ünvanlar: yaradıldığı tək ünvan, domenindəki bütün poçt qutuları və ya domenlərinizdəki bütün poçt qutuları. |
domains | Açarın göndərə biləcəyi domenlər. Tək ünvan üçün yaradılmış açarda boşdur. |
Hər Kimdən ünvanının SendHaste-də öz poçt qutusu olmalıdır. Poçt qutusuna Həmçinin qəbul edir altında əlavə edilmiş ünvan istifadə edilə bilməz, catchall@ da. noreply@yourdomain.com kimi yalnız göndərmək üçün ünvana Parametrlər → Domenlər bölməsində poçt qutusu əlavə edin; o, dərhal data siyahısında görünür.
Sahələr
| Sahə | Tələb olunur | Nədir |
|---|---|---|
from | bəli | Ünvanlarınızdan biri, istəsəniz adla: Your Company <info@yourcompany.com>. Onun SendHaste-də poçt qutusu olmalıdır. |
to | bəli | Bir ünvan və ya ünvanlar siyahısı. |
cc, bcc | xeyr | Bir ünvan və ya siyahı. Bcc alıcıları digərlərinə göstərilmir. |
reply_to | xeyr | Cavabların From ünvanına deyilsə, hara getdiyi. |
subject | bəli, template yoxdursa | Mövzu sətri. Şablonla birlikdə şablonun mövzusunu əvəz edir. |
text | text və ya html | Sadə mətn versiyası. |
html | text və ya html | HTML versiyası. İmkan olduqda hər ikisini göndərin; yalnız HTML olduqda mətn versiyası ondan yaradılır. |
attachments | xeyr | Fayllar siyahısı: filename, content, content_type. Məzmun base64 ilə kodlanır. |
template | xeyr | Parametrlər → API açarları bölməsində qoşulmuş məktubun adı, məs. welcome. text və html əvəzinə. |
params | xeyr | Şablonla: onun {{params.…}} teqləri üçün dəyərlər, məs. {"first_name": "Aysel"}. 100 dəyərə qədər. |
Cavab
Məktub göndəriləndə: status 200 və {"id": "…", "from": "info@yourcompany.com", "to": ["client@example.com"], "recipients": 1, "status": "sent"}. Şablonla birlikdə "template": "welcome" da.
Bu günün gündəlik limiti bitib, sabahınkında isə hələ yer varsa: status 202 və eyni sahələr, üstəlik "status": "queued", "deliverAfter": "2026-10-13T00:00:00Z". Məktub qəbul edilir və SendHaste onu saxlayır; deliverAfter vaxtında (növbəti UTC gecə yarısı), ya da ondan sonra poçt serveri qəbul edən kimi göndərilir. 202 cavabını uğur kimi qəbul edin və məktubu yenidən göndərməyin: təkrar cəhd onu iki dəfə çatdırardı.
Göndərilmədikdə: xəta statusu və {"error": {"code": "…", "message": "…"}}. code dəyişmir, ona görə kodunuz onu yoxlaya bilər; mesaj nəyi düzəltməli olduğunu deyir.
| Status | code | Nə etməli |
|---|---|---|
401 | missing_api_key, invalid_api_key | Authorization başlığını yoxlayın və ya yeni açar yaradın: bu açar ləğv edilib. |
403 | from_not_allowed | Domenlərinizdəki bir ünvandan (yalnız qəbul edən catchall@ istisna olmaqla) və ya açarın məhdudlaşdırıldığı domendən və ya yeganə ünvandan göndərin. |
403 | api_disabled | API vasitəsilə göndərmə təşkilatınız üçün açılmayıb: Dəstək səhifəsindən bizdən xahiş edin. |
400 | invalid_json | JSON obyekti göndərin. |
415 | unsupported_media_type | Content-Type: application/json başlığını təyin edin. |
422 | invalid_field, mailbox_not_found | Mesajda adı çəkilən sahəni düzəldin və ya əvvəlcə From poçt qutusunu yaradın. |
404 | template_not_found | Məktub adını Parametrlər → API açarları bölməsində From ünvanı, onun domeni və ya bütün təşkilat üçün şablona qoşun və ya yazılışını yoxlayın. |
413 | too_large | Daha kiçik qoşmalar göndərin. |
429 | rate_limited, daily_limit | Həddən çox sorğu: Retry-After başlığındakı saniyələr qədər gözləyin. Gündəlik limit: bu günün və sabahın məktubları artıq istifadə olunub və ya ünvan üçün poçt serverinin gündəlik limiti dolub; Retry-After başlığındakı saniyələr qədər (UTC ilə gecə yarısına qədər) gözləyin və sonra göndərin. |
502, 503 | send_failed, mailbox_not_ready | Göndərilmədi: bir neçə dəqiqədən sonra yenidən cəhd edin. Davam edərsə, bizə yazın. Poçt serverinin qəbul etdiyi məktuba, cavabı gecikdikdə belə, bu cavab heç vaxt verilmir. |
Limitlər
- Hər açar üçün dəqiqədə 60 sorğuya qədər.
- Hər məktubda 50 alıcıya qədər (to, cc və bcc birlikdə).
- Hər məktubda 20 qoşmaya və 25 MB-a qədər.
- Hər domen gündə 300 məktuba qədər göndərə bilər — istər SendHaste-dən, istər API ilə; onun hər poçt qutusu isə domenin limiti qədər insana məktub yaza bilər, Təşkilat super admini domenin səhifəsində Hər poçt qutusunun gündə yaza biləcəyi şəxs sayı təyin edibsə, daha az insana. Yeni qoşulmuş domen daha aşağı limitlə başlayır; onun Parametrlər → Domenlər bölməsindəki səhifəsi limitə qarşı Bu gün göndərilən məktublar sayını, Bu gün rədd edilən və Sabaha saxlanılan saylarını, limit artdıqca isə İsinmə dövrü işarəsini göstərir.
- Bu günün limitini aşan məktub itmir: SendHaste onu saxlayır və UTC ilə gecə yarısından sonra göndərir, sabahın limitindən sayılır (status
202). Poçt serveri o vaxt hələ öz limitindədirsə, server qəbul edən kimi göndərilir. Yalnız sabahın limiti də bitdikdə rədd edilir (daily_limit). - Belə gözləyən məktublar poçt qutusunun yan panelində Planlaşdırılmış bölməsində, Gündəlik göndərmə limiti ilə saxlanılanlar altında göstərilir; heç nə etmək lazım deyil, onlar özləri göndəriləcək.
SMTP-ni üstün tutursunuz? Bir çox tətbiq və freymvork bunun əvəzinə SMTP ilə poçt qutusu üzərindən göndərə bilər: server və port üçün Outlook, Apple Mail və telefon tətbiqləri səhifəsinə baxın. Eyni gündəlik limitlər tətbiq olunur.
Axtardığınızı tapmırsınız? Bizə mesaj göndərin.