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

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

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

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

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

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

पोर्टल पर क्या पब्लिश किया गया है?

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

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

• स्मार्ट दस्तावेज़ (ओपनएपीआई)
• ग्राफ़क्यूएल एक्सप्लोरर

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

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

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

स्मार्ट दस्तावेज़ (ओपनएपीआई)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

"यह एपीआई आज़माएं" की सुविधा देने के लिए अपना एपीआई प्रॉक्सी कॉन्फ़िगर करें

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

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

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

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

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

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 पर क्लिक करें.

   इमेज के बारे में जानकारी देते समय, कैटलॉग आइटम के लिए इस्तेमाल किए गए बाहरी यूआरएल वाली इमेज या पोर्टल में सेव की गई इमेज फ़ाइलों के लिए फ़ाइल पाथ बताएं, उदाहरण के लिए, /files/book-tree.jpg. किसी बाहरी इमेज का यूआरएल देते समय, इमेज आपकी एसेट पर अपलोड नहीं की जाएगी. इसके अलावा, इंटिग्रेट किए गए पोर्टल में इमेज लोड होने पर, उपलब्ध हो जाएगी. कॉन्टेंट की सुरक्षा से जुड़ी नीतियों के तहत, इस इमेज को ब्लॉक किया जा सकता है या इस पर पाबंदी लगाई जा सकती है.

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 गड़बड़ी दिखती है, तो ये संभावित वजहें हो सकती हैं और इन्हें ठीक किया जा सकता है:

• मिक्स कॉन्टेंट की गड़बड़ियों के लिए, swagger-ui की जानी-पहचानी समस्या की वजह से गड़बड़ी हो सकती है. इसका एक संभावित हल यह पक्का करना है कि आप अपने 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> का इस्तेमाल करने के लिए, Assignments मैसेज नीति में बदलाव करें. इस जानकारी को नीचे दिए गए अंश में दिखाया गया है. ज़्यादा जानकारी के लिए, यह कम्यूनिटी लेख पढ़ें.

<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 का पालन न करने वाली कुछ प्रॉपर्टी शामिल हैं. उदाहरण के लिए, इस नीति से RFC के मुताबिक सही वैल्यू Bearer के बजाय, BearerToken वैल्यू वाला टोकन दिखेगा. token_type के इस अमान्य जवाब की वजह से, इस एपीआई का इस्तेमाल करते समय Access denied की गड़बड़ी हो सकती है.

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