क्रेडेंशियल्स और एनवायरनमेंट्स#

AI API रिक्वेस्ट Ideal House API खाते से संबंधित API की का उपयोग करते हैं। इसे अपने सर्वर पर रखें और इसे APIKEY रिक्वेस्ट हेडर में भेजें।

एक API की प्राप्त करें#

1. AI API कंसोल में साइन इन करें।
2. API की नियंत्रण खोलें और अपने एकीकरण के लिए की जनरेट या चुनें।
3. इसे अपने सर्वर के सीक्रेट मैनेजर या एनवायरनमेंट कॉन्फ़िगरेशन में स्टोर करें। इसे स्रोत नियंत्रण में कमिट न करें या ब्राउज़र बंडल में शामिल न करें।

इन दस्तावेज़ों को पढ़ने से कोई API की नहीं बनती और न ही किसी खाते तक पहुंच प्रदान की जाती है।

रिक्वेस्ट एनवायरनमेंट कॉन्फ़िगर करें#

चुने गए API रीफरेंस में उल्लिखित बेस URL और रिक्वेस्ट पाथ का उपयोग करें। उदाहरण के लिए, रीफरेंस जो https://api.ideal.house निर्दिष्ट करते हैं, वे उस API होस्ट का उपयोग करते हैं, दस्तावेज़ीकरण URL का नहीं।

API की को एक सर्वर-ओनली एनवायरनमेंट वेरिएबल जैसे IDEALHOUSE_API_KEY में रखें। यह आपके एप्लिकेशन के लिए एक उदाहरण वेरिएबल नाम है; यह एक SDK सेटिंग नहीं है। एक रिक्वेस्ट में निम्नलिखित हेडर शामिल होना चाहिए, जिसमें प्लेसहोल्डर को आपके सर्वर पर बदला जाना चाहिए:

APIKEY: YOUR_API_KEY

एंडपॉइंट के आवश्यक कंटेंट टाइप, फ़ील्ड और इमेज इनपुट फ़ॉर्मेट का पालन करें। असिंक्रोनस ऑपरेशन के लिए, लौटाए गए टास्क आईडी को संरक्षित रखें और उस ऑपरेशन के लिए दस्तावेज़ीकृत रिज़ल्ट एंडपॉइंट का उपयोग करें।

डेवलपमेंट और प्रोडक्शन#

की को गोपनीय रखने के लिए लोकल टेस्ट को अपने बैकएंड के माध्यम से चलाएं। प्रकाशन से पहले अपने डेप्लॉयमेंट सीक्रेट्स कॉन्फ़िगर करें, और मूल्य निर्धारण, टास्क सीमाएं और क्रेडिट कटौती की जाँच करें। टेस्ट रिक्वेस्ट खाते के क्रेडिट का उपयोग कर सकते हैं; ये गाइड एक अलग मुफ्त सैंडबॉक्स का वादा नहीं करते।

मर्चेंट Shop ID, Publishable Key और प्रोडक्ट इम्पोर्ट Client Secret Visualizer SDK एकीकरण से संबंधित हैं। वे एक AI API की को प्रतिस्थापित नहीं करते। मर्चेंट डैशबोर्ड की Allowed Origins (CORS) सेटिंग विज़ुअलाइज़र एकीकरण के लिए है, सर्वर-साइड AI API रिक्वेस्ट के लिए सेटअप चरण नहीं।

प्रमाणीकरण की पुष्टि करें#

क्विक स्टार्ट का पालन करें, फिर ऑपरेशन-विशिष्ट रिस्पॉन्स की जाँच करें। यदि प्रमाणीकरण विफल होता है, तो APIKEY हेडर की पुष्टि करें और एरर कोड से संपर्क करें। लॉग और सपोर्ट स्क्रीनशॉट से की हटाएं।