आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
इस पेज पर जाएं
Apigee X दस्तावेज़. जानकारी
क्या
'एपीआई पासकोड की पुष्टि करें' नीति की मदद से, रनटाइम के दौरान एपीआई पासकोड की पुष्टि की सुविधा लागू की जा सकती है. जिन ऐप्लिकेशन के पास एपीआई पासकोड अनुमति वाली हैं वे आपके एपीआई ऐक्सेस करते हैं. यह नीति पक्का करती है कि एपीआई पासकोड मान्य हैं, निरस्त नहीं किया गया है और उसे आपके एपीआई से जुड़े खास संसाधनों का इस्तेमाल करने की मंज़ूरी मिली है प्रॉडक्ट.
सैंपल
क्वेरी पैरामीटर में कुंजी
<VerifyAPIKey name="APIKeyVerifier"> <APIKey ref="request.queryparam.apikey" /> </VerifyAPIKey>
इस उदाहरण में, नीति के मुताबिक एपीआई पासकोड को एक फ़्लो वैरिएबल में ढूंढना है
request.queryparam.apikey
. वैरिएबल request.queryparam.{name}
एक स्टैंडर्ड एज फ़्लो वैरिएबल होता है, जो पास किए गए क्वेरी पैरामीटर की वैल्यू से अपने-आप भर जाता है
का विकल्प होता है.
यह curl
निर्देश, क्वेरी पैरामीटर में एपीआई पासकोड को पास करता है:
curl http://myorg-test.apigee.net/mocktarget?apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVlsअभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
हेडर में कुंजी
<VerifyAPIKey name="APIKeyVerifier"> <APIKey ref="request.header.x-apikey" /> </VerifyAPIKey>
इस उदाहरण में, नीति के मुताबिक एपीआई पासकोड को एक फ़्लो वैरिएबल में ढूंढना है
request.header.x-apikey
. वैरिएबल request.header.{name}
एक स्टैंडर्ड एज फ़्लो वैरिएबल होता है, जो पास किए गए हेडर की वैल्यू से अपने-आप भर जाता है
का विकल्प होता है.
यहां दिया गया cURL हेडर में एपीआई पासकोड पास करने का तरीका बताता है:
curl "http://myorg-test.apigee.net/mocktarget" -H "x-apikey:IEYRtW2cb7A5Gs54A1wKElECBL65GVls"अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
वैरिएबल में कुंजी
<VerifyAPIKey name="APIKeyVerifier"> <APIKey ref="requestAPIKey.key"/> </VerifyAPIKey>
यह नीति ऐसे किसी भी वैरिएबल का रेफ़रंस दे सकती है जिसमें कुंजी होती है. इस उदाहरण में मौजूद नीति requestAPIKey.key नाम के वैरिएबल से, एपीआई पासकोड को एक्सट्रैक्ट करता है.
यह वैरिएबल भरने का तरीका आप पर निर्भर करता है. उदाहरण के लिए, एक्सट्रैक्ट क्वेरी पैरामीटर से requestAPIKey.key को भरने के लिए, वैरिएबल की नीति जिसका नाम myKey है, जैसा कि दिखाया गया है नीचे दिया गया है:
<ExtractVariables async="false" continueOnError="false" enabled="true" name="SetAPIKeyVar"> <Source>request</Source> <QueryParam name="myKey"> <Pattern ignoreCase="true">{key}</Pattern> </QueryParam> <VariablePrefix>requestAPIKey</VariablePrefix> <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables> </ExtractVariables>
पॉलिसी फ़्लो वैरिएबल को ऐक्सेस करें
<AssignMessage async="false" continueOnError="false" enabled="true" name="accessverifyvars"> <AssignVariable> <Name>devFirstName</Name> <Ref>verifyapikey.verify-api-key.developer.firstName</Ref> <Value>ErrorOnCopy</Value> </AssignVariable> <AssignVariable> <Name>devLastName</Name> <Ref>verifyapikey.verify-api-key.developer.lastName</Ref> <Value>ErrorOnCopy</Value> </AssignVariable> <AssignVariable> <Name>devEmail</Name> <Ref>verifyapikey.verify-api-key.developer.email</Ref> <Value>ErrorOnCopy</Value> </AssignVariable> <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables> <AssignTo createNew="false" transport="http" type="request"/> </AssignMessage>
पुष्टि करें कि एपीआई पासकोड लागू करने पर Edge, फ़्लो वैरिएबल का सेट अपने-आप भर देता है की नीति को पढ़ें. आप इन वैरिएबल का इस्तेमाल करके ऐप्लिकेशन जैसी जानकारी ऐक्सेस कर सकते हैं ऐप्लिकेशन को रजिस्टर करने वाले डेवलपर या कंपनी का नाम, ऐप्लिकेशन आईडी, और जानकारी. इस ऊपर दिए गए उदाहरण में, डेवलपर का नाम और सरनेम ऐक्सेस करने के लिए 'मैसेज असाइन करें' नीति का इस्तेमाल किया जाता है पुष्टि करें एपीआई पासकोड के चालू होने के बाद, उसका नाम और ईमेल पता.
इन सभी वैरिएबल की शुरुआत इनसे जुड़ी होती है:
verifyapikey.{policy_name}
इस उदाहरण में, 'एपीआई पासकोड की पुष्टि करें' नीति का नाम "verify-api-key" है. इसलिए, आपने
ऐक्सेस करके अनुरोध करने वाले डेवलपर का नाम
वैरिएबल verifyapikey.verify-api-key.developer.firstName.
एज सीखें
'एपीआई पासकोड की पुष्टि करें' नीति के बारे में जानकारी
जब कोई डेवलपर Edge पर किसी ऐप्लिकेशन को रजिस्टर करता है, तो Edge अपने-आप एक उपभोक्ता कुंजी जनरेट करता है और सीक्रेट जोड़ा. आपके पास Edge यूज़र इंटरफ़ेस (यूआई) में ऐप्लिकेशन का 'उपभोक्ता कुंजी' और सीक्रेट जोड़ा देखने का विकल्प होता है. इसके अलावा, आप इन्हें ऐक्सेस भी कर सकते हैं से इंस्टॉल किया जा सकता है.
ऐप्लिकेशन रजिस्ट्रेशन के समय, डेवलपर इन कामों के लिए एक या उससे ज़्यादा एपीआई प्रॉडक्ट चुनता है ऐप्लिकेशन से असोसिएट करें, जहां एपीआई प्रॉडक्ट रिसॉर्स का कलेक्शन होता है को एपीआई प्रॉक्सी के ज़रिए ऐक्सेस किया जा सकता है. इसके बाद डेवलपर, एपीआई पासकोड (उपभोक्ता कुंजी) को पूरे डेटा प्लैटफ़ॉर्म के एक हिस्से के तौर पर पास करता है ऐप्लिकेशन से जुड़े एपीआई प्रॉडक्ट में, एपीआई के लिए किया जाने वाला हर अनुरोध. ज़्यादा जानकारी के लिए, पब्लिश करने की खास जानकारी देखें.
एपीआई पासकोड का इस्तेमाल, पुष्टि करने वाले टोकन के तौर पर किया जा सकता है. इसके अलावा, OAuth ऐक्सेस पाने के लिए भी इनका इस्तेमाल किया जा सकता है टोकन. OAuth में, एपीआई पासकोड को "क्लाइंट आईडी" कहा जाता है. दोनों नामों का इस्तेमाल एक-दूसरे की जगह पर किया जा सकता है. ज़्यादा जानकारी के लिए OAuth होम देखें.
'एपीआई पुष्टि करें' नीति लागू करने पर, Edge अपने-आप फ़्लो वैरिएबल का सेट भर देता है. फ़्लो देखें ज़्यादा जानकारी के लिए नीचे दिए गए वैरिएबल के बारे में ज़्यादा जानें.
एलिमेंट का रेफ़रंस
यहां ऐसे एलिमेंट और एट्रिब्यूट दिए गए हैं जिन्हें इस नीति पर कॉन्फ़िगर किया जा सकता है:
<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1"> <DisplayName>Custom label used in UI</DisplayName> <APIKey ref="variable_containing_api_key"/> </VerifyAPIKey>
<VerifyAPIKey> एट्रिब्यूट
नीचे दिए गए उदाहरण में, <VerifyAPIKey>
टैग पर एट्रिब्यूट दिखाए गए हैं:
<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1">
यहां दी गई टेबल में, ऐसे एट्रिब्यूट के बारे में बताया गया है जो नीति के सभी पैरंट एलिमेंट में एक जैसे होते हैं:
एट्रिब्यूट | ब्यौरा | डिफ़ॉल्ट | मौजूदगी |
---|---|---|---|
name |
नीति का अंदरूनी नाम. इसके अलावा, नीति को लेबल करने के लिए, |
लागू नहीं | ज़रूरी है |
continueOnError |
किसी नीति के काम न करने पर, गड़बड़ी दिखाने के लिए नीति के लागू होने के बाद भी फ़्लो को एक्ज़ीक्यूट करने के लिए, इसे |
गलत | वैकल्पिक |
enabled |
नीति को लागू करने के लिए, नीति को बंद करने के लिए, |
सही | वैकल्पिक |
async |
यह एट्रिब्यूट अब काम नहीं करता. |
गलत | बहिष्कृत |
<DisplayName> एलिमेंट
इस कॉलम में नीति को लेबल करने के लिए, name
एट्रिब्यूट के साथ-साथ इस्तेमाल करें
मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) प्रॉक्सी एडिटर, जिसका नाम अलग और सामान्य भाषा में है.
<DisplayName>Policy Display Name</DisplayName>
डिफ़ॉल्ट |
लागू नहीं अगर आप इस एलिमेंट को छोड़ देते हैं, तो नीति की |
---|---|
मौजूदगी | वैकल्पिक |
टाइप | स्ट्रिंग |
<APIKey> एलिमेंट
यह एलिमेंट, उस फ़्लो वैरिएबल के बारे में बताता है जिसमें एपीआई पासकोड शामिल होता है. आम तौर पर, क्लाइंट एपीआई पासकोड भेजता है
का इस्तेमाल क्वेरी पैरामीटर, एचटीटीपी हेडर या फ़ॉर्म पैरामीटर में किया जा सकता है. उदाहरण के लिए, अगर कुंजी किसी हेडर में भेजी जाती है
x-apikey
नाम की कुंजी, वैरिएबल में मिलेगी: request.header.x-apikey
डिफ़ॉल्ट | लागू नहीं |
---|---|
मौजूदगी | ज़रूरी है |
टाइप | स्ट्रिंग |
विशेषताएं
इस टेबल में <APIKey>
एलिमेंट के एट्रिब्यूट के बारे में बताया गया है
एट्रिब्यूट | ब्यौरा | डिफ़ॉल्ट | मौजूदगी |
---|---|---|---|
संदर्भ |
एपीआई पासकोड वाले वैरिएबल का रेफ़रंस. सिर्फ़ एक जगह की जानकारी डालने की अनुमति है नीति के मुताबिक होना चाहिए. |
लागू नहीं | ज़रूरी है |
उदाहरण
इन उदाहरणों में, पैरामीटर और x-apikey
नाम के हेडर में कुंजी को पास किया जाता है.
क्वेरी पैरामीटर के तौर पर:
<VerifyAPIKey name="APIKeyVerifier"> <APIKey ref="request.queryparam.x-apikey"/> </VerifyAPIKey>
एचटीटीपी हेडर के तौर पर:
<VerifyAPIKey name="APIKeyVerifier"> <APIKey ref="request.header.x-apikey"/> </VerifyAPIKey>
एचटीटीपी फ़ॉर्म पैरामीटर के तौर पर:
<VerifyAPIKey name="APIKeyVerifier"> <APIKey ref="request.formparam.x-apikey"/> </VerifyAPIKey>
स्कीमा
फ़्लो वैरिएबल
जब किसी मान्य एपीआई पासकोड पर पुष्टि करने के लिए एपीआई पासकोड से जुड़ी नीति लागू की जाती है, तो Edge फ़्लो के सेट में अपने-आप जानकारी भरता है वैरिएबल. ये वैरिएबल उन नीतियों या कोड के लिए उपलब्ध होते हैं जिन्हें फ़्लो में बाद में लागू किया जाता है और इसका इस्तेमाल अक्सर एपीआई पासकोड के एट्रिब्यूट के आधार पर, कस्टम प्रोसेसिंग के लिए किया जाता है. जैसे, ऐप्लिकेशन का नाम, एपीआई पासकोड का इस्तेमाल, एपीआई पासकोड या कस्टम एट्रिब्यूट को अनुमति देने के लिए किया जाता है.
यह नीति कई अलग-अलग तरह के फ़्लो वैरिएबल को इकट्ठा करती है, जिनमें शामिल हैं:
- सामान्य
- ऐप्लिकेशन
- डेवलपर
- कंपनी
- Analytics
हर तरह के फ़्लो वैरिएबल का प्रीफ़िक्स अलग होता है. उन्हें छोड़कर सभी चर अदिश हैं खास तौर से सरणियों के रूप में दिखाया जाता है.
जनरल फ़्लो वैरिएबल
नीचे दी गई टेबल में वे जनरल फ़्लो वैरिएबल दिए गए हैं जो 'एपीआई पासकोड की पुष्टि करें' नीति से अपने-आप भरे गए हैं. इन सभी वैरिएबल की शुरुआत इनसे जुड़ी होती है:
verifyapikey.{policy_name}
उदाहरण के लिए: verifyapikey.{policy_name}.client_id
उपलब्ध वैरिएबल में ये शामिल हैं:
वैरिएबल | ब्यौरा |
---|---|
client_id |
अनुरोध करने वाले ऐप्लिकेशन से मिली उपभोक्ता कुंजी (यानी एपीआई कुंजी या ऐप्लिकेशन कुंजी). |
client_secret |
उपभोक्ता कुंजी से जुड़ा उपभोक्ता सीक्रेट. |
redirection_uris |
अनुरोध में मौजूद कोई भी रीडायरेक्ट यूआरआई. |
developer.app.id |
अनुरोध करने वाले डेवलपर ऐप्लिकेशन का आईडी. |
developer.app.name |
अनुरोध करने वाले डेवलपर ऐप्लिकेशन का नाम. |
developer.id |
अनुरोध करने वाले ऐप्लिकेशन के मालिक के तौर पर रजिस्टर किए गए डेवलपर का आईडी. |
developer.{custom_attrib_name} |
'ऐप्लिकेशन कुंजी' प्रोफ़ाइल से मिला कोई भी कस्टम एट्रिब्यूट. |
DisplayName |
नीति के <DisplayName> की वैल्यू एट्रिब्यूट की वैल्यू सबमिट करें. |
failed |
"सही" पर सेट करें जब एपीआई पासकोड की पुष्टि नहीं हो पाती. |
{custom_app_attrib} |
ऐप्लिकेशन प्रोफ़ाइल से मिला कोई भी कस्टम एट्रिब्यूट. कस्टम कस्टम नाम का नाम बताएं एट्रिब्यूट की वैल्यू सबमिट करें. |
apiproduct.name* |
अनुरोध की पुष्टि करने के लिए इस्तेमाल किए जाने वाले एपीआई प्रॉडक्ट का नाम. |
apiproduct.{custom_attrib_name}* |
एपीआई प्रॉडक्ट प्रोफ़ाइल से मिला कोई भी कस्टम एट्रिब्यूट. |
apiproduct.developer.quota.limit* |
अगर एपीआई प्रॉडक्ट के लिए कोटा की सीमा तय है, तो वह सीमा तय की गई है. |
apiproduct.developer.quota.interval* |
अगर एपीआई प्रॉडक्ट पर सेट किया गया कोई कोटा इंटरवल है, तो उसे चुनें. |
apiproduct.developer.quota.timeunit* |
अगर एपीआई प्रॉडक्ट पर सेट किया गया कोटा टाइम यूनिट है, तो वह यूनिट. |
* अगर एपीआई प्रॉडक्ट
मान्य एनवायरमेंट, प्रॉक्सी, और संसाधनों के साथ कॉन्फ़िगर किया गया है (इनसे लिया गया है)
proxy.pathsuffix ). एपीआई प्रॉडक्ट सेट अप करने से जुड़े निर्देशों के लिए, यहां देखें
एज का इस्तेमाल करना
एपीआई पब्लिश करने के लिए मैनेजमेंट एपीआई. |
ऐप्लिकेशन फ़्लो वैरिएबल
नीचे दिए गए फ़्लो वैरिएबल में, ऐप्लिकेशन के बारे में जानकारी होती है. इन्हें नीति में शामिल किया जाता है. इन सभी वैरिएबल की शुरुआत इनसे जुड़ी होती है:
verifyapikey.{policy_name}.app
.
उदाहरण के लिए:
verifyapikey.{policy_name}.app.name
उपलब्ध वैरिएबल में ये शामिल हैं:
वैरिएबल | ब्यौरा |
---|---|
name |
ऐप्लिकेशन का नाम. |
id |
ऐप्लिकेशन का आईडी. |
accessType |
Apigee ने इस्तेमाल नहीं किया है. |
callbackUrl |
ऐप्लिकेशन का कॉलबैक यूआरएल. आम तौर पर, इसे सिर्फ़ OAuth के लिए इस्तेमाल किया जाता है. |
DisplayName |
ऐप्लिकेशन का डिसप्ले नेम. |
status |
ऐप्लिकेशन की स्थिति, जैसे कि 'स्वीकार किया गया' या 'रद्द' किया जाता है. |
apiproducts |
ऐप्लिकेशन से जुड़े एपीआई प्रॉडक्ट की सूची वाला कलेक्शन. |
appFamily |
ऐप्लिकेशन वाली कोई भी ऐप्लिकेशन फ़ैमिली या "डिफ़ॉल्ट". |
appParentStatus |
ऐप्लिकेशन के पैरंट ऐप्लिकेशन की स्थिति, जैसे कि 'चालू है' या 'इनऐक्टिव' |
appType |
ऐप्लिकेशन का टाइप, जैसे कि "कंपनी" या "डेवलपर" शामिल है. |
appParentId |
पैरंट ऐप्लिकेशन का आईडी. |
created_at |
ऐप्लिकेशन बनाने की तारीख/समय. |
created_by |
उस डेवलपर का ईमेल पता जिसने ऐप्लिकेशन बनाया है. |
last_modified_at |
ऐप्लिकेशन को आखिरी बार अपडेट किए जाने की तारीख/समय. |
last_modified_by |
उस डेवलपर का ईमेल पता जिसने ऐप्लिकेशन को पिछली बार अपडेट किया था. |
{app_custom_attributes} |
कोई भी कस्टम ऐप्लिकेशन एट्रिब्यूट. कस्टम एट्रिब्यूट का नाम बताएं. |
डेवलपर फ़्लो वैरिएबल
डेवलपर की जानकारी वाले नीचे दिए गए फ़्लो वैरिएबल, की नीति देखें. इन सभी वैरिएबल की शुरुआत इनसे जुड़ी होती है:
verifyapikey.{policy_name}.developerअभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
उदाहरण के लिए:
verifyapikey.{policy_name}.developer.id
उपलब्ध वैरिएबल में ये शामिल हैं:
वैरिएबल | ब्यौरा |
---|---|
id |
{org_name}@@{developer_id} लौटाता है |
userName |
डेवलपर का उपयोगकर्ता नाम. |
firstName |
डेवलपर का नाम |
lastName |
डेवलपर का उपनाम. |
email |
डेवलपर का ईमेल पता. |
status |
डेवलपर की स्थिति, जैसे कि चालू है, इस्तेमाल नहीं किया जा रहा यालॉगिन_लॉक. |
apps |
डेवलपर से जुड़े ऐप्लिकेशन का कलेक्शन. |
created_at |
डेवलपर बनाए जाने की तारीख/समय. |
created_by |
उस उपयोगकर्ता का ईमेल पता जिसने डेवलपर बनाया है. |
last_modified_at |
डेवलपर की आखिरी बार बदलाव किए जाने की तारीख/समय का स्टैंप. |
last_modified_by |
उस उपयोगकर्ता का ईमेल पता जिसने डेवलपर में बदलाव किया है. |
{developer_custom_attributes} |
कोई भी कस्टम डेवलपर एट्रिब्यूट. कस्टम एट्रिब्यूट का नाम बताएं. |
Company |
अगर कोई कंपनी डेवलपर है, तो उसका नाम. |
कंपनी फ़्लो वैरिएबल
कंपनी की जानकारी वाले नीचे दिए गए फ़्लो वैरिएबल में की नीति देखें. इन सभी वैरिएबल की शुरुआत इनसे जुड़ी होती है:
verifyapikey.{policy_name}.companyअभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है
उदाहरण के लिए:
verifyapikey.{policy_name}.company.name
उपलब्ध वैरिएबल में ये शामिल हैं:
वैरिएबल | ब्यौरा |
---|---|
name |
कंपनी का नाम. |
displayName |
कंपनी का डिसप्ले नेम. |
id |
कंपनी का आईडी. |
apps |
कंपनी के ऐप्लिकेशन की सूची वाला कलेक्शन. |
appOwnerStatus |
ऐप्लिकेशन के मालिक की स्थिति: ऐक्टिव, इनऐक्टिव या लॉगिन.
|
created_at |
कंपनी बनाई जाने की तारीख/समय. |
created_by |
कंपनी बनाने वाले उपयोगकर्ता का ईमेल पता. |
last_modified_at |
कंपनी में आखिरी बार बदलाव किए जाने की तारीख/समय का स्टैंप. |
last_modified_by |
कंपनी में आखिरी बार बदलाव करने वाले उपयोगकर्ता का ईमेल पता. |
{company_custom_attributes} |
कंपनी का कोई कस्टम एट्रिब्यूट. कस्टम एट्रिब्यूट का नाम बताएं. |
Analytics वैरिएबल
एपीआई पासकोड की पुष्टि करने से जुड़ी नीति लागू होने पर, नीचे दिए गए वैरिएबल अपने-आप Analytics में भर जाते हैं एक मान्य API कुंजी के लिए लागू किया गया है. ये वैरिएबल सिर्फ़ पुष्टि एपीआई पासकोड से भरे जाते हैं और OAuth नीतियों की शर्तों को पूरा करते हैं.
वैरिएबल और वैल्यू का इस्तेमाल डाइमेंशन के रूप में किया जा सकता है, ताकि Analytics रिपोर्ट बनाई जा सकें डेवलपर और ऐप्लिकेशन के इस्तेमाल के पैटर्न को देखने के लिए.
- apiproduct.name
- developer.app.name
- client_id
- developer.id
गड़बड़ी का रेफ़रंस
इस सेक्शन में, गड़बड़ी के कोड और गड़बड़ी के मैसेज के बारे में बताया गया है. साथ ही, इन गड़बड़ियों के वैरिएबल के बारे में भी बताया गया है, जो Edge की मदद से सेट किए जाते हैं. यह जानकारी जानना ज़रूरी है कि क्या आप गड़बड़ियों को ठीक करता है. ज़्यादा जानने के लिए, आपके लिए ज़रूरी जानकारी देखें नीति से जुड़ी गड़बड़ियों और हैंडलिंग के बारे में जानकारी गलतियां.
रनटाइम की गड़बड़ियां
नीति के लागू होने पर ये गड़बड़ियां हो सकती हैं.
गड़बड़ी कोड | एचटीटीपी कोड स्थिति | वजह |
---|---|---|
keymanagement.service.CompanyStatusNotActive |
401 | आपके इस्तेमाल किए जा रहे एपीआई पासकोड के पास, डेवलपर ऐप्लिकेशन से जुड़ी कंपनी के पास इनऐक्टिव स्थिति. जब किसी कंपनी का स्टेटस 'बंद है' पर सेट होता है, तो आप डेवलपर या उस कंपनी से जुड़े ऐप्लिकेशन. संगठन का एडमिन, कंपनी की स्थिति बदल सकता है मैनेजमेंट एपीआई का इस्तेमाल करके. स्थिति सेट करें देखें कंपनी के मालिक हैं. |
keymanagement.service.DeveloperStatusNotActive |
401 |
जिस डेवलपर ऐप्लिकेशन के पास इस्तेमाल की जा रही एपीआई पासकोड है उसने उसे बनाया है इनऐक्टिव स्थिति. जब किसी ऐप्लिकेशन डेवलपर की स्थिति 'बंद है' पर सेट होती है, तो किसी भी डेवलपर ऐप्लिकेशन को जब उस डेवलपर ने बनाया था, तो उन्हें इस्तेमाल करने की सुविधा बंद कर दी जाती है. खाते का एडमिन, जिसके पास ज़रूरी अनुमतियां हों जैसे, संगठन का एडमिन, डेवलपर का स्टेटस यहां दिए गए विकल्पों में बदल सकता है तरीके:
|
keymanagement.service.invalid_client-app_not_approved |
401 | एपीआई पासकोड से जुड़े डेवलपर ऐप्लिकेशन को रद्द कर दिया गया है. निरस्त किए गए ऐप्लिकेशन को ये काम नहीं करने चाहिए कोई भी एपीआई प्रॉडक्ट ऐक्सेस करें और Apigee Edge से मैनेज किए जाने वाले किसी भी एपीआई को शुरू नहीं कर सकता. संगठन का एडमिन ये काम कर सकता है: मैनेजमेंट एपीआई का इस्तेमाल करके डेवलपर ऐप्लिकेशन की स्थिति बदलने के लिए. देखें डेवलपर ऐप्लिकेशन को मंज़ूरी देना या उसे रद्द करना. |
oauth.v2.FailedToResolveAPIKey |
401 | इस नीति के तहत एपीआई पासकोड को उस वैरिएबल में ढूंढा जाना चाहिए जो नीति के <APIKey> तत्व के रूप में सेट है. यह गड़बड़ी तब आती है, जब वैरिएबल मौजूद नहीं है (इसे रिज़ॉल्व नहीं किया जा सकता). |
oauth.v2.InvalidApiKey |
401 | Edge को एपीआई पासकोड मिला है, लेकिन वह अमान्य है. जब Edge इसकी कुंजी देखता है डेटाबेस, यह अनुरोध में भेजे गए डेटा से पूरी तरह मेल खाना चाहिए. अगर एपीआई ने काम किया पहले, पक्का करें कि कुंजी फिर से जनरेट नहीं की गई थी. अगर कुंजी फिर से जनरेट की गई थी, तो आपको यह गड़बड़ी दिखाई दे सकती है. ज़्यादा जानकारी के लिए, ऐप्लिकेशन रजिस्टर करें और एपीआई मैनेज करें देखें कुंजियां. |
oauth.v2.InvalidApiKeyForGivenResource |
401 | Edge को एपीआई पासकोड मिला है और वह मान्य है; हालांकि, यह स्वीकार की गई कुंजी का इस्तेमाल करता है. |
डिप्लॉयमेंट से जुड़ी गड़बड़ियां
ये गड़बड़ियां तब हो सकती हैं, जब इस नीति वाली प्रॉक्सी को डिप्लॉय किया जाता है.
गड़बड़ी का नाम | वजह |
---|---|
SpecifyValueOrRefApiKey |
<APIKey> एलिमेंट में कोई वैल्यू या कुंजी नहीं बताई गई है. |
गड़बड़ी के वैरिएबल
रनटाइम की गड़बड़ी होने पर ये वैरिएबल सेट किए जाते हैं. ज़्यादा जानकारी के लिए, आपके लिए ज़रूरी जानकारी देखें नीति से जुड़ी गड़बड़ियों के बारे में जानकारी.
वैरिएबल | कहां | उदाहरण |
---|---|---|
fault.name="fault_name" |
fault_name गड़बड़ी का नाम है, जैसा कि ऊपर रनटाइम में गड़बड़ियां टेबल में बताया गया है. गड़बड़ी का नाम, गड़बड़ी के कोड का आखिरी हिस्सा होता है. | fault.name Matches "FailedToResolveAPIKey" |
oauthV2.policy_name.failed |
policy_name, उपयोगकर्ता की ओर से बताया गया उस नीति का नाम है जिसमें गड़बड़ी हुई है. | oauthV2.VK-VerifyAPIKey.failed = true |
गड़बड़ी के रिस्पॉन्स का उदाहरण
{ "fault":{ "faultstring":"Invalid ApiKey", "detail":{ "errorcode":"oauth.v2.InvalidApiKey" } } }
{ "fault":{ "detail":{ "errorcode":"keymanagement.service.DeveloperStatusNotActive" }, "faultstring":"Developer Status is not Active" } }
गड़बड़ी के नियम का उदाहरण
<FaultRule name="FailedToResolveAPIKey"> <Step> <Name>AM-FailedToResolveAPIKey</Name> </Step> <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition> </FaultRule>