دليل التكامل مع Housing Market API
تُولَّد الجداول المرجعية وأوصاف نقاط النهاية ورموز الأخطاء والأمثلة من مواصفات API، وتبقى باللغة الإنجليزية في كل اللغات. الأسماء والمعاملات والرموز متطابقة في كل مكان.
المصادقة
أرسلوا مفتاحكم في الترويسة x-api-key مع كل طلب.
احتفظوا بالمفتاح على خادمكم. لا تضعوه أبدًا في تطبيق للهاتف المحمول أو صفحة ويب أو مستودع عام: فأي شخص يحوزه يمكنه استخدام اشتراككم.
المفتاح يخص عميلًا واحدًا. لا تشاركوه مع شركة أخرى؛ فالشروط تحظر ذلك، ويمكننا معرفة المواقع التي يُستخدم منها المفتاح.
مفتاح واحد يحمل كل صلاحيات وصولكم: دولكم وخطتكم. عند إضافة دولة أو الترقية، تتغير صلاحيات المفتاح نفسه؛ ولا تحصلون على مفتاح جديد.
يُرفض المفتاح المفقود أو غير المعروف أو الملغى بالرمز unauthenticated. ويُرفض المفتاح الصالح المستخدم من عنوان غير مسجّل بالرمز ip_not_allowed. ويُرفض المفتاح المتوقف مؤقتًا بالرمز key_paused.
مثال على طلب
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"