دليل التكامل مع Housing Market API
تُولَّد الجداول المرجعية وأوصاف نقاط النهاية ورموز الأخطاء والأمثلة من مواصفات API، وتبقى باللغة الإنجليزية في كل اللغات. الأسماء والمعاملات والرموز متطابقة في كل مكان.
قائمة عناوين IP المسموح بها
لا يعمل المفتاح إلا من عنوان IP المسجّل له. تسجّلون عنوانًا واحدًا عند الاشتراك.
لمعرفة العنوان الذي نراه، استدعوا GET /v1/ping من خادمكم. تُعيد الاستجابة هذا العنوان في الحقل address. سجّلوا ذلك العنوان، لا عنوان مكتبكم أو حاسوبكم المحمول.
يُرفض الطلب الوارد من أي عنوان آخر بالرمز ip_not_allowed، حتى لو كان المفتاح صحيحًا. ويُقبل كلٌّ من عناوين IPv4 وIPv6.
يمكنكم تغيير العنوان المسجّل في وحدة التحكم. التغييرات مسجّلة ومحدودة، لذا سجّلوا العنوان الصادر لخادم مستقر، واستخدموا عنوانًا صادرًا ثابتًا إذا كنتم تعملون لدى مزوّد خدمات سحابية.
إذا كانت خوادمكم خلف خادم وكيل (proxy) أو بوابة NAT، فسجّلوا عنوان الخادم الوكيل أو البوابة، لأنه العنوان الذي نراه.
GET /v1/ping
Check your key and the address we see
Confirms that the key is accepted from the address the request came from, and echoes that address. Use it to check the IP you registered before you build anything else.
Parameters
No parameters.
Responses
| Status | Description | Error codes |
|---|---|---|
200 | The key is valid and the address is registered. | |
401 | The key is missing, unknown or revoked. | unauthenticated |
403 | The key is valid but this request is refused. | ip_not_allowed key_paused |
429 | A rate limit or a quota has been reached. | rate_limited quota_exceeded |
503 | The service cannot answer right now. | service_unavailable |