ابدأ من هنا

البدء السريع

أنشئ مفتاحًا، ووثّق نطاقًا، وأرسل رسالة تجريبية مضبوطة بطلب آمن لإعادة المحاولة.

قبل أن تبدأ

أنشئ مساحة عمل في SendHQ وأبقِ لوحة التحكم مفتوحة. تحصل مساحات العمل الجديدة على فترة تجريبية مضبوطة للتكامل: يمكن أن تصل الرسائل فقط إلى البريد الإلكتروني للحساب أو إلى عنوان محاكاة في AWS SES إلى أن يصبح الاشتراك المدفوع نشطًا.

1. أنشئ مفتاح API

افتح API keys في لوحة التحكم، واختر اسمًا وصفيًا مثل Production، وانسخ المفتاح عند عرضه. خزّنه في مدير أسرار على الخادم. لا تعرض SendHQ القيمة الكاملة مرة أخرى أبدًا.

.env

SENDHQ_API_KEY=re_your_key_here

2. أضف نطاق إرسال

افتح Domains، وأضف نطاقًا تتحكم فيه، وانشر سجلات DKIM وSPF وDMARC والتحقق من SES المُعادة. يمكن لمستخدمي Cloudflare تفويض إعداد DNS لمرة واحدة؛ وتتخلص SendHQ من رمز OAuth بعد رد الاستدعاء (callback).

لا تنشر سياسة SPF ثانية.إذا كان SPF موجودًا بالفعل، فادمج include:amazonses.com في قيمة v=spf1 الحالية.

3. انتظر التوثيق

استخدم لوحة التحكم أو POST /domains/:id/verify. قد تنتقل حالة DNS بين pending وchecking وpropagating قبل أن تُبلغ SES بأن الهوية verified.

4. أرسل رسالة تجريبية مضبوطة

curl

curl https://sendhq.cc/api/v1/emails \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: onboarding-user-42" \
  -d '{"from":"Acme <hello@example.com>","to":["owner@example.com"],"subject":"SendHQ is connected","html":"<h1>It works</h1><p>Your first controlled message was accepted.</p>","text":"It works. Your first controlled message was accepted."}'

يُعيد الطلب الناجح معرّف رسالة SendHQ، ومعرّف الرسالة لدى المزوّد، ومعرّف سلسلة المحادثة. احفظ معرّف SendHQ مع حدث التطبيق الذي تسبب في إرسال الرسالة.

5. تعامل مع النتائج

قبول طلب API ليس مثل تسليم الرسالة إلى المستلِم. استرجع /emails/:id/events أو استخدم لوحة التحكم لفحص أحداث التسليم والارتداد والشكوى والرفض والفتح والنقر.