OAuth ile hesap bağlama

OAuth bağlantısı türü, iki endüstri standardı OAuth 2.0 akışını (dolaylı ve yetkilendirme kodu akışları) destekler.

在隐式代码流程中，Google 会在用户浏览器中打开您的授权端点。成功登录后，系统会向 Google 返回长期访问令牌。现在，从 Google 助理向你的 Action 发送的每个请求中都包含此访问令牌。

在授权代码流程中，您需要两个端点：

  • 授权端点，该端点负责向尚未登录的用户显示登录界面，并以短期授权代码的形式记录所请求的访问。
  • 令牌交换端点，负责两种类型的交换：
    1. 将授权代码交换为长期刷新令牌和短期访问令牌。用户完成帐号关联流程后，系统会进行这种交换。
    2. 将长期刷新令牌换成短期访问令牌。Google 需要新访问令牌时，由于此令牌已过期，因此会进行此交换。

虽然隐式代码流程的实现更简单，但 Google 建议通过隐式流程发出的访问令牌永远不会过期，因为将令牌过期与隐式流程一起使用会强制用户再次关联其帐号。如果出于安全考虑需要令牌到期，强烈建议您考虑使用身份验证代码流程。

OAuth hesap bağlamayı uygulama

Projeyi yapılandırma

Projenizi OAuth bağlantısı kullanacak şekilde yapılandırmak için aşağıdaki adımları uygulayın:

  1. Actions Console'u açın ve kullanmak istediğiniz projeyi seçin.
  2. Geliştir sekmesini tıklayın ve 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 Yetkilendirme kodu'nu seçin.

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

    • Google'dan gelen istekleri tanımlamak için Google'a yönelik İşlemleriniz tarafından verilen istemci kimliği özelliğine bir değer atayın.
    • Google tarafından İşlemlerinize verilen istemci kimliğinin değerini not edin;
    • Yetkilendirme ve Jeton Değişimi uç noktalarınızın URL'lerini ekleyin.
  1. Kaydet'i tıklayın.

OAuth sunucunuzu uygulama

Yetkilendirme kodu akışının OAuth 2.0 sunucusu uygulaması aşağıdakilerden oluşur: iki uç noktanız vardır. İlk uç nokta kimlik doğrulama uç noktasıdır. Bu, kullanıcılara veri erişimi için kullanıcılardan izin almalarını Yetkilendirme uç noktası, oturum açma bilgilerini sunar. Henüz oturum açmamış ve erişim isteğinde bulundu. İkinci uç nokta ise üçüncü uç noktadır. İşlem kullanıcısını yetkilendiren jetonlar adı verilen şifrelenmiş dizeleri elde etmek için kullanılır hizmetinize erişin.

İşleminizin, hizmetinizin API'lerinden birini çağırması gerektiğinde Google, bu API'leri kullanır noktaları birleştirip kullanıcılarınızdan bu API'leri anlamına gelir.

Google tarafından başlatılan OAuth 2.0 yetkilendirme kodu akışı oturumu şu akışa sahiptir:

  1. Google, yetkilendirme uç noktanızı kullanıcının tarayıcısında açar. Akış bir işlem için yalnızca ses özellikli bir cihazda başlatıldığında Google, yürütme sürecidir.

  2. Kullanıcı oturum açar (henüz oturum açmamışsa) ve Google'a şunları yapması için izin verir: Henüz izin vermediyse verilerine API'nizle erişebilir.

  3. Hizmetiniz bir yetkilendirme kodu oluşturur ve bu kodu Google'a geri gönderir. Kullanıcının tarayıcısını yetkilendirme koduyla tekrar Google'a yönlendirme ekleyebilirsiniz.

  4. Google, yetkilendirme kodunu jeton değişimi uç noktanıza gönderir. Bu işlem kodun orijinalliğini doğrular ve bir erişim jetonu ve yenileme jetonu. Erişim jetonu, hizmetinizin Google tarafından API'lere erişmek için kimlik bilgisi olarak kabul eder. Yenileme jetonu uzun ömürlü yeni erişim jetonları almak üzere saklayabileceği ve kullanabileceği bir jeton olarak sona erecektir.

  5. Kullanıcı hesap bağlama akışını tamamladıktan sonra, Asistan'dan sipariş karşılama webhook'unuza gönderilen istekte erişim jetonu.

Yetkilendirme isteklerini işleme

İşleminizin OAuth 2.0 yetkilendirme kodu aracılığıyla hesap bağlama işlemi yapması gerektiğinde akışında, Google, kullanıcıyı yetkilendirme uç noktanıza bir istek göndererek aşağıdaki parametreleri içerir:

Yetkilendirme uç noktası parametreleri
client_id Google'a kaydolduğunuz Google istemci kimliği.
redirect_uri Bu isteğe yanıt gönderdiğiniz URL.
state yönlendirme URI'si.
scope İsteğe bağlı: Google'ın yetkilendirme istediği veriler.
response_type code dizesi.

Ö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&scope=REQUESTED_SCOPES&response_type=code

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

  1. client_id bilgisinin, kaydolurken kullandığınız Google müşteri kimliğiyle eşleştiğini doğrulayın. ve redirect_uri değerinin Google tarafından sağlanan yönlendirme URL'si ile eşleştiğinden hizmetiniz için. Bu kontroller, istenmeyen veya yanlış yapılandırılmış istemci uygulamaları olabilir.

    Birden fazla OAuth 2.0 akışını destekliyorsanız response_type code.

  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 kayıt akışını tamamlayın.

  3. Google'ın API'nize erişmek için kullanacağı yetkilendirme kodu oluşturun. Yetkilendirme kodu herhangi bir dize değeri olabilir, ancak benzersiz bir şekilde kullanıcıyı, jetonun ait olduğu istemciyi ve kodun geçerlilik bitiş tarihini ve tahmin edilebilir olmamalıdır. Genellikle, her ay web sitesinde sonra süresi dolan kodları kullanır.

  4. redirect_uri parametresi tarafından belirtilen URL'yi doğrulayın 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.

  5. Kullanıcının tarayıcısını redirect_uri parametresinden yararlanın. Alacağınız yetkilendirme kodunu URL'nin otomatik olarak oluşturulmuş ve orijinal, değiştirilmemiş durum değerini code ve state parametrelerini ekleyerek. Aşağıda, bununla ilgili bir örnek elde edilir: 

    https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID?code=AUTHORIZATION_CODE&state=STATE_STRING

Jeton değişimi isteklerini işleme

Hizmetinizin jeton değişimi uç noktası iki tür jetondan sorumludur takaslar:

  • Erişim jetonları ve yenileme jetonları için yetkilendirme kodlarını gönderip alın
  • Erişim jetonları için yenileme jetonları değişimi

Jeton değişimi istekleri aşağıdaki parametreleri içerir:

Jeton değişimi uç nokta parametreleri
client_id İstek kaynağını Google olarak tanımlayan bir dize. Bu dize sisteminizde Google'ın benzersiz tanımlayıcısı olarak kayıtlı olmalıdır.
client_secret Hizmetiniz için Google'a kaydettiğiniz gizli dize.
grant_type Değişen jetonun türü. İkisinden biri authorization_code veya refresh_token.
code grant_type=authorization_code olduğunda, Google kodu oturum açma veya jeton değişimi uç noktasından gelen tüm verileri içerir.
redirect_uri grant_type=authorization_code olduğunda bu parametre İlk yetkilendirme isteğinde kullanılan URL.
refresh_token grant_type=refresh_token olduğunda, yenileme jetonu Google yeni bir değer atanmasını sağlar.
Erişim jetonları ve yenileme jetonları için yetkilendirme kodlarını gönderip alın

Kullanıcı oturum açtıktan ve yetkilendirme uç noktanız kısa ömürlü bir yetkilendirme döndürdükten sonra Google'dan exchange'de veri alışverişi için jeton değişimi uç noktanıza bir istek ve yenileme jetonu için yetkilendirme kodu oluşturabilirsiniz.

Bu istekler için grant_type değeri authorization_code ve code değeri, Google'a daha önce verdiğiniz yetkilendirme kodunun değeridir. Aşağıda, erişim jetonu ve bir yenileme jetonu bulunur:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=REDIRECT_URI

Bir erişim jetonu ve yenileme jetonuyla yetkilendirme kodları değişimi yapmak için jeton değişimi uç noktası, aşağıdaki adımları yürüten POST isteklerine yanıt verir:

  1. client_id öğesinin, istek kaynağını yetkili bir kaynak olarak tanımladığını doğrulayın. ve client_secret değerinin beklenen değerle eşleştiğinden emin olun.
  2. Aşağıdakileri doğrulayın:
    • Yetkilendirme kodu geçerli ve süresi dolmuş değil ve istemci İstekte belirtilen kimlik, yetkilendirme kodu.
    • redirect_uri parametresi tarafından belirtilen URL aynı ilk yetkilendirme isteğinde kullanılan değerle aynıdır.
  3. Yukarıdaki ölçütlerin tümünü doğrulayamazsanız bir HTTP döndürün Gövde olarak {"error": "invalid_grant"} kullanılırken 400 Hatalı İstek hatası.
  4. Aksi takdirde, yetkilendirme kodundaki kullanıcı kimliğini kullanarak jetonu ve erişim jetonu bulunur. Bu jetonlar herhangi bir dize değeri olabilir, ancak jetonun ait olduğu kullanıcıyı ve istemciyi benzersiz şekilde temsil etmeli, tahmin edilemez. Erişim jetonları için jetonun geçerlilik süresini de kaydedin (genellikle jetonu vermenizden bir saat sonra). Yenileme jetonlarının geçerlilik süresi sona ermez.
  5. HTTPS yanıtının gövdesinde aşağıdaki JSON nesnesini döndürün: 
    {
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"refresh_token": "REFRESH_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}

Google, kullanıcı için erişim jetonunu ve yenileme jetonunu depolar ve geçerlilik süresi sona erecektir. Erişim jetonunun süresi dolduğunda Google, jeton değişimi uç noktasından yeni bir erişim jetonu almak için jeton.

Erişim jetonları için yenileme jetonları değişimi

Bir erişim jetonunun süresi dolduğunda Google, jeton değişimi uç noktanıza bir istek gönderir yeni bir erişim jetonuyla yenileme jetonu alın.

Bu istekler için grant_type değeri refresh_token ve refresh_token, daha önce Google'a verdiğiniz yenileme jetonunun değeridir. Aşağıda, bir erişim jetonu:

POST /token HTTP/1.1
Host: oauth2.example.com
Content-Type: application/x-www-form-urlencoded

client_id=GOOGLE_CLIENT_ID&client_secret=GOOGLE_CLIENT_SECRET&grant_type=refresh_token&refresh_token=REFRESH_TOKEN

Yenileme jetonunu bir erişim jetonuyla değiştirmek için jeton değişimi uç noktanız aşağıdaki adımları yürüten POST isteklerine yanıt verir:

  1. client_id öğesinin, istek kaynağını ve client_secret değerinin beklenen değer.
  2. Yenileme jetonunun geçerli olduğunu ve İstek, yenileme jetonuyla ilişkili istemci kimliğiyle eşleşir.
  3. Yukarıdaki ölçütlerin tümünü doğrulayamazsanız bir HTTP döndürün Gövde olarak {"error": "invalid_grant"} kullanılırken 400 Hatalı İstek hatası.
  4. Aksi takdirde, erişim oluşturmak için yenileme jetonundaki kullanıcı kimliğini kullanın. jeton. Bu jetonlar herhangi bir dize değeri olabilir, ancak bu jetonları benzersiz bir şekilde temsil etmelidir jetonun ait olduğu kullanıcı ve istemciyi kapsamalıdır ve tahmin edilebilir olmamalıdır. Erişim jetonları için jetonun geçerlilik süresini de kaydedin (genellikle jetonu vermenizden bir saat sonra).
  5. HTTPS gövdesinde aşağıdaki JSON nesnesini döndürün yanıt: 
    {
"token_type": "Taşıyıcı",
"access_token": "ACCESS_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}
ziyaret edin.

Kimlik doğrulama akışı için sesli kullanıcı arayüzünü tasarlama

Kullanıcının doğrulanıp doğrulanmadığını kontrol edin ve hesap bağlama akışını başlatın.

  1. Actions Builder projenizi Actions Console'da açın.
  2. İşleminizde hesap bağlama işlemini başlatmak için yeni bir sahne oluşturun:
    1. Sahneler'i tıklayın.
    2. Yeni bir sahne eklemek için ekle (+) simgesini tıklayın.
  3. Yeni oluşturulan sahnede, Koşullar için ekle simgesini tıklayın.
  4. Sohbetle ilişkili kullanıcının doğrulanmış bir kullanıcı olup olmadığını kontrol eden bir koşul ekleyin. Kontrol başarısız olursa İşleminiz, görüşme sırasında hesap bağlama işlemini gerçekleştiremez ve hesap bağlama gerektirmeyen işlevlere erişim sağlamaya geri dönmelidir.
    1. Koşul bölümündeki Enter new expression alanına aşağıdaki mantığı girin: user.verificationStatus != "VERIFIED"
    2. Geçiş bölümünde, hesap bağlama gerektirmeyen veya yalnızca konuklara özel işlevlerin giriş noktası olan bir sahne seçin.

  1. Koşullar için ekle simgesini tıklayın.
  2. Kullanıcının ilişkili bir kimliği yoksa hesap bağlama akışını tetikleyecek bir koşul ekleyin.
    1. Koşul bölümündeki Enter new expression alanına aşağıdaki mantığı girin: user.verificationStatus == "VERIFIED"
    2. Geçiş bölümünde Hesap Bağlama sistem sahnesini seçin.
    3. Kaydet'i tıklayın.

Kaydettikten sonra projenize <SceneName>_AccountLinking adlı yeni bir hesap bağlama sistemi sahnesi eklenir.

Hesap bağlama sahnesini özelleştirme

  1. Sahneler bölümünde hesap bağlama sistemi sahnesini seçin.
  2. İstemi gönder'i tıklayın ve kullanıcıya İşlem'in kimliğine neden erişmesi gerektiğini açıklayan kısa bir cümle ekleyin (örneğin, "Tercihlerinizi kaydetmek için").
  3. Kaydet'i tıklayın.

  1. Koşullar bölümünde Kullanıcı hesap bağlama işlemini başarıyla tamamlarsa'yı tıklayın.
  2. Kullanıcı hesabını bağlamayı kabul ederse akışın nasıl devam edeceğini yapılandırın. Örneğin, gerekli özel işletme mantığını işlemek ve başlangıç sahnesine geri dönmek için webhook'u çağırın.
  3. Kaydet'i tıklayın.

  1. Koşullar bölümünde Kullanıcı hesap bağlantısını iptal ederse veya kapatırsa'yı tıklayın.
  2. Kullanıcı hesabını bağlamayı kabul etmezse akışın nasıl devam edeceğini yapılandırın. Örneğin, onay mesajı gönderin ve hesap bağlama gerektirmeyen işlevler sunan sahnelere yönlendirin.
  3. Kaydet'i tıklayın.

  1. Koşullar bölümünde Sistem veya ağ hatası oluşursa'yı tıklayın.
  2. Hesap bağlama akışı, sistem veya ağ hataları nedeniyle tamamlanamazsa akışın nasıl devam edeceğini yapılandırın. Örneğin, onay mesajı gönderin ve hesap bağlama gerektirmeyen işlevler sunan sahnelere yönlendirin.
  3. Kaydet'i tıklayın.

Veri erişimi isteklerini ele alma

Asistan isteği erişim jetonu içeriyorsa, önce erişim jetonunun geçerli (ve süresinin dolmamış) olup olmadığını kontrol edin, ardından ilişkili kullanıcı hesabını veritabanınızdan alın.