VerificationAPIKey की नीति

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

क्या

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

सैंपल

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

curl http://myorg-test.apigee.net/mocktarget?apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.header.x-apikey" />
</VerifyAPIKey>

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

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

<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>

verifyapikey.{policy_name}

एपीआई पासकोड की पुष्टि करने की नीति के बारे में जानकारी

जब कोई डेवलपर 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">

The following table describes attributes that are common to all policy parent elements:

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language 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

उपलब्ध वैरिएबल में ये शामिल हैं:

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

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

verifyapikey.{policy_name}.app.

उदाहरण के लिए:

verifyapikey.{policy_name}.app.name

उपलब्ध वैरिएबल में ये शामिल हैं:

डेवलपर फ़्लो वैरिएबल

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

verifyapikey.{policy_name}.developer

उदाहरण के लिए:

verifyapikey.{policy_name}.developer.id

उपलब्ध वैरिएबल में ये शामिल हैं:

कंपनी फ़्लो वैरिएबल

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

verifyapikey.{policy_name}.company

उदाहरण के लिए:

verifyapikey.{policy_name}.company.name

उपलब्ध वैरिएबल में ये शामिल हैं:

Analytics वैरिएबल

मान्य एपीआई पासकोड के लिए, एपीआई पासकोड की पुष्टि करने की नीति लागू होने पर, Analytics में ये वैरिएबल अपने-आप पॉप्युलेट हो जाते हैं. ये वैरिएबल, सिर्फ़ एपीआई पासकोड की पुष्टि करने की नीति और OAuth की नीतियों से अपने-आप पॉप्युलेट होते हैं.

वैरिएबल और वैल्यू का इस्तेमाल, Analytics रिपोर्ट बनाने के लिए डाइमेंशन के तौर पर किया जा सकता है. इससे, डेवलपर और ऐप्लिकेशन के इस्तेमाल के पैटर्न के बारे में जानकारी मिलती है.

• apiproduct.name
• developer.app.name
• client_id
• developer.id

गड़बड़ी का रेफ़रंस

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error responses

{  
   "fault":{  
      "faultstring":"Invalid ApiKey",
      "detail":{  
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{  
   "fault":{  
      "detail":{  
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

Example fault rule

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

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