یک قرارداد واحد برای کل سطح دسترسی مشتری.

مرزهای احراز هویت

یکپارچه‌سازی‌های محصول از کلید API فضای کاری استفاده می‌کنند که می‌تواند میزان مصرف حساب، analytics و metadata کلیدهای API را نیز بخواند. تغییرات صورتحساب و ایجاد یا ابطال کلید API به نشست مرورگر HTTP-only نیاز دارند و بر همین اساس برچسب خورده‌اند.

منابع

پوشش خطا

خطاهای JSON از یک پوشش قابل‌پیش‌بینی استفاده می‌کنند. کدهای وضعیت، ورودی نامعتبر، احراز هویت، منابع ناموجود، تعارض‌ها، الزام پرداخت، مسدودسازی‌های ایمنی و محدودیت‌های مصرف را از هم متمایز می‌کنند.

{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

نسخه‌بندی

نسخه تاریخ‌محور API این قرارداد را مشخص می‌کند. فیلدهای سازگار با نسخه‌های قبلی می‌توانند در همان نسخه اضافه شوند. تغییرات ناسازگار به مسیر پایه نسخه‌دار جدید و یک دوره انتقال مستند نیاز دارند.

{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}