OAuth ve Google ile Oturum Açma bağlantı türü, OAuth tabanlı hesap bağlamaya Google ile Oturum Açma'yı ekler. Bu sayede Google kullanıcıları için sorunsuz bir ses tabanlı bağlantı oluşturma olanağı tanırken hizmetinize Google dışı bir kimlikle kaydolan kullanıcılar için de hesap bağlama etkinleştirilir.
Bu bağlantı türü, kullanıcının Google profili bilgilerinin sisteminizde mevcut olup olmadığını kontrol etmenize olanak tanıyan Google ile Oturum Açma özelliğiyle başlar. Kullanıcının bilgileri sisteminizde bulunamazsa standart bir OAuth akışı başlar. Kullanıcı, Google profil bilgileriyle yeni bir hesap oluşturmayı da seçebilir.
OAuth ve Google ile Oturum Açma ile hesap bağlama işlemi gerçekleştirmek için şu genel adımları uygulayın:
- Öncelikle kullanıcıdan Google profiline erişim için izin vermesini isteyin.
- Kullanıcıyı tanımlamak için kullanıcının profilindeki bilgileri kullanın.
- Kimlik doğrulama sisteminizde Google kullanıcısı için eşleşme bulamazsanız, Actions Console'daki Actions projenizi sesle mi yoksa yalnızca web sitenizde mi yapılandırdığınıza bağlı olarak süreç devam eder.
- Sesle hesap oluşturmaya izin veriyorsanız Google'dan alınan kimlik jetonunu doğrulayın. Daha sonra, kimlik jetonunda bulunan profil bilgilerine dayalı bir kullanıcı oluşturabilirsiniz.
- Sesle hesap oluşturmaya izin vermezseniz kullanıcı, yetkilendirme sayfanızı yükleyebileceği ve kullanıcı oluşturma akışını tamamlayabileceği bir tarayıcıya aktarılır.
Sesle hesap oluşturma desteği
Sesle kullanıcı hesabı oluşturmaya izin verirseniz Asistan, kullanıcıya aşağıdakileri yapmak isteyip istemediğini sorar:
- Google hesap bilgilerini kullanarak sisteminizde yeni bir hesap oluşturun veya
- Google dışı bir hesapları varsa kimlik doğrulama sisteminizde farklı bir hesapla oturum açın.
Hesap oluşturma akışının zorluklarını en aza indirmek istiyorsanız sesle hesap oluşturmaya izin vermeniz önerilir. Kullanıcının yalnızca mevcut bir Google dışı hesabı kullanarak oturum açmak istediği durumlarda ses akışından ayrılması gerekir.
Sesle hesap oluşturmaya izin verme
Sesle kullanıcı hesabı oluşturmaya izin vermediyseniz Asistan, kullanıcı kimlik doğrulaması için sağladığınız web sitesinin URL'sini açar. Etkileşim, ekranı olmayan bir cihazda gerçekleşiyorsa Asistan, hesap bağlama akışına devam etmesi için kullanıcıyı telefona yönlendirir.
Aşağıdaki durumlarda oluşturmaya izin vermemeniz önerilir:
Google dışı hesapları olan kullanıcıların yeni bir kullanıcı hesabı oluşturmasına izin vermek istemiyor ve bunun yerine bu kullanıcıların, kimlik doğrulama sisteminizdeki mevcut kullanıcı hesaplarına bağlamasını istiyorsanız. Örneğin, bir bağlılık programı sunuyorsanız kullanıcının mevcut hesabında biriken puanları kaybetmediğinden emin olmak isteyebilirsiniz.
Hesap oluşturma akışı üzerinde tam kontrole sahip olmanız gerekir. Örneğin, hesap oluşturma sırasında hizmet şartlarınızı kullanıcıya göstermeniz gerekirse oluşturma işlemine izin vermemeyi tercih edebilirsiniz.
OAuth ve Google ile Oturum Açma hesap bağlantısını uygulayın
Hesaplar endüstri standardı OAuth 2.0 akışlarına bağlıdır. Actions on Google, dolaylı ve yetkilendirme kodu akışlarını destekler.
Dolaylı kod akışında Google, yetkilendirme uç noktanızı kullanıcının tarayıcısında açar. Başarılı bir şekilde oturum açtıktan sonra Google'a uzun ömürlü bir erişim jetonu döndürürsünüz. Bu erişim jetonu artık Asistan'dan Action'ınıza gönderilen her isteğe dahil edilir.
Yetkilendirme kodu akışında iki uç noktaya ihtiyacınız vardır:
- Oturum açma kullanıcı arayüzünü henüz oturum açmamış kullanıcılara sunmaktan ve istenen erişime kısa süreli bir yetkilendirme kodu biçiminde izin kaydetmekten sorumlu olan yetkilendirme uç noktası.
- İki tür exchange'den sorumlu olan jeton değişimi uç noktası:
- Yetkilendirme kodunu uzun ömürlü yenileme jetonu ve kısa ömürlü erişim jetonu ile değiştirir. Bu değişim, kullanıcı hesap bağlama akışından geçer.
- Kısa ömürlü bir erişim jetonu için uzun süreli yenileme jetonunu değiştirir. Bu exchange, Google'ın süresi dolmuş olduğundan yeni bir erişim jetonuna ihtiyacı olduğunda gerçekleşir.
Örtülü akış kullanılarak verilen erişim jetonlarının geçerlilik süresinin hiçbir zaman dolmaması, Google'ın örtülü akışla kullanılması nedeniyle kullanıcının hesabını tekrar bağlamayı zorunlu kıldığı için Google, örtülü akış akışının uygulanmasını önerir. Güvenlik nedeniyle jetonun süresinin dolması gerekiyorsa kimlik doğrulama kodu akışını kullanmanız önerilir.
Projeyi yapılandırma
Projenizi, OAuth ve Google ile Oturum Açma hesap bağlantısını kullanacak şekilde yapılandırmak için aşağıdaki adımları uygulayın:
- Actions konsolunu açın ve kullanmak istediğiniz projeyi seçin.
- Geliştirme sekmesini tıklayın ve Hesap bağlama'yı seçin.
- Hesap bağlama'nın yanındaki anahtarı etkinleştirin.
- Hesap oluşturma bölümünde Evet'i seçin.
Bağlantı türü bölümünde OAuth ve Google ile Oturum Açma ile Dolaylı'yı seçin.
Müşteri Bilgileri bölümünde aşağıdakileri yapın:
- Google'dan gelen istekleri tanımlamak için Actions to Google'a (İşlemleriniz tarafından Google'a gönderilen) bir değer atayın.
- Yetkilendirme ve Jeton Değişimi uç noktalarınızın URL'lerini ekleyin.
Kaydet'i tıklayın.
OAuth sunucunuzu uygulama
Hizmetiniz OAuth 2.0 dolaylı akışını desteklemek için HTTPS tarafından kullanılabilen bir yetkilendirme uç noktası sunar. Bu uç nokta, veri erişimi için kullanıcıların kimliğini doğrulamak ve kullanıcılardan izin almaktan sorumludur. Yetkilendirme uç noktası, henüz oturum açmamış olan kullanıcılarınıza bir oturum açma kullanıcı arayüzü sunar ve istenen erişim için izni kaydeder.
İşleminizin, hizmetinizin yetkili API'lerinden birini çağırması gerektiğinde Google, kullanıcılarınızın kendi adlarına bu API'leri çağırmasına izin vermek için bu uç noktayı kullanır.
Google tarafından başlatılan tipik bir OAuth 2.0 dolaylı akış oturumu aşağıdaki akışa sahiptir:
- Google, kullanıcının tarayıcısında yetkilendirme uç noktanızı açar. Kullanıcı daha önce oturum açmadıysa oturum açar ve henüz izin vermemişse Google'ın API'nizle verilerine erişmesine izin verir.
- Hizmetiniz bir erişim jetonu oluşturur ve kullanıcının tarayıcısını isteğe eklenmiş erişim jetonuyla tekrar Google'a yönlendirerek bu jetonu Google'a gönderir.
- Google, hizmetinizin API'lerini çağırır ve erişim jetonunu her isteğe ekler. Hizmetiniz, erişim jetonunun Google'a API'ye erişim yetkisi verdiğini doğrular ve ardından API çağrısını tamamlar.
Yetkilendirme isteklerini işleme
İşleminizin hesap bağlama işlemini OAuth2 dolaylı akışı üzerinden gerçekleştirmesi gerektiğinde Google, aşağıdaki parametreleri içeren bir istekle kullanıcıyı yetkilendirme uç noktanıza gönderir:
| 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'sında değiştirilmeden Google'a geri aktarılan defter değeri. |
response_type |
Yanıtta döndürülecek değerin türü. OAuth 2.0 dolaylı akışı için yanıt türü her zaman token şeklindedir. |
Örneğin, yetkilendirme uç noktanız https://myservice.example.com/auth adresinde bulunuyorsa istek aşağıdaki gibi 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şleyebilmesi için aşağıdaki adımları uygulayın:
İstenmeyen veya yanlış yapılandırılmış istemci uygulamalarına erişim izni verilmesini önlemek için
client_idveredirect_urideğerlerini doğrulayın:client_idöğesinin Google'a atadığınız istemci kimliğiyle eşleştiğini doğrulayın.redirect_uriparametresi tarafından belirtilen URL'nin aşağıdaki biçimde olduğunu onaylayın:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID, Actions Console'un Proje ayarları sayfasında bulunan kimliktir.
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.
Google'ın API'nize erişmek için kullanacağı bir erişim jetonu oluşturun. Erişim jetonu herhangi bir dize değeri olabilir ancak kullanıcıyı ve jetonun ait olduğu istemciyi benzersiz şekilde temsil etmeli ve tahmin edilebilir olmamalıdır.
Kullanıcının tarayıcısını
redirect_uriparametresiyle belirtilen URL'ye yönlendiren bir HTTP yanıtı gönderin. Aşağıdaki parametrelerin tümünü URL parçasına ekleyin:access_token: az önce oluşturduğunuz erişim jetonutoken_type:bearerdizesistate: Orijinal istekteki değiştirilmemiş durum değeri Aşağıda, elde edilen URL örneği 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 state değerinin değişmediğini onaylar. Google, hizmetiniz için bir erişim jetonu aldıktan sonra bu jetonu AppRequest'in parçası olarak sonraki İşleminize yapılan çağrılara ekler.
Otomatik bağlamayı işleme
Kullanıcı, İşleminize Google profiline erişmesi için izin verdikten sonra Google, Google kullanıcısının kimliği için imzalı bir onay içeren bir istek gönderir. Onay, kullanıcının Google Hesabı kimliğini, adını ve e-posta adresini içeren bilgiler içerir. Projeniz için yapılandırılan jeton değişimi uç noktası bu isteği işler.
İlgili Google hesabı kimlik doğrulama sisteminizde zaten mevcutsa jeton değişimi uç noktanız kullanıcı için bir jeton döndürür. Google hesabı mevcut bir kullanıcıyla eşleşmezse jeton değişimi uç noktanız user_not_found hatası döndürür.
İstek aşağıdaki biçimde olur:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&intent=get&assertion=JWT&consent_code=CONSENT_CODE&scope=SCOPES
Jeton değişimi uç noktanız aşağıdaki parametreleri işleyebilmelidir:
| Jeton uç nokta parametreleri | |
|---|---|
grant_type |
Alınan jetonun türü. Bu istekler için bu parametre urn:ietf:params:oauth:grant-type:jwt-bearer değerine sahiptir. |
intent |
Bu istekler için parametre değeri "get"tir. |
assertion |
Google kullanıcı kimliği için imzalı bir onay sağlayan JSON Web Token (JWT). JWT, kullanıcının Google Hesabı kimliğini, adını ve e-posta adresini içeren bilgiler içerir. |
consent_code |
İsteğe bağlı: Mevcut olduğunda, kullanıcının İşleminizin belirtilen kapsamlara erişmesine izin verdiğini belirten tek seferlik bir kod. |
scope |
İsteğe bağlı: Google'ın kullanıcılardan isteyeceği şekilde yapılandırdığınız tüm kapsamlar. |
Jeton değişimi uç noktanız bağlantı isteğini aldığında aşağıdakileri yapmalıdır:
JWT onayını doğrulama ve kodunu çözme
Diliniz için JWT kod çözme kitaplığını kullanarak JWT onayını doğrulayabilir ve kodunu çözebilirsiniz. Jetonun imzasını doğrulamak için Google'ın ortak anahtarlarını (JWK veya PEM biçiminde mevcuttur) kullanın.
Kod çözüldüğünde JWT onayı aşağıdaki örnekte olduğu gibi görünür:
{
"sub": 1234567890, // The unique ID of the user's Google Account
"iss": "https://accounts.google.com", // The assertion's issuer
"aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
"iat": 233366400, // Unix timestamp of the assertion's creation time
"exp": 233370000, // Unix timestamp of the assertion's expiration time
"name": "Jan Jansen",
"given_name": "Jan",
"family_name": "Jansen",
"email": "jan@gmail.com", // If present, the user's email address
"locale": "en_US"
}
Jetonun imzasını doğrulamaya ek olarak, onayı verenin (iss alanı) https://accounts.google.com ve kitlenin (aud alanının) İşleminize atanan istemci kimliği olduğunu doğrulayın.
Google hesabının kimlik doğrulama sisteminizde mevcut olup olmadığını kontrol edin
Aşağıdaki koşullardan birinin doğru olup olmadığını kontrol edin:
- Onayın
subalanında bulunan Google Hesabı Kimliği, kullanıcı veritabanınızda yer alır. - Onaydaki e-posta adresi, kullanıcı veritabanınızdaki bir kullanıcıyla eşleşiyor.
İki koşul da doğruysa kullanıcı zaten kaydolmuştur ve erişim jetonu düzenleyebilirsiniz.
Onayda belirtilen Google Hesabı Kimliği veya e-posta adresi veritabanınızdaki bir kullanıcıyla eşleşmiyorsa kullanıcı henüz kaydolmamıştır. Bu durumda jeton değişimi uç noktanız, aşağıdaki örnekte olduğu gibi error=user_not_found belirten bir HTTP 401 hatasıyla yanıt vermelidir:
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"error":"user_not_found",
}
Google, user_not_found hatası içeren 401 hatası yanıtı aldığında, intent parametresi değeri create olarak ayarlanmış jeton değişimi uç noktanızı çağırır ve istekle birlikte kullanıcının profil bilgilerini içeren bir kimlik jetonu gönderir.
Google ile Oturum Açma aracılığıyla hesap oluşturma
Kullanıcının hizmetinizde bir hesap oluşturması gerektiğinde Google, aşağıdaki örnekte olduğu gibi, intent=create değerini belirten jeton değişimi uç noktanıza bir istek gönderir:
POST /token HTTP/1.1 Host: oauth2.example.com Content-Type: application/x-www-form-urlencoded response_type=token&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer&scope=SCOPES&intent=create&consent_code=CONSENT_CODE&assertion=JWT[&NEW_ACCOUNT_INFO]
assertion parametresi, Google kullanıcısının kimliği için imzalı bir onay sağlayan JSON Web Token (JWT) içerir. JWT, hizmetinizde yeni bir hesap oluşturmak için kullanabileceğiniz, kullanıcının Google Hesabı kimliğini, adını ve e-posta adresini içeren bilgiler içerir.
Hesap oluşturma isteklerine yanıt vermek için jeton değişimi uç noktanızın aşağıdakileri yapması gerekir:
JWT onayını doğrulama ve kodunu çözme
Diliniz için JWT kod çözme kitaplığını kullanarak JWT onayını doğrulayabilir ve kodunu çözebilirsiniz. Jetonun imzasını doğrulamak için Google'ın ortak anahtarlarını (JWK veya PEM biçiminde mevcuttur) kullanın.
Kod çözüldüğünde JWT onayı aşağıdaki örnekte olduğu gibi görünür:
{
"sub": 1234567890, // The unique ID of the user's Google Account
"iss": "https://accounts.google.com", // The assertion's issuer
"aud": "123-abc.apps.googleusercontent.com", // Your server's client ID
"iat": 233366400, // Unix timestamp of the assertion's creation time
"exp": 233370000, // Unix timestamp of the assertion's expiration time
"name": "Jan Jansen",
"given_name": "Jan",
"family_name": "Jansen",
"email": "jan@gmail.com", // If present, the user's email address
"locale": "en_US"
}
Jetonun imzasını doğrulamaya ek olarak, onayı verenin (iss alanı) https://accounts.google.com ve kitlenin (aud alanının) İşleminize atanan istemci kimliği olduğunu doğrulayın.
Kullanıcı bilgilerini doğrulayın ve yeni hesap oluşturun
Aşağıdaki koşullardan birinin doğru olup olmadığını kontrol edin:
- Onayın
subalanında bulunan Google Hesabı Kimliği, kullanıcı veritabanınızda yer alır. - Onaydaki e-posta adresi, kullanıcı veritabanınızdaki bir kullanıcıyla eşleşiyor.
İki koşuldan biri doğruysa, aşağıdaki örnekte olduğu gibi error=linking_error özelliğini ve kullanıcının e-posta adresini login_hint olarak belirterek isteğe yanıt vererek kullanıcıdan mevcut hesabını Google Hesabı ile bağlamasını isteyin:
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
{
"error":"linking_error",
"login_hint":"foo@bar.com"
}
Hiçbir koşul doğru değilse JWT'de sağlanan bilgileri kullanarak yeni bir kullanıcı hesabı oluşturun. Yeni hesaplarda genellikle şifre belirlenmez. Kullanıcıların uygulama platformlarında Google aracılığıyla giriş yapabilmesi için Google ile Oturum Açma özelliğini diğer platformlara eklemeniz önerilir. Alternatif olarak, kullanıcıya diğer platformlarda oturum açmak için şifre belirleme izni vermek amacıyla şifre kurtarma akışınızı başlatan bir bağlantıyı kullanıcıya e-posta ile gönderebilirsiniz.
Oluşturma işlemi tamamlandığında bir erişim jetonu ve aşağıdaki örnekte gösterildiği gibi, HTTPS yanıtınızın gövdesinde bir JSON nesnesindeki değerleri döndürün:
{
"token_type": "Bearer",
"access_token": "ACCESS_TOKEN",
"expires_in": SECONDS_TO_EXPIRATION
}
Kimlik doğrulama akışını başlatma
Kimlik doğrulama akışını başlatmak için Hesapta Oturum Açma yardımcı amacını kullanın.
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'))
})
private String clientId = "<your_client_id>";
@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
ResponseBuilder rb = getResponseBuilder(request);
return rb.add(new SignIn().setContext("To get your account details")).build();
}
const app = actionssdk({
clientId: CLIENT_ID,
})
app.intent('Start Signin', conv => {
conv.ask(new SignIn('To get your account details'))
})
private String clientId = "<your_client_id>";
@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();
}
Veri erişim isteklerini işleme
Asistan isteği erişim jetonu içeriyorsa öncelikle erişim jetonunun geçerli olduğundan ve süresinin dolmadığından emin olun, ardından kullanıcı hesabı veritabanınızdan jetonla ilişkili kullanıcı hesabını alın.