इस पेज का अनुवाद Cloud Translation API से किया गया है.

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

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

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

एपीआई पब्लिश करने की सुविधा के बारे में खास जानकारी

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

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

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

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

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

SmartDocs (OpenAPI)
GraphQL एक्सप्लोरर

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

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

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

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

SmartDocs (OpenAPI)

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

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

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

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

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

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

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

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

पोर्टल में ग्राफ़QL एक्सप्लोरर

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

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

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

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

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

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

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

"इस एपीआई को आज़माएं" के साथ काम करने के लिए, अपना एपीआई प्रॉक्सी कॉन्फ़िगर करें

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

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

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

ऑथराइज़ेशन ऐक्सेस नीति को कॉन्फ़िगर करने से जुड़ी ज़रूरी शर्तें

कोई नहीं या एपीआई पासकोड अपने एपीआई प्रॉक्सी में सीओआरएस से जुड़ी सहायता जोड़ें. सुविधा के लिए, GitHub पर दिए गए सीओआरएस के सैंपल समाधान का इस्तेमाल करें या एपीआई प्रॉक्सी में सीओआरएस सपोर्ट जोड़ना में बताए गए तरीके का पालन करें.

पुष्टि करने का बुनियादी तरीका

ऑथराइज़ेशन ऐक्सेस	नीति को कॉन्फ़िगर करने से जुड़ी ज़रूरी शर्तें
कोई नहीं या एपीआई पासकोड	अपने एपीआई प्रॉक्सी में सीओआरएस से जुड़ी सहायता जोड़ें. सुविधा के लिए, 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` को डिफ़ॉल्ट `BearerToken` के बजाय `Bearer` पर सेट किया गया हो.

यह तरीका अपनाएं:

अपने एपीआई प्रॉक्सी में सीओआरएस से जुड़ी सहायता जोड़ें. सुविधा के लिए, 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 को डिफ़ॉल्ट BearerToken के बजाय Bearer पर सेट किया गया हो.

एपीआई कैटलॉग को एक्सप्लोर करें

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

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

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

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

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

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

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

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

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

एपीआई के रेफ़रंस से जुड़े दस्तावेज़ का कॉन्टेंट और पोर्टल पर इसकी जानकारी कॉन्फ़िगर करें:

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

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

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

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

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

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

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

आइकॉन और मैसेज से पता चलता है कि स्नैपशॉट मौजूदा समय का है

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ध्यान दें: एपीआई प्रॉडक्ट कार्ड में 320x192 पिक्सल या आसपेक्ट रेशियो (लंबाई-चौड़ाई का अनुपात) में इमेज दिखती हैं 5x3 का साइज़. इमेज के डिस्टॉर्शन से बचने के लिए, इमेज को इस साइज़ में फ़ॉर्मैट करें.
सेव करें पर क्लिक करें.

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

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

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

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

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

दिखने वाले टाइटल और ब्यौरे में बदलाव करें

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

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

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

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

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

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

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

कैटगरी पेज को एक्सप्लोर करना

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

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

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

कैटगरी टैब, जिसमें कैटगरी का नाम, असाइन किए गए एपीआई के नाम, और उनकी कुल संख्या दिखती है

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

गड़बड़ी: 'ऐक्सेस-कंट्रोल-अनुमति दें-मूल' हेडर में कई वैल्यू ', ' हैं, लेकिन सिर्फ़ एक वैल्यू का इस्तेमाल किया जा सकता है

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

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

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

<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

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

गड़बड़ी: OAuth2 का इस्तेमाल करके एपीआई प्रॉक्सी को कॉल करते समय ऐक्सेस नहीं दिया गया

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

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