دليل التكامل مع Housing Market API

الحصول على مفتاح

تحصلون على مفتاح بالاشتراك في وحدة التحكم. لا توجد قائمة انتظار للموافقة ولا حاجة إلى إرسال أي بريد إلكتروني.

1. سجّلوا الدخول إلى وحدة التحكم، أو أنشئوا حسابًا. إنه الحساب نفسه الذي تستخدمونه لمنتجات Housing Market الأخرى.
2. اختاروا الدول أو منطقة أو التغطية العالمية، والخطة، والفوترة الشهرية أو السنوية.
3. أدخلوا عنوان IP الذي ستستدعي خوادمكم API منه.
4. وافقوا على شروط استخدام API. نحتفظ بسجل لما وافقتم عليه ومتى.
5. ادفعوا. لا يظهر مفتاحكم إلا بعد نجاح الدفع، ويُعرض مرة واحدة فقط.

انسخوا المفتاح مباشرة إلى مخزن الأسرار لديكم. نحن لا نحتفظ إلا بتجزئة أحادية الاتجاه له، لذا لا يمكننا عرضه عليكم مرة أخرى. يبدو المفتاح هكذا: hma_<prefix>_<secret>.

يمكنكم إنشاء مفتاح بديل في وحدة التحكم في أي وقت. يظل المفتاح القديم يعمل لمدة 24 ساعة بعد ذلك، حتى تتمكنوا من الانتقال دون توقف للخدمة.

حالات المفتاح

• نشط: المفتاح يعمل.
• متوقف مؤقتًا: يُرفض المفتاح بالرمز key_paused. ويُستأنف تلقائيًا عند حل السبب.
• ملغى: يُرفض المفتاح نهائيًا بالرمز unauthenticated.

إذا فشلت دفعة التجديد، يظل مفتاحكم يعمل خلال فترة سماح مدتها 5 يومًا نراسلكم خلالها بالبريد الإلكتروني عند كل خطوة، ثم يُوقف مؤقتًا. ويُستأنف المفتاح المتوقف مؤقتًا تلقائيًا فور تسوية الدفعة. أما النزاع على دفعة فيوقف المفتاح مؤقتًا على الفور إلى أن تتم مراجعته.

تُحتسب إضافة دولة أو الترقية فورًا بشكل تناسبي، وتسري على المفتاح نفسه بعد تأكيد الدفع بوقت قصير. أما إزالة دولة أو الانتقال إلى خطة أدنى فيسري عند التجديد التالي.