برنامه افزودنی تأیید اعتبار 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
}

خط‌مشی AssignMessage زیر مقدار پاسخ را از خط‌مشی ExtensionCallout بازیابی کرده و آن را در payload پاسخ کپی می‌کند. این می‌تواند برای اشکال‌زدایی مفید باشد. در عمل، ممکن است نخواهید توکن را به کلاینت برگردانید.

<?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، نحوه تنظیم و استفاده از یک توکن ذخیره شده برای فراخوانی API ترجمه گوگل با استفاده از سیاست ServiceCallout را نشان می‌دهد. هر نمونه کد در اینجا برای یک سیاست متفاوت در جریان است.

سیاست‌های زیر به ترتیبی که توسط XML جریان زیر شرح داده شده است، اجرا می‌شوند:

  <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. سیاست LookupCache زیر تلاش می‌کند تا یک توکن را از حافظه پنهان دریافت کند. اگر توکن قبلاً دریافت و ذخیره شده باشد، این سیاست آن را برای استفاده توسط پروکسی API دریافت می‌کند.

     <?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. اگر جستجوی حافظه پنهان، توکن ذخیره‌شده‌ای را بازیابی نکند، سیاست ExtensionCallout زیر یک توکن OAuth جدید بازیابی می‌کند و API ترجمه Google Cloud را به عنوان محدوده توکن مشخص می‌کند. اگر اعتبارنامه‌های حساب سرویس استفاده‌شده هنگام پیکربندی افزونه Google-Auth-Callout نشان‌دهنده عضوی از پروژه باشد که به API دسترسی دارد، 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. پس از اینکه سیاست ExtensionCallout یک توکن جدید را بازیابی کرد، سیاست PopulateCache آن را برای استفاده بعدی توسط سیاست‌های موجود در پروکسی API، در حافظه پنهان (cache) ذخیره می‌کند.

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

مثال: آدرس تابع ابری

در مثال زیر، اکشن getOauth2AccessToken افزونه، یک توکن را برای استفاده در درخواست‌های ارسالی به Cloud Translation API بازیابی می‌کند.

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

مثال: شناسه کلاینت امن‌شده با IAP ابری

در مثال زیر، اکشن getOauth2AccessToken افزونه، یک توکن را برای استفاده در درخواست‌های ارسالی به Cloud Translation API بازیابی می‌کند.

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