از اینجا شروع کنید
شروع سریع
یک کلید بسازید، یک دامنه را تأیید کنید و با یک درخواست امن برای تلاش مجدد، یک ایمیل کنترل‌شده ارسال کنید.
پیش از شروع
یک فضای کاری SendHQ بسازید و داشبورد را باز نگه دارید. فضاهای کاری جدید یک دوره آزمایشی کنترل‌شده برای یکپارچه‌سازی دریافت می‌کنند: تا زمانی که اشتراک پولی فعال نشده باشد، ایمیل‌ها فقط به ایمیل حساب یا یک نشانی شبیه‌ساز AWS SES تحویل داده می‌شوند.
1. ساخت کلید API
در داشبورد بخش API keys را باز کنید، یک نام توصیفی مانند Production انتخاب کنید و کلید را هنگام نمایش کپی کنید. آن را در یک مدیر اسرار سمت سرور نگه دارید. SendHQ دیگر هرگز مقدار کامل آن را برنمی‌گرداند.
SENDHQ_API_KEY=re_your_key_here2. افزودن دامنه ارسال
بخش Domains را باز کنید، دامنه‌ای را که در اختیار دارید اضافه کنید و رکوردهای DKIM، SPF، DMARC و تأیید SES برگشتی را منتشر کنید. کاربران Cloudflare می‌توانند یک راه‌اندازی یک‌باره DNS را مجاز کنند؛ SendHQ پس از callback توکن OAuth را دور می‌ریزد.
include:amazonses.com را در مقدار موجود v=spf1 ادغام کنید.3. منتظر تأیید بمانید
از داشبورد یا POST /domains/:id/verify استفاده کنید. DNS ممکن است پیش از آنکه SES هویت را verified گزارش کند، از وضعیت‌های pending، checking و propagating عبور کند.
4. ارسال یک پیام کنترل‌شده
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 را دریافت کنید یا از داشبورد برای بررسی رویدادهای تحویل، برگشت ایمیل، گزارش اسپم، رد، باز شدن و کلیک استفاده کنید.