VerificationAPIKey की नीति

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

क्या

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

सैंपल

क्वेरी पैरामीटर डालें

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.queryparam.apikey" />
</VerifyAPIKey>

इस उदाहरण में, नीति को request.queryparam.apikey नाम के फ़्लो वैरिएबल में एपीआई पासकोड मिलना चाहिए. वैरिएबल request.queryparam.{name} एक स्टैंडर्ड Edge फ़्लो वैरिएबल है. इसे क्लाइंट अनुरोध में पास की गई क्वेरी पैरामीटर की वैल्यू से पॉप्युलेट किया जाता है.

यहां दिया गया 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} एक स्टैंडर्ड Edge फ़्लो वैरिएबल है. इसे क्लाइंट अनुरोध में पास किए गए हेडर की वैल्यू से पॉप्युलेट किया जाता है.

यहां दिए गए cURL में, हेडर में एपीआई पासकोड पास करने का तरीका बताया गया है:

curl "http://myorg-test.apigee.net/mocktarget" -H "x-apikey:IEYRtW2cb7A5Gs54A1wKElECBL65GVls"

वैरिएबल में की

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="requestAPIKey.key"/>
</VerifyAPIKey>

नीति में, उस वैरिएबल का रेफ़रंस दिया जा सकता है जिसमें कुंजी शामिल हो. इस उदाहरण में दी गई नीति, requestAPIKey.key नाम के वैरिएबल से एपीआई पासकोड निकालती है.

उस वैरिएबल को पॉप्युलेट करने का तरीका आपके हिसाब से तय किया जा सकता है. उदाहरण के लिए, myKey नाम के क्वेरी पैरामीटर से requestAPIKey.key को पॉप्युलेट करने के लिए, वैरिएबल निकालने की नीति का इस्तेमाल किया जा सकता है. इसके लिए, यहां दिया गया तरीका अपनाएं:

<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 अपने-आप एक उपभोक्ता कुंजी और गुप्त कुंजी का जोड़ा जनरेट करता है. 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

नीति का अंदरूनी नाम. name एट्रिब्यूट की वैल्यू ये काम कर सकती है: अक्षरों, संख्याओं, स्पेस, हाइफ़न, अंडरस्कोर, और फ़ुलस्टॉप को शामिल करें. यह मान नहीं हो सकता 255 वर्णों से ज़्यादा होने चाहिए.

इसके अलावा, नीति को लेबल करने के लिए, <DisplayName> एलिमेंट का इस्तेमाल करें प्रबंधन यूज़र इंटरफ़ेस (यूआई) प्रॉक्सी एडिटर को अलग, आम भाषा में इस्तेमाल करने वाले नाम के साथ किया जा सकता है.

 लागू नहीं ज़रूरी है
continueOnError

किसी नीति के काम न करने पर, गड़बड़ी दिखाने के लिए false पर सेट करें. यह उम्मीद है व्यवहार की जानकारी देने वाला डेटा.

नीति के लागू होने के बाद भी फ़्लो को एक्ज़ीक्यूट करने के लिए, इसे true पर सेट करें विफल होता है.

 गलत वैकल्पिक
enabled

नीति को लागू करने के लिए, true पर सेट करें.

नीति को बंद करने के लिए, false पर सेट करें. नीति लागू किया जाता है, भले ही वह किसी फ़्लो से जुड़ा रहता हो.

 सही वैकल्पिक
async

यह एट्रिब्यूट अब काम नहीं करता.

 गलत बहिष्कृत

&lt;DisplayName&gt; एलिमेंट

इस कॉलम में नीति को लेबल करने के लिए, name एट्रिब्यूट के साथ-साथ इस्तेमाल करें मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) प्रॉक्सी एडिटर, जिसका नाम अलग और सामान्य भाषा में है.

<DisplayName>Policy Display Name</DisplayName>
डिफ़ॉल्ट

लागू नहीं

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

<APIKey> एलिमेंट

यह एलिमेंट, उस फ़्लो वैरिएबल की जानकारी देता है जिसमें एपीआई पासकोड शामिल होता है. आम तौर पर, क्लाइंट एपीआई कुंजी को क्वेरी पैरामीटर, एचटीटीपी हेडर या फ़ॉर्म पैरामीटर में भेजता है. उदाहरण के लिए, अगर कुंजी को x-apikey नाम वाले हेडर में भेजा जाता है, तो कुंजी वैरिएबल में मिलेगी: request.header.x-apikey

डिफ़ॉल्ट NA
मौजूदगी ज़रूरी है
टाइप स्ट्रिंग

विशेषताएं

नीचे दी गई टेबल में, <APIKey> एलिमेंट के एट्रिब्यूट के बारे में बताया गया है

एट्रिब्यूट ब्यौरा डिफ़ॉल्ट मौजूदगी
ref

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

 लागू नहीं ज़रूरी है

उदाहरण

इन उदाहरणों में, पासकोड को पैरामीटर और 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 से मिले) के साथ कॉन्फ़िगर किया गया है, तो एपीआई प्रॉडक्ट वैरिएबल अपने-आप पॉप्युलेट हो जाते हैं. एपीआई प्रॉडक्ट सेट अप करने के निर्देशों के लिए, एपीआई पब्लिश करने के लिए Edge मैनेजमेंट एपीआई का इस्तेमाल करना लेख पढ़ें.

ऐप्लिकेशन फ़्लो के वैरिएबल

ऐप्लिकेशन की जानकारी वाले इन फ़्लो वैरिएबल को नीति से पॉप्युलेट किया जाता है. इन सभी वैरिएबल के आगे यह प्रीफ़िक्स होता है:

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 डेवलपर का स्टेटस, जैसे कि चालू, बंद या login_lock.
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
ऐप्लिकेशन के मालिक का स्टेटस, जैसे कि चालू, बंद या login_lock.
created_at कंपनी बनाने की तारीख/टाइमस्टैंप.
created_by कंपनी बनाने वाले उपयोगकर्ता का ईमेल पता.
last_modified_at कंपनी में आखिरी बार बदलाव किए जाने की तारीख/टाइमस्टैंप.
last_modified_by कंपनी में आखिरी बार बदलाव करने वाले उपयोगकर्ता का ईमेल पता.
{company_custom_attributes} कंपनी का कोई कस्टम एट्रिब्यूट. कस्टम एट्रिब्यूट का नाम बताएं.

Analytics वैरिएबल

मान्य एपीआई पासकोड के लिए, एपीआई पासकोड की पुष्टि करने की नीति लागू होने पर, Analytics में ये वैरिएबल अपने-आप पॉप्युलेट हो जाते हैं. ये वैरिएबल, सिर्फ़ एपीआई पासकोड की पुष्टि करने की नीति और 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 इस नीति के तहत एपीआई पासकोड को उस वैरिएबल में ढूंढा जाना चाहिए जो नीति के &lt;APIKey&gt; तत्व के रूप में सेट है. यह गड़बड़ी तब आती है, जब वैरिएबल मौजूद नहीं है (इसे रिज़ॉल्व नहीं किया जा सकता).
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>

मिलते-जुलते विषय