مرجع API
حساب و صورتحساب
میزان مصرف حساب، analytics و metadata کلیدها را با کلید API بخوانید؛ تغییرات صورتحساب و ایجاد یا ابطال کلید به نشست داشبورد نیاز دارند.
هیچ عملیاتی با این فیلتر مطابقت ندارد.
/accountبازیابی حساب، میزان مصرف، وضعیت صورتحساب و تعداد فضاهای کاری با کلید API
معادل پروفایل داشبورد برای کلید API: مالک حساب، مصرف گیرندگان و پیوستها در دوره جاری نسبت به محدودیتهای پلن، سطح دسترسی، خلاصه اعتبار فرستنده، وضعیت اشتراک، پلنهای منتشرشده و تعداد فضاهای کاری. فقطخواندنی است؛ تغییرات صورتحساب همچنان فقط از طریق نشست ممکن است.
curl https://sendhq.cc/api/v1/account \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"infrastructure": {},
"billing": {},
"plans": [],
"workspace": {
"mailer": "ses",
"stats": {}
}
}/analyticsبازیابی analytics ارسال داشبورد برای 7، 30 یا 90 روز
مجموع ارسالشده، دریافتشده، تحویلشده، برگشتخورده، مسدودشده، بازشده، کلیکشده و گزارشهای اسپم در این بازه، خط زمانی روزانه ارسال/دریافت، دامنههای ارسال برتر و موضوعهای با بهترین عملکرد.
curl https://sendhq.cc/api/v1/analytics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"window": "30d",
"days": 30,
"metrics": {
"sent": 0,
"received": 0,
"bounced": 0,
"blocked": 0,
"delivered": 0,
"opened": 0,
"clicks": 0,
"complaints": 0
},
"timeline": [],
"domains": [],
"topContent": []
}/profileبازیابی حساب، میزان مصرف و وضعیت اشتراکهای ترکیبی
بازیابی حساب، میزان مصرف و وضعیت اشتراکهای ترکیبی
curl https://sendhq.cc/api/v1/profile \
-X GET \
-H "Cookie: sendhq_session_v2=…"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"billing": {},
"plans": []
}/billing/checkoutشروع یک checkout میزبانیشده برای پلنی که هنوز ندارید (سطح، نوع پیام و دوره صورتحساب)
شروع یک checkout میزبانیشده برای پلنی که هنوز ندارید (سطح، نوع پیام و دوره صورتحساب)
curl https://sendhq.cc/api/v1/billing/checkout \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"plan_key":"scaleup_marketing_annual"}'{
"url": "https://checkout.example/…",
"session_id": "…"
}/billing/cancelلغو اشتراک فعلی درون برنامه بدون تغییر در ارائهدهنده
لغو اشتراک فعلی درون برنامه بدون تغییر در ارائهدهنده
curl https://sendhq.cc/api/v1/billing/cancel \
-X POST \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}/keysایجاد کلید API
ایجاد کلید API
curl https://sendhq.cc/api/v1/keys \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"name":"Production"}'{
"id": "key_…",
"name": "Production",
"key": "re_…",
"prefix": "re_…"
}/keysفهرست metadata کلیدهای API
نام کلیدها، پیشوندهای غیرمحرمانه و زمان آخرین استفاده را فهرست میکند. مقدار کامل کلیدها هرگز برگردانده نمیشود. ایجاد و ابطال کلیدها به نشست داشبورد نیاز دارد.
curl https://sendhq.cc/api/v1/keys \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/keys/:idابطال کلید API
ابطال کلید API
curl https://sendhq.cc/api/v1/keys/id_value \
-X DELETE \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}