मुख्य कंटेंट तक स्किप करें

कस्टम डोमेन

डिफ़ॉल्ट रूप से दस्तावेज़ Powerduck के साझा पतों पर उपलब्ध होते हैं। कस्टम डोमेन से दस्तावेज़ और MCP आपके अपने होस्टनाम पर दिखते हैं, ताकि API साझा लिंक के बजाय आपके ब्रांड के अंतर्गत प्रकाशित हो।

कस्टम डोमेन Pro और Team प्लान की सशुल्क सुविधा है। उपलब्धता की जाँच oas.custom_domain अधिकार से होती है।

पूरे होस्ट या उप-पाथ को जोड़ना​

इनमें से किसी को दस्तावेज़ से जोड़ सकते हैं:

  • पूरा होस्ट — api.example.com रूट पर एक दस्तावेज़ उपलब्ध कराता है;
  • होस्ट और उप-पाथ — example.com/v1 दस्तावेज़ को /v1 के अंतर्गत उपलब्ध कराता है।

उप-पाथ जोड़ने से एक होस्टनाम पर कई दस्तावेज़ उपलब्ध हो सकते हैं:

example.com/v1 -> document A
example.com/v2 -> document B

इससे हर दस्तावेज़ के लिए अलग होस्ट की सीमा हटती है और संस्करण वाले बेस पाथ इस्तेमाल किए जा सकते हैं।

कस्टम डोमेन पर पते​

साझा पते पर उपलब्ध इंटरफ़ेस ही जुड़े हुए डोमेन पर छोटे, स्थिर पाथ से उपलब्ध होते हैं:

इंटरफ़ेसपूरा होस्टउप-पाथ
वर्तमान स्पेसिफिकेशन/oas/v1/oas
निश्चित संस्करण का स्पेसिफिकेशन/v/:version/oas/v1/v/:version/oas
MCP/mcp/v1/mcp

अनुरोध के होस्टनाम और पाथ से संबंधित दस्तावेज़ चुना जाता है। इन सभी पाथ के लिए CORS प्रीफ़्लाइट अनुरोध सँभाले जाते हैं।

डोमेन जोड़ना और सत्यापित करना​

स्वामित्व सत्यापित होने तक डोमेन पर भरोसा नहीं किया जाता:

  1. दस्तावेज़ में होस्टनाम या होस्टनाम के साथ पाथ जोड़ें;
  2. सेवा जुड़ाव का विवरण और DNS निर्देश देती है;
  3. DNS रिकॉर्ड बनाएँ और सत्यापन करें;
  4. जुड़ाव लंबित से सत्यापित स्थिति में आ जाता है और सामग्री उपलब्ध कराने लगता है।

स्वामित्व जाँच के लिए TXT रिकॉर्ड इस्तेमाल होता है:

फ़ील्डमान
रिकॉर्ड प्रकारTXT
होस्ट_powerduck-challenge.<your-domain>
मानpowerduck-verify=<verification-token>

सत्यापन DNS से TXT रिकॉर्ड पढ़ता है और टोकन की तुलना स्थिर समय में करता है। पहले से सत्यापित जुड़ाव बिना दोबारा जाँच के सत्यापित रहता है।

उदाहरण​

api.example.com के लिए यह TXT रिकॉर्ड जोड़ें:

_powerduck-challenge.api.example.com
TXT "powerduck-verify=<the-token-shown-for-the-binding>"

फिर दस्तावेज़ के कार्यक्षेत्र में सत्यापित करें चुनें। सत्यापन सफल होने पर दस्तावेज़ और MCP उस डोमेन से उपलब्ध होते हैं, बशर्ते दस्तावेज़ सक्रिय हो और संबंधित इंटरफ़ेस चालू हों।

डोमेन जुड़ाव प्रबंधित करना​

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

ऐक्सेस सेटिंग बदलने पर होस्ट पहचानने वाला कैश अमान्य हो जाता है, ताकि पुराने जुड़ाव इस्तेमाल होते न रहें।

ऐक्सेस नियंत्रण लागू रहता है​

कस्टम डोमेन एक अतिरिक्त पता है, नियंत्रण से बचने का रास्ता नहीं:

  • दस्तावेज़ की स्थिति ACTIVE होनी चाहिए;
  • दस्तावेज़ और MCP की अलग चालू/बंद सेटिंग होती है;
  • देखने का पासवर्ड दस्तावेज़ की और MCP ऐक्सेस कुंजी MCP की सुरक्षा करती रहती है।

ऐक्सेस नियंत्रण देखें।

संबंधित: दस्तावेज़ और संस्करण, बिलिंग।