OAuth ile hesap bağlama (Dialogflow)

OAuth bağlantı türü, iki endüstri standardı OAuth 2.0 akışını destekler: dolaylı. ve yetkilendirme kod akışları kullanılır.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
• The token exchange endpoint, which is responsible for two types of exchanges:
  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Note: Please choose which OAuth2 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

OAuth hesap bağlamayı uygulayın

Not: Finansal bilgileri işlemek için hesap bağlamayı uyguluyorsanız İşleminiz için ek politikaların geçerli olabileceğini unutmayın. Yaklaşık altı saat sonra haftalar alabilir. Dolayısıyla, finansal bilgiler için hesap bağlama içeren bir İşlemi yayın planınızı planlarken de bu zamanı hesaba katın. İncelemeyi kolaylaştırmak için mali hizmetler politikalarına uyduğunuzdan emin olun .

Projeyi yapılandırma

Projenizi OAuth hesap bağlamayı kullanacak şekilde yapılandırmak için şu adımları uygulayın:

1. Actions Console'u açın ve kullanmak istediğiniz projeyi seçin.
2. Geliştir sekmesini tıklayıp Hesap bağlama'yı seçin.
3. Hesap bağlama'nın yanındaki anahtarı etkinleştirin.
4. Hesap oluşturma bölümünde Hayır, yalnızca web sitemde hesap oluşturulmasına izin vermek istiyorum'u seçin.

5. Bağlantı türü bölümünde OAuth ve Dolaylı'yı seçin.

   

6. Müşteri Bilgileri bölümünde:

   • Aşağıdakileri belirlemek için Actions'ınız tarafından Google'a verilen Client-ID'ye Google'dan gelen isteklerle karşılaşıyorum.
   • Yetkilendirme ve Token Exchange uç noktalarınızın URL'lerini ekleyin.

ziyaret edin. .

Not: İstemci kimliğinizin base64 kodlu bir dizesinin yanındaki açılır oku tıklayın, İstemcinizi yapılandırın (isteğe bağlı) ClientID ve sırrı HTTP Basic üzerinden aktarmak için Google'ın kutusunu işaretleyin kimlik doğrulama üstbilgisi.

6. Kaydet'i tıklayın.

OAuth sunucunuzu uygulama

OAuth 2.0 örtülü akışını desteklemek için hizmetiniz bir yetkilendirme yapar uç nokta ile kullanılabilir. Bu uç nokta, kimlik doğrulama ve güvenlikten ve verilere erişim için kullanıcılardan izin alınması gerekir. Yetkilendirme uç noktası Henüz oturum açmamış kullanıcılarınıza bir oturum açma kullanıcı arayüzü sunar ve istenen erişim için izin verin.

İşleminizin, hizmetinizin yetkili API'lerinden birini çağırması gerektiğinde Google, API'leri kendi cihazlarında çağırmak için bu uç noktayı anlamına gelir.

Google tarafından başlatılan tipik bir OAuth 2.0 örtülü akış oturumunda, takip eden akış:

1. Google, yetkilendirme uç noktanızı kullanıcının tarayıcısında açar. İlgili içeriği oluşturmak için kullanılan kullanıcı oturum açmış değilse oturum açar ve Google'a erişim için izin verir izin vermedilerse verilerini API'nizle birlikte göndermelerini isteyin.
2. Hizmetiniz bir erişim jetonu oluşturur ve bu jetonu Kullanıcının tarayıcısını erişim jetonuyla tekrar Google'a yönlendirerek Google ekleyebilirsiniz.
3. Google, hizmetinizin API'lerini çağırır ve erişim jetonunu dikkat edin. Hizmetiniz, erişim jetonunun Google'a ve ardından API çağrısını tamamlar.

Yetkilendirme isteklerini işleme

İşleminizin OAuth2 örtülü akışı üzerinden hesap bağlama yapması gerektiğinde Google, kullanıcıyı yetkilendirme uç noktanıza şunu içeren bir istekle gönderir: şu parametrelere sahip olursunuz:

Yetkilendirme uç noktası parametreleri
client_id	Google'a atadığınız istemci kimliği.
redirect_uri	Bu isteğe yanıt gönderdiğiniz URL.
state	yönlendirme URI'si.
response_type	Yanıtta döndürülecek değerin türü. OAuth 2.0 dolaylı için akışında, yanıt türü her zaman token olur.

Örneğin, yetkilendirme uç noktanız https://myservice.example.com/auth üzerinde mevcutsa, talep şu şekilde görünebilir:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

Yetkilendirme uç noktanızın oturum açma isteklerini işlemesi için aşağıdaki adımları uygulayın:

1. Aşağıdaki işlemler için client_id ve redirect_uri değerlerini doğrulayın: istenmeyen veya yanlış yapılandırılmış istemci uygulamalarına erişim verilmesini önleyin:

   • client_id değerinin, kullandığınız istemci kimliğiyle eşleştiğini doğrulayın Google'a atanmıştır.
   • redirect_uri tarafından belirtilen URL'yi doğrulayın parametresi aşağıdaki biçimdedir:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

     YOUR_PROJECT_ID, Proje ayarları sayfasında bulunan kimliktir bölümünü içerir.

2. Kullanıcının hizmetinizde oturum açıp açmadığını kontrol edin. Kullanıcı oturum açmamışsa hizmetinizin oturum açma veya kaydolma akışını tamamlayın.

3. Google'ın API'nize erişmek için kullanacağı bir erişim jetonu oluşturun. İlgili içeriği oluşturmak için kullanılan erişim jetonu herhangi bir dize değeri olabilir, ancak jetonun ait olduğu ve tahmin edilememesi gerekir.

4. Kullanıcının tarayıcısını URL'ye yönlendiren bir HTTP yanıtı gönderme redirect_uri parametresiyle belirtilir. Aşağıdakilerin tümünü dahil edin: aşağıdaki parametreleri kullanabilirsiniz:

   • access_token: Az önce oluşturduğunuz erişim jetonu
   • token_type: bearer dizesi
   • state: Orijinal durumdaki değiştirilmemiş durum değeri istek Sonuçta elde edilen URL'nin bir örneği aşağıda verilmiştir:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google'ın OAuth 2.0 yönlendirme işleyicisi, erişim jetonunu alır ve onay verir state değerinin değişmediğinden emin olun. Google, erişim jetonunuz varsa Google, jetonu sonraki çağrılara ekler AppRequest'in bir parçası olarak İşleminize ekleyin.

Kimlik doğrulama akışını başlat

Uyarı: İşleminizle ilgili görüşmenin başında kullanıcılara zorunlu hesap bağlama istemi göndermeyin. Bunun yerine, kimliği doğrulanmamış kullanıcılara işleminizin nasıl çalıştığını göstermek için bir misafir akışı sağlayın ve yalnızca devam etmek için gerekliyse hesap bağlama isteğinde bulunun. Kullanıcılar, hesap bağlama sorunları nedeniyle İşlem'den düzenli olarak ayrılıyorsa Google işlemi etkin bir şekilde tanıtmaz. Bu da işlemin kullanıcı trafiğini azaltabilir.

Hesapta Oturum Açma yardımcı amacını kullanma kimlik doğrulama akışını başlatın. Aşağıdaki kod snippet'lerinde bu yardımcıyı kullanmak için Dialogflow'da ve Actions SDK'sında yanıt gönderin.

Dialogflow:

Node.js

const {dialogflow, SignIn} = require('actions-on-google');
const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('Start Signin', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

Java

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

JSON

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "PLACEHOLDER"
            }
          }
        ]
      },
      "userStorage": "{\"data\":{}}",
      "systemIntent": {
        "intent": "actions.intent.SIGN_IN",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
          "optContext": "To get your account details"
        }
      }
    }
  },
  "outputContexts": [
    {
      "name": "/contexts/_actions_on_google",
      "lifespanCount": 99,
      "parameters": {
        "data": "{}"
      }
    }
  ]
}

İşlemler SDK'sı:

Node.js

const {actionssdk, SignIn} = require('actions-on-google');
const app = actionssdk({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('actions.intent.TEXT', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

Java

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

JSON

{
  "expectUserResponse": true,
  "expectedInputs": [
    {
      "inputPrompt": {
        "richInitialPrompt": {
          "items": [
            {
              "simpleResponse": {
                "textToSpeech": "PLACEHOLDER"
              }
            }
          ]
        }
      },
      "possibleIntents": [
        {
          "intent": "actions.intent.SIGN_IN",
          "inputValueData": {
            "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
            "optContext": "To get your account details"
          }
        }
      ]
    }
  ],
  "conversationToken": "{\"data\":{}}",
  "userStorage": "{\"data\":{}}"
}

Veri erişimi isteklerini işleme

Asistan isteği bir erişim jetonu içeriyorsa: Öncelikle erişim jetonunun geçerli olduğundan (ve süresinin dolmadığından) emin olun, ardından ilişkili kullanıcı hesabını veritabanınızdan alın.