Happy Melk Partner API

زیرساخت رسمی برای اتصال سایت‌های بنگاهی، اپ‌های خدماتی، پلتفرم‌ها، شهرداری‌ها، سازمان‌ها و مؤسسات به فایلینگ منتشرشده، شاخص‌های هوش ملکی، CRM، خدمات ساخت و بازسازی، ارزیابی HM-METH، پروژه و Webhook.

REST JSONOpenAPI 3.1OAuth 2.0API KeysSigned WebhooksSandboxSDKWhite-label Widgets
درخواست دسترسی APIمشاهده مستنداتChangelogوضعیت سرویس

محصولات API

دسترسی هر شریک بر اساس کاربرد، Scope، محیط، قرارداد و طبقه‌بندی داده محدود می‌شود.

فایل و بازار ملک

جست‌وجوی فایل‌های منتشرشده، جزئیات عمومی، فیلتر شهر و نوع معامله و ثبت فایل شریک.

لید و CRM

ثبت مشتری، Idempotency، SLA پیگیری، دریافت وضعیت و رویدادهای تغییر مرحله.

خدمات و پروژه

ساخت، بازسازی، مدیریت پیمان، تخصیص متخصص و مشاهده پیشرفت مجاز PMO.

ارزیابی HM-METH

ثبت مشخصات ملک، امتیاز مقدماتی شهر، ریسک، کیفیت داده و ارجاع برای کارشناسی.

رصدخانه و گزارش

شاخص‌های منتشرشده، نسخه روش‌شناسی، سطح اطمینان، گزارش و محتوای قابل ارائه.

پژوهش و نوآوری

دریافت فراخوان‌های فعال و ثبت پیشنهاد پژوهشی، پایان‌نامه یا پایلوت.

Webhook

ارسال رویداد امضاشده با Retry، Replay Protection، Delivery Log و Dead Letter.

ویجت White-label

فرم مشاوره، خدمات، ارزیابی، جست‌وجوی ملک و کارت شاخص قابل نصب در سایت شریک.

مسیر فعال‌سازی

درخواست و کاربرد

سازمان، محصول موردنیاز، حجم مصرف و نوع داده مشخص می‌شود.

حقوقی و امنیت

شرایط استفاده، DPA، مالکیت داده، Origin/IP و نگهداری داده بررسی می‌شود.

Sandbox

کلید تست، داده آزمایشی، مستندات، SDK و Webhook Test ارائه می‌شود.

UAT و Live

تست بار، خطا، Scope و قرارداد نهایی شده و کلید Live صادر می‌شود.

اتصال سرور سازمان

برای سامانه‌های سازمانی از کلید محرمانه یا OAuth Client Credentials استفاده شود. Secret هرگز در مرورگر، اپ قابل استخراج یا مخزن عمومی قرار نگیرد.

X-HM-API-Key: hm_sk_live_...

ویجت عمومی

کلید عمومی فقط Scopeهای کم‌خطر دارد و با دامنه‌های مجاز محدود می‌شود.

<happy-melk-lead-form api-key="hm_pk_live_..."></happy-melk-lead-form>

کنترل عملیاتی

سهمیه ماهانه، Rate Limit، گزارش مصرف، P95، خطاها، Rotation کلید، Incident و SLA در پنل ثبت می‌شود.

قاعده امنیتی: کلیدهای `hm_pk_*_...` قابل انتشار اما محدود هستند. کلیدهای `hm_sk_*_...`، OAuth Secret و Webhook Secret فقط در سرور یا Secret Manager نگهداری شوند.

درخواست دسترسی API

درخواست ابتدا بررسی می‌شود. صدور Sandbox به معنای تأیید دسترسی Live نیست.