एपीआई पब्लिश करना

Apigee Edge दस्तावेज़ देखा जा रहा है.
Apigee X दस्तावेज़ पर जाएं. जानकारी

अपने पोर्टल पर एपीआई पब्लिश करें, ताकि ऐप्लिकेशन डेवलपर इन्हें इस्तेमाल कर सकें. इसके बारे में, नीचे दिए गए सेक्शन में बताया गया है.

एपीआई पब्लिश करने की खास जानकारी

आपके पोर्टल पर एपीआई पब्लिश करने की प्रोसेस दो चरणों में होती है:

1. वह एपीआई प्रॉडक्ट चुनें जिसे आपको पोर्टल पर पब्लिश करना है.
2. अपने OpenAPI दस्तावेज़ के स्नैपशॉट या ग्राफ़QL स्कीमा से, एपीआई रेफ़रंस दस्तावेज़ रेंडर करें. इससे ऐप्लिकेशन डेवलपर आपके एपीआई के बारे में जान पाएंगे. (स्नैपशॉट के बारे में ज़्यादा जानकारी के लिए, स्नैपशॉट क्या है? देखें)

पोर्टल में क्या पब्लिश किया जाता है?

एपीआई को पब्लिश करने पर, आपके पोर्टल में अपने-आप ये अपडेट किए जाते हैं:

एपीआई के रेफ़रंस से जुड़े दस्तावेज़. दिया गया इंटरफ़ेस इस बात पर निर्भर करता है कि आपने अपना एपीआई पब्लिश करने के लिए, OpenAPI दस्तावेज़ का इस्तेमाल किया है या ग्राफ़QL स्कीमा का. देखें:

• स्मार्ट दस्तावेज़ (OpenAPI)
• ग्राफ़QL एक्सप्लोरर

एपीआई के पेज पर, एपीआई के रेफ़रंस पेज का लिंक जोड़ दिया गया है

एपीआई पेज (सैंपल पोर्टल के साथ शामिल है) आपके पोर्टल पर पब्लिश किए गए सभी एपीआई की सूची उपलब्ध कराता है. इन एपीआई की सूची वर्णमाला के क्रम में होती है. साथ ही, ज़्यादा जानकारी के लिए एपीआई के रेफ़रंस दस्तावेज़ के लिंक भी होते हैं. इसके अलावा, इन्हें अपनी पसंद के मुताबिक बनाया जा सकता है:

• हर एपीआई कार्ड के लिए इमेज दिखाई जाती है
• टैग करने के एपीआई के लिए इस्तेमाल की जाने वाली कैटगरी, ताकि डेवलपर, एपीआई पेज पर मिलते-जुलते एपीआई खोज सकें

स्मार्ट दस्तावेज़ (OpenAPI)

जब किसी OpenAPI दस्तावेज़ का इस्तेमाल करके कोई एपीआई पब्लिश किया जाता है, तब SmartDocs API से जुड़ा दस्तावेज़ आपके पोर्टल में जोड़ दिया जाता है.

डेवलपर आपके SmartDocs API के रेफ़रंस दस्तावेज़ देख सकते हैं. साथ ही, एपीआई अनुरोध करने और आउटपुट देखने के लिए, यह एपीआई आज़माएं पैनल का इस्तेमाल कर सकते हैं. आज़माएं यह API, असुरक्षित एंडपॉइंट या सुरक्षित एंडपॉइंट के साथ काम करता है. इसके लिए, बेसिक, एपीआई पासकोड या OAuth पुष्टि करने की सुविधा का इस्तेमाल किया जाता है. ऐसा, आपके OpenAPI दस्तावेज़ में बताए गए सुरक्षा के तरीके के आधार पर किया जाता है. OAuth के लिए, ये फ़्लो काम करते हैं: ऑथराइज़ेशन कोड, पासवर्ड, और क्लाइंट के क्रेडेंशियल.

'यह एपीआई आज़माएं' पैनल को बड़ा करने के लिए पर क्लिक करें. बड़े किए गए पैनल की मदद से, कर्ल कॉल और कोड सैंपल को अलग-अलग फ़ॉर्मैट में देखा जा सकता है. इनमें एचटीटीपी, Python, Node.js वगैरह शामिल हैं, जैसा कि यहां दिखाया गया है.

ग्राफ़QL एक्सप्लोरर

जब किसी API को ग्राफ़QL स्कीमा का इस्तेमाल करके पब्लिश किया जाता है, तो उस एपीआई को आपके पोर्टल में जोड़ दिया जाता है. ग्राफ़QL एक्सप्लोरर आपके एपीआई के ख़िलाफ़ क्वेरी चलाने के लिए एक इंटरैक्टिव प्लेग्राउंड है. यह एक्सप्लोरर, GraphiQL पर आधारित है. ग्राफ़QL IDE के रेफ़रंस के तौर पर, इसे GraQL Foundation ने डेवलप किया है.

डेवलपर, ग्राफ़QL एक्सप्लोरर का इस्तेमाल स्कीमा पर आधारित इंटरैक्टिव दस्तावेज़ों को एक्सप्लोर करने, क्वेरी बनाने और चलाने, क्वेरी के नतीजे देखने, और स्कीमा डाउनलोड करने के लिए कर सकते हैं. आपके एपीआई का सुरक्षित ऐक्सेस पाने के लिए, डेवलपर अनुरोध हेडर पैनल में ऑथराइज़ेशन हेडर पास कर सकते हैं.

ग्राफ़QL के बारे में ज़्यादा जानकारी के लिए, graphql.org देखें.

स्नैपशॉट क्या होता है?

हर OpenAPI या ग्राफ़QL दस्तावेज़, किसी एपीआई की पूरी लाइफ़साइकल के दौरान, सच्चाई के सोर्स के तौर पर काम करता है. एपीआई के लाइफ़साइकल के हर चरण में, एक ही दस्तावेज़ का इस्तेमाल किया जाता है. इसमें डेवलपमेंट से लेकर पब्लिशिंग और मॉनिटरिंग तक, सभी चरण शामिल हैं. किसी दस्तावेज़ में बदलाव करते समय, आपको यह पता होना चाहिए कि अन्य लाइफ़साइकल चरणों में, आपके एपीआई पर हुए बदलावों का क्या असर होता है. दस्तावेज़ में बदलाव करने पर क्या होता है?

अपना एपीआई पब्लिश करने के बाद, एपीआई रेफ़रंस दस्तावेज़ को रेंडर करने के लिए, OpenAPI या ग्राफ़QL दस्तावेज़ का स्नैपशॉट लिया जाता है. वह स्नैपशॉट, दस्तावेज़ का खास वर्शन दिखाता है. अगर दस्तावेज़ में बदलाव किया जाता है, तो एपीआई के रेफ़रंस दस्तावेज़ में हुए नए बदलावों को दिखाने के लिए, आपके पास दस्तावेज़ का एक और स्नैपशॉट लेने का विकल्प होता है.

कॉलबैक यूआरएल के बारे में जानकारी

अगर आपके ऐप्लिकेशन को कॉलबैक यूआरएल की ज़रूरत होती है, जैसे कि OAuth 2.0 के ऑथराइज़ेशन कोड के इस्तेमाल करने के तरीके (जिसे अक्सर "थ्री-लेग्ड OAuth" भी कहा जाता है) का इस्तेमाल करते समय, डेवलपर अपने ऐप्लिकेशन रजिस्टर करते समय एक कॉलबैक यूआरएल तय कर सकते हैं. कॉलबैक यूआरएल आम तौर पर, उस ऐप्लिकेशन के यूआरएल के बारे में बताता है जिसे क्लाइंट ऐप्लिकेशन की ओर से ऑथराइज़ेशन कोड पाने के लिए तय किया जाता है. ज़्यादा जानकारी के लिए, ऑथराइज़ेशन कोड के ऐक्सेस का टाइप लागू करना लेख पढ़ें.

अपने पोर्टल में एपीआई जोड़ते समय, यह कॉन्फ़िगर किया जा सकता है कि ऐप्लिकेशन रजिस्ट्रेशन के दौरान कॉलबैक यूआरएल की ज़रूरत हो या नहीं. एपीआई के लिए कॉलबैक यूआरएल मैनेज करें में बताए गए तरीके से, इस सेटिंग में किसी भी समय बदलाव किया जा सकता है.

ऐप्लिकेशन को रजिस्टर करते समय, डेवलपर को उन सभी एपीआई के लिए कॉलबैक यूआरएल डालना होगा जिनके लिए यह ज़रूरी है. इस बारे में ऐप्लिकेशन रजिस्टर करें में बताया गया है.

"यह API आज़माएं" की सहायता करने के लिए अपने एपीआई प्रॉक्सी को कॉन्फ़िगर करें

किसी OpenAPI दस्तावेज़ का इस्तेमाल करके अपने API को पब्लिश करने से पहले, आपको अपना एपीआई प्रॉक्सी कॉन्फ़िगर करना होगा, ताकि आप SmartDocs API के रेफ़रंस दस्तावेज़ में दिए गए 'इस एपीआई को आज़माएं' पैनल पर अनुरोध कर सकें:

• क्लाइंट-साइड क्रॉस-ऑरिजिन अनुरोधों को लागू करने के लिए, अपने एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ें
  

  सीओआरएस एक स्टैंडर्ड तरीका है. इसकी मदद से, वेब पेज पर JavaScript XMLHttpRequest (XHR) कॉल किए जा सकते हैं, ताकि ऑरिजिन वाले डोमेन के संसाधनों के साथ इंटरैक्ट किया जा सके. सीओआरएस, "एक ही ऑरिजिन से जुड़ी नीति" के लिए आम तौर पर लागू किया जाने वाला समाधान है. इसे सभी ब्राउज़र लागू करते हैं.

• अगर पुष्टि करने की सामान्य सुविधा या OAuth2 का इस्तेमाल किया जा रहा है, तो अपना एपीआई प्रॉक्सी कॉन्फ़िगरेशन अपडेट करें

नीचे दी गई टेबल में, एपीआई प्रॉक्सी कॉन्फ़िगरेशन से जुड़ी ज़रूरी शर्तों के बारे में खास जानकारी दी गई है. इससे, पुष्टि करने के ऐक्सेस के आधार पर SmartDocs API के रेफ़रंस दस्तावेज़ में, 'इस एपीआई पैनल को आज़माएं' पैनल को चलाने में मदद मिलती है.

पुष्टि करने का ऐक्सेस	नीति को कॉन्फ़िगर करने से जुड़ी ज़रूरी शर्तें
कोई नहीं या एपीआई पासकोड	अपने एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ें. आपकी सुविधा के लिए, GitHub पर दिए गए सैंपल सीओआरएस समाधान का इस्तेमाल करें या एपीआई प्रॉक्सी में सीओआरएस सहायता जोड़ना में बताया गया तरीका अपनाएं.
पुष्टि करने का बुनियादी तरीका	यह तरीका अपनाएं: अपने एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ें. आपकी सुविधा के लिए, GitHub पर दिए गए सैंपल सीओआरएस समाधान का इस्तेमाल करें या एपीआई प्रॉक्सी में सीओआरएस सहायता जोड़ना में बताया गया तरीका अपनाएं. 'सीओआरएस असाइन मैसेज जोड़ें' नीति में, पक्का करें कि Access-Control-Allow-Headers हेडर में authorization एट्रिब्यूट शामिल है. उदाहरण के लिए: <Header name="Access-Control-Allow-Headers"> origin, x-requested-with, accept, content-type, authorization </Header>
OAuth2	अपने एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ें. आपकी सुविधा के लिए, GitHub पर दिए गए सैंपल सीओआरएस समाधान का इस्तेमाल करें या एपीआई प्रॉक्सी में सीओआरएस सहायता जोड़ना में बताया गया तरीका अपनाएं. 'सीओआरएस असाइन मैसेज जोड़ें' नीति में, पक्का करें कि Access-Control-Allow-Headers हेडर में authorization एट्रिब्यूट शामिल है. उदाहरण के लिए: <Header name="Access-Control-Allow-Headers"> origin, x-requested-with, accept, content-type, authorization </Header> अपनी OAuth2 नीति में, RFC के मुताबिक न होने वाले व्यवहार को ठीक करें. आपकी सुविधा के लिए, GitHub पर दिए गए OAuth2 के सैंपल का इस्तेमाल करें या यह तरीका अपनाएं: पक्का करें कि OAuth2 नीति में <GrantType> एलिमेंट, request.formparam.grant_type (फ़ॉर्म पैरामीटर) पर सेट हो. ज़्यादा जानकारी के लिए, <GrantType> देखें. यह पक्का करें कि OAuth2 नीति में token_type को Bearer पर सेट किया गया हो, न कि डिफ़ॉल्ट BearerToken पर.

एपीआई कैटलॉग के बारे में ज़्यादा जानें

एपीआई कैटलॉग देखने के लिए:
1. पब्लिश करें > पोर्टल चुनें और अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर एपीआई कैटलॉग पर क्लिक करें.
इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में, पोर्टल ड्रॉप-डाउन मेन्यू में एपीआई कैटलॉग चुनने का भी विकल्प है.

एपीआई कैटलॉग में एपीआई टैब में उन एपीआई की सूची दिखती है जिन्हें आपके पोर्टल में जोड़ा गया है.

जैसा कि पिछले इमेज में बताया गया है, एपीआई टैब का इस्तेमाल करके, ये काम किए जा सकते हैं:

• अपने पोर्टल पर उपलब्ध एपीआई की जानकारी देखें
• अपने पोर्टल में एपीआई जोड़ना
• अपने पोर्टल पर किसी एपीआई में बदलाव करने के लिए, इनमें से एक या एक से ज़्यादा टास्क करें:
  • एपीआई रेफ़रंस दस्तावेज़ को अपडेट करने के लिए, एपीआई प्रॉडक्ट से जुड़े दस्तावेज़ का स्नैपशॉट मैनेज करें
  • अपने पोर्टल पर एपीआई पब्लिश या अनपब्लिश करना
  • यह मैनेज करना कि आपके पोर्टल में कोई एपीआई किसको दिखे:
  • एपीआई के लिए कॉलबैक यूआरएल मैनेज करें
  • एपीआई कार्ड के लिए इमेज मैनेज करना
  • कैटगरी का इस्तेमाल करके किसी एपीआई को टैग करना
  • एपीआई के टाइटल और जानकारी में बदलाव करना
• अपने पोर्टल से एपीआई हटाना
• मिलते-जुलते एपीआई खोजने के लिए इस्तेमाल की जाने वाली कैटगरी मैनेज करना
• उन सुविधाओं का तुरंत पता लगाएं जो पुरानी हो गई हैं या जिन्हें स्पेसिफ़िकेशन स्टोर से मिटा दिया गया है
• उन "ऑर्फ़न" एपीआई की तुरंत पहचान करें जिनसे जुड़े एपीआई प्रॉडक्ट को Edge से हटा दिया गया है. साथ ही, एपीआई प्रॉडक्ट फिर से बनाएं या अपने पोर्टल से इस एपीआई को मिटाएं

अपने पोर्टल में एपीआई जोड़ना

अपने पोर्टल में एपीआई जोड़ने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.

3. + पर क्लिक करें.

   'कैटलॉग में जोड़ें' डायलॉग बॉक्स दिखता है.

4. वह एपीआई प्रॉडक्ट चुनें जिसे पोर्टल में जोड़ना है.

5. अगला पर क्लिक करें.
   एपीआई की ज़्यादा जानकारी वाला पेज दिखेगा.

6. एपीआई रेफ़रंस से जुड़े दस्तावेज़ का कॉन्टेंट कॉन्फ़िगर करें. साथ ही, यह भी कॉन्फ़िगर करें कि पोर्टल पर यह दस्तावेज़ किसको दिखे:

   फ़ील्ड	ब्यौरा
   पब्लिश किया गया	अपने पोर्टल पर एपीआई को पब्लिश करने के लिए, पब्लिश किया गया चुनें. अगर आप एपीआई को पब्लिश करने के लिए तैयार नहीं हैं, तो चेकबॉक्स से सही का निशान हटाएं. आपके पास बाद में इस सेटिंग को बदलने का विकल्प है. इसके बारे में, अपने पोर्टल पर एपीआई को पब्लिश या अनपब्लिश करना लेख में बताया गया है.
   टाइटल दिखाएं	कैटलॉग में दिखने वाले अपने एपीआई का टाइटल अपडेट करें. डिफ़ॉल्ट रूप से, एपीआई प्रॉडक्ट के नाम का इस्तेमाल किया जाता है. आपके पास, डिसप्ले टाइटल को बाद में बदलने का विकल्प होता है. इसके लिए, डिसप्ले टाइटल और ब्यौरे में बदलाव करें लेख में बताए गए तरीके का इस्तेमाल करें.
   ब्यौरा दिखाएं	कैटलॉग में दिखने वाले अपने एपीआई की जानकारी को अपडेट करें. डिफ़ॉल्ट रूप से, एपीआई प्रॉडक्ट की जानकारी का इस्तेमाल किया जाता है. डिसप्ले की जानकारी को बाद में बदला जा सकता है, जैसा कि डिसप्ले टाइटल और ब्यौरे में बदलाव करें में बताया गया है.
   डेवलपर को कॉलबैक यूआरएल बताना ज़रूरी है	अगर आपकी इच्छा है कि ऐप्लिकेशन डेवलपर एक कॉलबैक यूआरएल डालें, तो सेटिंग को चालू करें. एपीआई के लिए कॉलबैक यूआरएल मैनेज करें में बताए गए तरीके के मुताबिक, कॉलबैक यूआरएल को बाद में जोड़ा या अपडेट किया जा सकता है.
   API दस्तावेज़ीकरण	OpenAPI दस्तावेज़ का इस्तेमाल करने के लिए: OpenAPI दस्तावेज़ चुनें. दस्तावेज़ चुनें पर क्लिक करें. इनमें से कोई एक तरीका अपनाएं: मेरी विशेषताएं टैब पर क्लिक करें और स्पेसिफ़िकेशन स्टोर से कोई खास जानकारी चुनें. फ़ाइल अपलोड करें टैब पर क्लिक करें और फ़ाइल अपलोड करें. यूआरएल से इंपोर्ट करें टैब पर क्लिक करें और किसी यूआरएल से खास जानकारी इंपोर्ट करें. चुनें पर क्लिक करें. ग्राफ़QL स्कीमा का इस्तेमाल करने के लिए: ग्राफ़QL स्कीमा चुनें. दस्तावेज़ चुनें पर क्लिक करें. ग्राफ़QL स्कीमा पर जाएं और उसे चुनें. चुनें पर क्लिक करें. इसके अलावा, कोई दस्तावेज़ नहीं चुनकर, एपीआई जोड़ने के बाद एक दस्तावेज़ जोड़ा जा सकता है. इसके लिए, दस्तावेज़ का स्नैपशॉट मैनेज करना सेक्शन में बताया गया तरीका अपनाएं.
   एपीआई किसको दिखे	अगर आपने ऑडियंस मैनेजमेंट की सुविधा के बीटा वर्शन में रजिस्टर नहीं किया है, तो इनमें से कोई एक विकल्प चुनें: पहचान छिपाने वाले उपयोगकर्ता: सभी उपयोगकर्ताओं को एपीआई देखने की अनुमति देने के लिए. रजिस्टर कर चुके उपयोगकर्ता, ताकि सिर्फ़ रजिस्टर्ड उपयोगकर्ता ही एपीआई देख सकें. अगर आपने ऑडियंस मैनेजमेंट सुविधा के बीटा रिलीज़ में रजिस्टर किया है, तो इनमें से कोई एक विकल्प चुनें: सभी उपयोगकर्ताओं को एपीआई देखने की अनुमति देने के लिए सार्वजनिक (सभी को दिखेगी). पुष्टि किए गए उपयोगकर्ता, ताकि सिर्फ़ रजिस्टर किए गए उपयोगकर्ता ही एपीआई देख सकें. चुनी गई ऑडियंस चुनें, ताकि आप उन खास ऑडियंस को चुन सकें जिन्हें आपको एपीआई दिखाना है. अपने पोर्टल में एपीआई के दिखने की सेटिंग को मैनेज करना लेख में बताए गए तरीके का इस्तेमाल करके, बाद में यह मैनेज किया जा सकता है कि ऑडियंस किसको दिखे.
   प्रदर्शन इमेज	एपीआई पेज पर, एपीआई कार्ड पर इमेज दिखाने के लिए, इमेज चुनें पर क्लिक करें. इमेज चुनें डायलॉग बॉक्स में, कोई मौजूदा इमेज चुनें, नई इमेज अपलोड करें या किसी बाहरी इमेज का यूआरएल डालें. इसके बाद, चुनें पर क्लिक करें. एपीआई के थंबनेल की झलक देखें और चुनें पर क्लिक करें. आपके पास बाद में इमेज जोड़ने का विकल्प होता है. इसके लिए, एपीआई कार्ड के लिए इमेज मैनेज करना लेख में बताया गया तरीका अपनाएं.
   कैटगरी	वे कैटगरी जोड़ें जिनमें एपीआई को टैग किया जाएगा. इससे ऐप्लिकेशन डेवलपर, एपीआई पेज पर मिलते-जुलते एपीआई खोज सकेंगे. किसी कैटगरी की पहचान करने के लिए: ड्रॉप-डाउन सूची से कोई कैटगरी चुनें. नई कैटगरी जोड़ने के लिए, उसका नाम लिखें और Enter दबाएं. नई कैटगरी को 'कैटगरी' पेज में जोड़ दिया जाएगा और अन्य एपीआई को जोड़ते या उनमें बदलाव करते समय उपलब्ध कराया जाएगा.

7. सेव करें पर क्लिक करें.

दस्तावेज़ का स्नैपशॉट मैनेज करना

अपने एपीआई को पब्लिश करने के बाद, आपके पास किसी भी समय OpenAPI या ग्राफ़QL दस्तावेज़ का एक नया स्नैपशॉट लेने का विकल्प होता है. ऐसा करके, आपके पोर्टल पर पब्लिश किए गए, एपीआई के रेफ़रंस दस्तावेज़ को अपडेट किया जा सकता है.

दस्तावेज़ का स्नैपशॉट मैनेज करने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
3. एपीआई की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
4. स्नैपशॉट की स्थिति देखें. अगर यह पुराना हो गया है, तो यह मैसेज दिखेगा:
   
5. पर क्लिक करें.
6. इनमें से कोई एक टास्क करें:
   • पुराने OpenAPI दस्तावेज़ का स्नैपशॉट रीफ़्रेश करने के लिए, स्नैपशॉट रीफ़्रेश करें पर क्लिक करें.
   • एपीआई के दस्तावेज़ में, एपीआई के दस्तावेज़ में जिस दस्तावेज़ का इस्तेमाल करके उसके लिए दस्तावेज़ जनरेट किया जाता है उसमें बदलाव करने के लिए, दस्तावेज़ चुनें पर क्लिक करें और नया दस्तावेज़ चुनें.
7. सेव करें पर क्लिक करें.

एपीआई के रेफ़रंस दस्तावेज़ को दस्तावेज़ से रेंडर करके, एपीआई के रेफ़रंस पेज में जोड़ा जाता है. स्नैपशॉट स्टेटस को 'मौजूदा' में अपडेट कर दिया जाता है:

अपने पोर्टल पर एपीआई पब्लिश या अनपब्लिश करना

अपने पोर्टल पर किसी एपीआई को पब्लिश या अनपब्लिश करने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
3. एपीआई की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
4. पर क्लिक करें.
5. एपीआई की जानकारी में जाकर, अपने पोर्टल पर एपीआई को पब्लिश या अनपब्लिश करने के लिए, पब्लिश किया गया (कैटलॉग में शामिल) को चुनें या उस पर से चुने हुए का निशान हटाएं.
6. सेव करें पर क्लिक करें.

मैनेज करें कि आपके पोर्टल में कोई एपीआई किसको दिखे

इन चीज़ों का ऐक्सेस देकर, आपके पोर्टल में एपीआई किसको दिखे, इसे मैनेज करें:

• सार्वजनिक (सभी को दिखेगी)
• पुष्टि किए गए उपयोगकर्ता
• चुनी गई ऑडियंस (अगर आपने ऑडियंस मैनेजमेंट सुविधा के बीटा रिलीज़ में रजिस्टर किया है)

पोर्टल में यह मैनेज करने के लिए कि एपीआई किसको दिखे:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
3. एपीआई की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
4. पर क्लिक करें.
5. एपीआई विज़िबिलिटी के तहत, इनमें से कोई एक विकल्प चुनें:

6. 'किसको दिखे' सेटिंग चुनें. अगर आपने ऑडियंस की सुविधा के बीटा वर्शन में रजिस्टर किया है, तो इनमें से कोई एक विकल्प चुनें:

   • सार्वजनिक (सभी को दिखाई दे), ताकि सभी उपयोगकर्ता पेज देख सकें.
   • पुष्टि किए गए उपयोगकर्ता: सिर्फ़ रजिस्टर किए गए उपयोगकर्ता ही पेज को देख सकते हैं.
   • चुनी गई ऑडियंस, ताकि आप उन खास ऑडियंस को चुन सकें जिन्हें आपको पेज दिखाना है. अपने पोर्टल के लिए ऑडियंस मैनेज करना लेख पढ़ें.
   इसके अलावा, इनमें से कोई एक विकल्प चुनें:
   • पहचान छिपाने वाले उपयोगकर्ता: सभी उपयोगकर्ताओं को पेज देखने की अनुमति दें.
   • रजिस्टर कर चुके उपयोगकर्ता, ताकि सिर्फ़ रजिस्टर्ड उपयोगकर्ता ही पेज देख सकें.

7. सबमिट करें पर क्लिक करें.

एपीआई के लिए कॉलबैक यूआरएल मैनेज करें

एपीआई के लिए कॉलबैक यूआरएल मैनेज करें. कॉलबैक यूआरएल के बारे में जानकारी देखें.

किसी एपीआई के लिए कॉलबैक यूआरएल को मैनेज करने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
3. एपीआई की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
4. पर क्लिक करें.
5. एपीआई की जानकारी में जाकर, अपने पोर्टल पर एपीआई को पब्लिश या अनपब्लिश करने के लिए, पब्लिश किया गया (कैटलॉग में शामिल) को चुनें या उस पर से चुने हुए का निशान हटाएं.
6. सेव करें पर क्लिक करें.

एपीआई कार्ड के लिए इमेज मैनेज करना

मौजूदा इमेज को जोड़कर या बदलकर, एपीआई पेज पर एपीआई कार्ड के साथ दिखने वाली इमेज को मैनेज करें.

किसी एपीआई कार्ड की इमेज मैनेज करने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
3. एपीआई की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
4. पर क्लिक करें.

5. एपीआई की जानकारी में जाकर:

   • अगर फ़िलहाल कोई इमेज नहीं चुनी गई है, तो इमेज चुनने या अपलोड करने के लिए, इमेज चुनें पर क्लिक करें.
   • कोई दूसरी इमेज चुनने या अपलोड करने के लिए, इमेज बदलें पर क्लिक करें.
   • इमेज को हटाने के लिए, उसमें x पर क्लिक करें.

6. सेव करें पर क्लिक करें.

कैटगरी का इस्तेमाल करके एपीआई को टैग करें

इनमें से किसी एक तरीके से कैटगरी का इस्तेमाल करके, किसी एपीआई को टैग करें:

• नीचे बताए गए तरीके से, एपीआई में बदलाव करते समय उन कैटगरी को मैनेज करें जिनमें किसी एपीआई को टैग किया गया है.
• कैटगरी में बदलाव करते समय, किसी कैटगरी में टैग किए गए एपीआई मैनेज करें.

एपीआई में बदलाव करते समय, किसी एपीआई को कैटगरी में टैग करने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
3. एपीआई की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
4. पर क्लिक करें.
5. कैटगरी फ़ील्ड पर क्लिक करके, इनमें से कोई एक तरीका अपनाएं:
   • ड्रॉप-डाउन सूची से कोई कैटगरी चुनें.
   • नई कैटगरी जोड़ने के लिए, उसका नाम लिखें और Enter दबाएं. नई कैटगरी को 'कैटगरी' पेज में जोड़ दिया जाएगा और अन्य एपीआई को जोड़ते या उनमें बदलाव करते समय उपलब्ध कराया जाएगा.
6. एपीआई को और कैटगरी में टैग करने के लिए, इसे दोहराएं.
7. सेव करें पर क्लिक करें.

डिसप्ले टाइटल और ब्यौरे में बदलाव करें

डिसप्ले टाइटल और ब्यौरे में बदलाव करने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई टैब को पहले से नहीं चुना गया है, तो उस पर क्लिक करें.
3. एपीआई की उस लाइन पर क्लिक करें जिसमें आपको बदलाव करना है.
4. पर क्लिक करें.
5. ज़रूरत के हिसाब से, डिसप्ले टाइटल और डिसप्ले का ब्यौरा फ़ील्ड में बदलाव करें.
6. सेव करें पर क्लिक करें.

अपने पोर्टल से किसी एपीआई को हटाना

अपने पोर्टल से किसी एपीआई को हटाने के लिए:

1. एपीआई कैटलॉग को ऐक्सेस करना.
2. अगर एपीआई को पहले से नहीं चुना गया है, तो उन्हें चुनें.
3. ऐक्शन मेन्यू देखने के लिए सूची में मौजूद एपीआई पर अपना कर्सर रखें.
4. पर क्लिक करें.

मिलते-जुलते एपीआई खोजने के लिए इस्तेमाल की जाने वाली कैटगरी मैनेज करें

कैटगरी का इस्तेमाल करके किसी एपीआई को टैग करें. इससे ऐप्लिकेशन डेवलपर, लाइव पोर्टल के एपीआई पेज पर, मिलते-जुलते एपीआई खोज पाएंगे. नीचे दिए गए सेक्शन में बताए गए तरीके से कैटगरी जोड़ें और मैनेज करें.

कैटगरी पेज के बारे में ज़्यादा जानें

कैटगरी पेज देखने के लिए:

1. पब्लिश करें > पोर्टल चुनें और अपना पोर्टल चुनें.
2. पोर्टल के होम पेज पर एपीआई कैटलॉग पर क्लिक करें.

   इसके अलावा, आपके पास सबसे ऊपर मौजूद नेविगेशन बार में मौजूद पोर्टल ड्रॉप-डाउन मेन्यू में जाकर, एपीआई कैटलॉग को चुनने का भी विकल्प है.

3. कैटगरी टैब पर क्लिक करें.

एपीआई कैटलॉग में कैटगरी टैब में, आपके पोर्टल के लिए तय की गई कैटगरी की सूची दिखती है.

जैसा कि पिछले चित्र में बताया गया है, एपीआई पेज आपको ये काम करने की सुविधा देता है:

• वे कैटगरी और एपीआई देखें जिनमें उन्हें टैग किया गया है
• कैटगरी जोड़ना
• कैटगरी में बदलाव करना
• किसी कैटगरी को मिटाना
• आपके पोर्टल पर पब्लिश किए गए एपीआई मैनेज करें. एपीआई कैटलॉग को एक्सप्लोर करना देखें

कोई श्रेणी जोड़ना

इनमें से किसी एक तरीके से कैटगरी जोड़ें:

• पोर्टल में एपीआई जोड़ते समय किसी कैटगरी का नाम डालें
• मैन्युअल तरीके से कोई कैटगरी जोड़ें, जैसा कि यहां बताया गया है

नई कैटगरी को 'कैटगरी' पेज में जोड़ दिया जाएगा और अन्य एपीआई को जोड़ते या उनमें बदलाव करते समय उपलब्ध कराया जाएगा.

मैन्युअल तरीके से कैटगरी जोड़ने के लिए:

1. कैटगरी पेज को ऐक्सेस करें.
2. + पर क्लिक करें.
3. अपनी नई कैटगरी का नाम डालें.
4. विकल्प के तौर पर, कैटगरी में टैग करने के लिए एक या उससे ज़्यादा एपीआई चुनें.
5. बनाएं पर क्लिक करें.

कैटगरी में बदलाव करना

कैटगरी में बदलाव करने के लिए:

1. कैटगरी पेज को ऐक्सेस करें.
2. पर क्लिक करें.
3. कैटगरी के नाम में बदलाव करें.
4. एपीआई टैग जोड़ें या हटाएं.
5. सेव करें पर क्लिक करें.

कोई श्रेणी हटाएं

जब किसी कैटगरी को मिटाया जाता है, तो उस कैटगरी के सभी एपीआई टैग भी मिट जाते हैं.

किसी कैटगरी को मिटाने के लिए:

1. कैटगरी पेज को ऐक्सेस करें.
2. ऐक्शन मेन्यू दिखाने के लिए, कर्सर को उस कैटगरी पर रखें जिसमें आपको बदलाव करना है.
3. पर क्लिक करें.
4. कैटगरी के नाम में बदलाव करें.
5. एपीआई जोड़ें या हटाएं.
6. सेव करें पर क्लिक करें.

अपने पब्लिश किए गए एपीआई से जुड़ी समस्याओं को हल करना

यहां दिए गए सेक्शन में, हमारे पब्लिश किए गए एपीआई की खास गड़बड़ियों को ठीक करने के बारे में जानकारी दी गई है.

गड़बड़ी: इस एपीआई का इस्तेमाल करते समय, गड़बड़ी को फ़ेच नहीं किया जा सका

इस एपीआई का इस्तेमाल करते समय, अगर TypeError: Failed to fetch गड़बड़ी दिखती है, तो इसकी वजह और उसे ठीक करने के ये तरीके अपनाएं:

• मिले-जुले कॉन्टेंट से जुड़ी गड़बड़ियों के लिए, स्वैगर-यूज़र इंटरफ़ेस (यूआई) से जुड़ी किसी जानी-पहचानी समस्या की वजह से यह गड़बड़ी हो सकती है. इसका एक संभावित हल यह पक्का करना है कि आप अपने OpenAPI दस्तावेज़ की schemes परिभाषा में HTTP से पहले एचटीटीपीएस की जानकारी दें. उदाहरण के लिए:

  schemes:
     - https
     - http
  

• क्रॉस-ऑरिजिन रिसॉर्स शेयरिंग (सीओआरएस) की पाबंदियों से जुड़ी गड़बड़ियों के लिए, पक्का करें कि सीओआरएस आपके एपीआई प्रॉक्सी के साथ काम करता हो. सीओआरएस एक स्टैंडर्ड तरीका है, जो क्लाइंट-साइड क्रॉस-ऑरिजिन अनुरोधों को चालू करता है. इस एपीआई को आज़माएं का इस्तेमाल करने के लिए, अपने एपीआई प्रॉक्सी को कॉन्फ़िगर करें लेख देखें.

गड़बड़ी: 'Access-Control-Allow-Origin' हेडर में एक से ज़्यादा वैल्यू '*, *' हैं. हालांकि, सिर्फ़ एक ही वैल्यू का इस्तेमाल किया जा सकता है

इस एपीआई को आज़माएं का इस्तेमाल करते समय, अगर Access-Control-Allow-Origin हेडर पहले से मौजूद है, तो आपको गड़बड़ी का यह मैसेज मिल सकता है:

The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

इस गड़बड़ी को ठीक करने के लिए, सीओआरएस हेडर को <Add> के बजाय <Set> का इस्तेमाल करके सेट करने के लिए, AssignmentsMessage नीति में बदलाव करें. ऐसा करने के लिए, नीचे दिए गए उद्धरण का इस्तेमाल करें. ज़्यादा जानकारी के लिए, इस विषय से जुड़ा कम्यूनिटी लेख पढ़ें.

<AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

गड़बड़ी: अनुरोध के हेडर फ़ील्ड की अनुमति नहीं है

इस एपीआई को आज़माएं का इस्तेमाल करते समय, अगर आपको नीचे दिए गए उदाहरण से मिलती-जुलती Request header field not allowed गड़बड़ी मिलती है, तो आपको सीओआरएस नीति में काम करने वाले हेडर अपडेट करने पड़ सकते हैं. उदाहरण के लिए:

Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

इस उदाहरण में, आपको अपनी सीओआरएस असाइन मैसेज नीति के Access-Control-Allow-Headers सेक्शन में content-type हेडर जोड़ना होगा, जैसा कि नए एपीआई प्रॉक्सी में सीओआरएस जोड़ें नीति अटैच करना में बताया गया है.

गड़बड़ी: OAuth2 का इस्तेमाल करके एपीआई प्रॉक्सी को कॉल करते समय, ऐक्सेस अस्वीकार किया गया

Apigee की OAuthV2 नीति, ऐसा टोकन रिस्पॉन्स दिखाती है जिसमें RFC का पालन न करने वाली कुछ प्रॉपर्टी शामिल होती हैं. उदाहरण के लिए, इस नीति से आरएफ़सी की शर्तों के मुताबिक वैल्यू Bearer के बजाय, BearerToken वैल्यू वाला टोकन दिखेगा. इस एपीआई का इस्तेमाल करते समय, token_type के इस अमान्य जवाब की वजह से, Access denied की गड़बड़ी हो सकती है.

इस समस्या को ठीक करने के लिए, JavaScript याassignMessage नीति बनाएं. इससे नीति के आउटपुट को नियमों के हिसाब से फ़ॉर्मैट में बदला जा सकता है. ज़्यादा जानकारी के लिए, RFC का पालन न करने वाला व्यवहार देखें.