Google ऑथेंटिकेशन एक्सटेंशन

ऐक्सेस टोकन पाना

यहां दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, टोकन को हासिल करती है, ताकि Cloud Translation API के अनुरोध में इस्तेमाल किया जा सके.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-Access-Token">
    <DisplayName>Get Access Token</DisplayName>
    <Connector>google-auth</Connector>
    <Action>getOauth2AccessToken</Action>
    <Input><![CDATA[{
      "scope" : [
        "https://www.googleapis.com/auth/cloud-translation"
      ]
    }]]></Input>
    <Output>google.credentials</Output>
</ConnectorCallout>

रिस्पॉन्स वैल्यू कुछ इस तरह दिखती है:

{
  "access_token":"ya29.c.ElpSB...BMgkALBJ0kou-8",
  "token_type":"Bearer",
  "expiresInSec": 3600
}

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Retrieve-Auth-Token">
    <DisplayName>Retrieve Auth Token</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{google.credentials.access_token}</Payload>
    </Set>
</AssignMessage>

ऐक्सेस टोकन को कैश मेमोरी में सेव करना

टोकन को फिर से पाने के लिए बेवजह कॉल करने से बचने के लिए, उस टोकन को कैश मेमोरी में सेव करें. अगर बार-बार टोकन की ज़रूरत पड़ती है, तो Apigee Edge की कैश मेमोरी से टोकन वापस पाने पर, नया टोकन पाने में कम समय लगेगा. कैश मेमोरी में सेव किए गए टोकन की समयसीमा खत्म होने पर, नया टोकन वापस पाएं और उसकी मदद से कैश मेमोरी को रीफ़्रेश करें.

API प्रॉक्सी के उदाहरण में दिया गया नीचे दिया गया कोड, कैश मेमोरी में सेव किए गए टोकन को सेट करने और उसका इस्तेमाल करने का तरीका बताता है. इसकी मदद से, Google Translation API को ServiceCallout नीति के साथ कॉल किया जा सकता है. यहां उदाहरण के तौर पर दिया गया हर कोड, फ़्लो की अलग-अलग नीति के बारे में है.

इन नीतियों को नीचे दिए गए फ़्लो एक्सएमएल में बताए गए क्रम के मुताबिक लागू किया जाता है:

  <Request>
    <!-- Attempt to get a token from the cache. -->
    <Step>
        <Name>Get-Cached-Auth-Token</Name>
    </Step>
    <!-- Only execute the following ExtensionCallout policy if the call to the
      cache couldn't retrieve a cached token. -->
    <Step>
        <Name>Google-Auth-Callout</Name>
        <Condition>lookupcache.Get-Cached-Auth-Token.cachehit is false</Condition>
    </Step>
    <!-- Only execute the following PopulateCache policy if the call to the
      cache couldn't retrieve a cached token. -->
    <Step>
        <Name>Cache-Auth-Token</Name>
        <Condition>lookupcache.Get-Cached-Auth-Token.cachehit is false</Condition>
    </Step>
    <!-- Use the ServiceCallout policy to call the translate API. -->
    <Step>
        <Name>Translate-Text</Name>
    </Step>
</Request>

1. नीचे दी गई lookupकैश नीति, कैश मेमोरी से टोकन पाने की कोशिश करती है. अगर टोकन को पहले ही हासिल और कैश मेमोरी में सेव कर लिया गया है, तो नीति इसे एपीआई प्रॉक्सी के इस्तेमाल के लिए इस्तेमाल करेगी.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <LookupCache async="false" continueOnError="false" enabled="true" name="Get-Cached-Auth-Token">
         <DisplayName>Get Cached Auth Token</DisplayName>
         <!-- Give cache key and scope to specify the entry for the cached token. -->
         <CacheKey>
             <Prefix/>
             <KeyFragment>gcp_translate_token_</KeyFragment>
         </CacheKey>
         <Scope>Exclusive</Scope>
         <!-- Assign the retrieved token (if any) to a variable, where it
          can be retrieved by policies. -->
         <AssignTo>cloud.translation.auth.token</AssignTo>
     </LookupCache>
   

2. अगर कैश लुकअप को, कैश मेमोरी में सेव किए गए टोकन को वापस नहीं लाया जाता है, तो नीचे दी गई एक्सटेंशन कॉलआउट नीति एक नया OAuth टोकन वापस लाती है. इसमें, Google Cloud Translation API को टोकन के स्कोप के तौर पर बताया जाता है. अगर Google-Auth-Callout एक्सटेंशन को कॉन्फ़िगर करते समय इस्तेमाल किए गए सेवा खाते के क्रेडेंशियल, प्रोजेक्ट के किसी ऐसे सदस्य की जानकारी देते हैं जिसके पास एपीआई का ऐक्सेस है, तो Google Cloud मान्य टोकन दिखाता है.

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Google-Auth-Callout">
         <DisplayName>Google-Auth-Callout</DisplayName>
         <Connector>example-auth-extension</Connector>
         <Action>getOauth2AccessToken</Action>
         <Input><![CDATA[{
           "scope" : ["https://www.googleapis.com/auth/cloud-translation"]
         }]]></Input>
         <Output parsed="false">cloud.translation.auth.token</Output>
     </ConnectorCallout>
   

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

     <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <PopulateCache async="false" continueOnError="false" enabled="true" name="Cache-Auth-Token">
         <DisplayName>Cache Auth Token</DisplayName>
         <Properties/>
         <!-- Set cache key information to specify a unique key for this entry. -->
         <CacheKey>
             <Prefix/>
             <KeyFragment>gcp_translate_token_</KeyFragment>
         </CacheKey>
         <Scope>Exclusive</Scope>
         <ExpirySettings>
             <TimeoutInSec>5</TimeoutInSec>
         </ExpirySettings>
         <!-- Get the token to cache from the variable where the ExtensionCallout put it. -->
         <Source>cloud.translation.auth.token</Source>
     </PopulateCache>
   

सिंटैक्स

<Action>getOauth2AccessToken</Action>
<Input><![CDATA[{
  "scope" : [
    "scope1",
    "scope2"
  ]
}]]></Input>

उदाहरण

यहां दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, टोकन को हासिल करती है, ताकि Cloud Translation API के अनुरोध में इस्तेमाल किया जा सके.

<Action>getOauth2AccessToken</Action>
<Input><![CDATA[{
    "scope" : [
      "https://www.googleapis.com/auth/cloud-translation"
  ]
}]]></Input>

सिंटैक्स

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
    "audience" : "audience"
}]]></Input>

उदाहरण: Cloud फ़ंक्शन का यूआरएल

यहां दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, टोकन को हासिल करती है, ताकि Cloud Translation API के अनुरोध में इस्तेमाल किया जा सके.

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
  "audience" : "https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/FUNCTION_NAME"
}]]></Input>

उदाहरण: Cloud IAP-सुरक्षित क्लाइंट आईडी

यहां दिए गए उदाहरण में, एक्सटेंशन की getOauth2AccessToken कार्रवाई, टोकन को हासिल करती है, ताकि Cloud Translation API के अनुरोध में इस्तेमाल किया जा सके.

<Action>getJWTAccessToken</Action>
<Input><![CDATA[{
  "audience" : "Cloud-IAP-secured-client-ID"
}]]></Input>