Housing Market API इंटीग्रेशन गाइड

संदर्भ तालिकाएँ, एंडपॉइंट विवरण, त्रुटि कोड और उदाहरण API विनिर्देश से जनरेट किए जाते हैं और हर भाषा में अंग्रेज़ी में ही रहते हैं। नाम, पैरामीटर और कोड हर जगह एक जैसे हैं।

कुंजी प्राप्त करना

आप कंसोल में सदस्यता लेकर कुंजी प्राप्त करते हैं। न कोई अनुमोदन कतार है और न ही कोई ईमेल भेजना होता है।

  1. कंसोल में साइन इन करें, या खाता बनाएँ। यह वही खाता है जिसका उपयोग आप अन्य Housing Market उत्पादों के लिए करते हैं।
  2. देश, कोई क्षेत्र या विश्वव्यापी, प्लान, और मासिक या वार्षिक बिलिंग चुनें।
  3. वह IP पता दर्ज करें जिससे आपके सर्वर API को कॉल करेंगे।
  4. API की उपयोग की शर्तें स्वीकार करें। आपने क्या और कब स्वीकार किया, इसका रिकॉर्ड हम रखते हैं।
  5. भुगतान करें। आपकी कुंजी भुगतान सफल होने के बाद ही दिखाई देती है, और वह केवल एक बार दिखाई जाती है।

कुंजी को सीधे अपने सीक्रेट स्टोर में कॉपी करें। हम इसका केवल एकतरफ़ा हैश रखते हैं, इसलिए हम इसे आपको दोबारा नहीं दिखा सकते। कुंजी hma_<prefix>_<secret> जैसी दिखती है।

आप किसी भी समय कंसोल में एक प्रतिस्थापन कुंजी बना सकते हैं। ऐसा करने के बाद पुरानी कुंजी 24 घंटे तक काम करती रहती है, ताकि आप बिना डाउनटाइम के नई कुंजी पर जा सकें।

कुंजी की स्थितियाँ

  • सक्रिय: कुंजी काम करती है।
  • रोकी गई: कुंजी को key_paused के साथ अस्वीकार किया जाता है। कारण का समाधान होने पर यह अपने आप फिर से चालू हो जाती है।
  • रद्द की गई: कुंजी को स्थायी रूप से unauthenticated के साथ अस्वीकार किया जाता है।

यदि नवीनीकरण भुगतान विफल हो जाता है, तो आपकी कुंजी 5 दिनों की छूट अवधि तक काम करती रहती है, जिसके दौरान हम हर चरण पर आपको ईमेल करते हैं, और उसके बाद उसे रोक दिया जाता है। भुगतान का निपटान होते ही रोकी गई कुंजी अपने आप फिर से चालू हो जाती है। भुगतान पर विवाद होने पर, उसकी समीक्षा पूरी होने तक कुंजी तुरंत रोक दी जाती है।

देश जोड़ने या अपग्रेड करने का शुल्क तुरंत आनुपातिक रूप से लिया जाता है, और भुगतान की पुष्टि के कुछ ही समय बाद यह बदलाव उसी कुंजी पर लागू हो जाता है। देश हटाना या डाउनग्रेड करना अगले नवीनीकरण पर लागू होता है।