Housing Market API इंटीग्रेशन गाइड
संदर्भ तालिकाएँ, एंडपॉइंट विवरण, त्रुटि कोड और उदाहरण API विनिर्देश से जनरेट किए जाते हैं और हर भाषा में अंग्रेज़ी में ही रहते हैं। नाम, पैरामीटर और कोड हर जगह एक जैसे हैं।
IP अनुमति-सूची
कुंजी केवल उसके लिए पंजीकृत IP पते से काम करती है। सदस्यता लेते समय आप एक पता पंजीकृत करते हैं।
हमें कौन-सा पता दिखता है, यह जानने के लिए अपने सर्वर से GET /v1/ping को कॉल करें। रिस्पॉन्स उसे address फ़ील्ड में वापस लौटाता है। वही पता पंजीकृत करें, अपने ऑफ़िस या लैपटॉप का पता नहीं।
किसी भी अन्य पते से आया अनुरोध ip_not_allowed के साथ अस्वीकार कर दिया जाता है, भले ही कुंजी सही हो। IPv4 और IPv6 दोनों प्रकार के पते स्वीकार किए जाते हैं।
आप कंसोल में पंजीकृत पता बदल सकते हैं। बदलाव लॉग किए जाते हैं और सीमित होते हैं, इसलिए किसी स्थिर सर्वर का आउटबाउंड पता पंजीकृत करें, और यदि आप किसी क्लाउड प्रदाता पर चलते हैं तो स्थिर आउटबाउंड पते का उपयोग करें।
यदि आपके सर्वर किसी प्रॉक्सी या 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 |