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"