Jenis penautan OAuth mendukung dua alur OAuth 2.0 standar industri, yaitu alur kode implisit dan otorisasi.
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:
- 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.
- 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.
Menerapkan penautan akun OAuth
Mengonfigurasi project
Untuk mengonfigurasi project Anda agar menggunakan penautan OAuth, ikuti langkah-langkah berikut:
- Buka Konsol Actions dan pilih project yang ingin Anda gunakan.
- Klik tab Develop dan pilih Account linking.
- Aktifkan tombol di samping Penautan akun.
- Di bagian Pembuatan akun, pilih Tidak, saya hanya ingin mengizinkan pembuatan akun di situs saya.
Di Jenis penautan, pilih OAuth dan Implisit.
Di Informasi Klien:
- Tetapkan nilai ke Client ID yang dikeluarkan oleh Actions Anda ke Google untuk mengidentifikasi permintaan yang berasal dari Google.
- Masukkan URL untuk endpoint Otorisasi dan Pertukaran Token.
- Klik Simpan.
Menerapkan server OAuth
Untuk mendukung alur implisit OAuth 2.0, layanan Anda membuat otorisasi endpoint yang tersedia melalui HTTPS. Endpoint ini bertanggung jawab untuk mengotentikasi dan mendapatkan izin dari pengguna untuk akses data. Endpoint otorisasi menampilkan UI login kepada pengguna Anda yang belum login dan merekam menyetujui akses yang diminta.
Jika Action Anda perlu memanggil salah satu API yang diotorisasi layanan Anda, Google akan menggunakan endpoint ini guna mendapatkan izin dari pengguna untuk memanggil API ini di nama Anda.
Sesi alur implisit OAuth 2.0 umum yang dimulai oleh Google memiliki alur berikut:
- Google akan membuka endpoint otorisasi Anda di browser pengguna. Tujuan pengguna masuk jika belum masuk, dan memberikan izin kepada Google untuk mengakses data mereka dengan API Anda jika mereka belum memberikan izin.
- Layanan Anda membuat token akses dan mengembalikannya ke Google dengan mengalihkan browser pengguna kembali ke Google dengan token akses dilampirkan pada permintaan.
- Google memanggil API layanan Anda, dan melampirkan token akses tersebut dengan setiap permintaan. Layanan Anda memverifikasi bahwa token akses tersebut memberikan untuk mengakses API, lalu menyelesaikan panggilan API.
Menangani permintaan otorisasi
Saat Action Anda perlu melakukan penautan akun melalui alur implisit OAuth 2.0, Google mengirim pengguna ke endpoint otorisasi Anda dengan permintaan yang mencakup parameter berikut:
Parameter endpoint otorisasi | |
---|---|
client_id |
Client ID yang Anda tetapkan ke Google. |
redirect_uri |
URL tempat Anda mengirim respons atas permintaan ini. |
state |
Nilai pembukuan yang diteruskan kembali ke Google tanpa berubah dalam URI pengalihan. |
response_type |
Jenis nilai yang akan ditampilkan dalam respons. Untuk OAuth 2.0 implisit
alur, jenis respons selalu token . |
Misalnya, jika endpoint otorisasi Anda tersedia di https://myservice.example.com/auth
,
permintaan akan terlihat seperti:
GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token
Agar endpoint otorisasi Anda dapat menangani permintaan login, lakukan langkah-langkah berikut:
Verifikasi nilai
client_id
danredirect_uri
untuk mencegah pemberian akses ke aplikasi klien yang tidak diinginkan atau salah dikonfigurasi:- Konfirmasi bahwa
client_id
cocok dengan client ID Anda ditetapkan ke Google. - Konfirmasi bahwa URL yang ditentukan oleh
redirect_uri
parameter memiliki bentuk berikut:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID
YOUR_PROJECT_ID adalah ID yang ditemukan pada halaman Setelan project dari Actions Console.
- Konfirmasi bahwa
Periksa apakah pengguna sudah login ke layanan Anda. Jika pengguna tidak login di layanan Anda, selesaikan proses login atau pendaftaran.
Buat token akses yang akan digunakan Google untuk mengakses API Anda. Tujuan token akses dapat berupa nilai string apa pun, tetapi harus secara unik mewakili klien dan klien yang menjadi tujuan token, dan tidak boleh ditebak.
Mengirim respons HTTP yang mengalihkan browser pengguna ke URL yang ditentukan oleh parameter
redirect_uri
. Sertakan semua parameter berikut dalam fragmen URL:access_token
: token akses yang baru saja Anda buattoken_type
: stringbearer
state
: nilai status yang tidak dimodifikasi dari aslinya minta Berikut adalah contoh URL yang dihasilkan:https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING
Pengendali pengalihan OAuth 2.0 Google akan menerima token akses dan mengonfirmasi
bahwa nilai state
tidak berubah. Setelah Google mendapatkan
token akses untuk layanan Anda, Google akan melampirkan token tersebut ke panggilan berikutnya
ke Action Anda sebagai bagian dari AppRequest.
Mendesain antarmuka pengguna suara untuk alur autentikasi
Periksa apakah pengguna telah diverifikasi dan mulai alur penautan akun
- Buka project Action Builder Anda di Konsol Actions.
- Buat scene baru untuk memulai penautan akun di Action Anda:
- Klik Scene.
- Klik ikon add (+) untuk menambahkan adegan baru.
- Pada scene yang baru dibuat, klik ikon tambahkan add untuk Kondisi.
- Tambahkan kondisi yang memeriksa apakah pengguna yang terkait dengan percakapan adalah
pengguna terverifikasi. Jika pemeriksaan gagal, Action Anda tidak dapat melakukan penautan akun
selama percakapan, dan harus kembali menyediakan akses ke
fungsi yang tidak memerlukan penautan akun.
- Di kolom
Enter new expression
pada bagian Kondisi, masukkan logika berikut:user.verificationStatus != "VERIFIED"
- Di bagian Transition, pilih scene yang tidak memerlukan penautan akun atau scene yang merupakan titik entri ke fungsi khusus tamu.
- Di kolom
- Klik ikon tambahkan add untuk Kondisi.
- Tambahkan kondisi untuk memicu alur penautan akun jika pengguna tidak memiliki
identitas terkait.
- Di kolom
Enter new expression
pada bagian Kondisi, masukkan logika berikut:user.verificationStatus == "VERIFIED"
- Di bagian Transisi, pilih scene sistem Penautan Akun.
- Klik Simpan.
- Di kolom
Setelah disimpan, scene sistem penautan akun baru yang disebut <SceneName>_AccountLinking
akan ditambahkan ke project Anda.
Menyesuaikan adegan penautan akun
- Di bagian Scene, pilih scene sistem penautan akun.
- Klik Kirim perintah dan tambahkan kalimat singkat untuk menjelaskan kepada pengguna alasan Action perlu mengakses identitas mereka (misalnya, "Untuk menyimpan preferensi Anda").
- Klik Simpan.
- Di bagian Kondisi, klik Jika pengguna berhasil menyelesaikan penautan akun.
- Konfigurasi cara alur berjalan jika pengguna setuju untuk menautkan akun mereka. Misalnya, panggil webhook untuk memproses logika bisnis kustom yang diperlukan dan lakukan transisi kembali ke scene asal.
- Klik Simpan.
- Di bagian Kondisi, klik Jika pengguna membatalkan atau menolak penautan akun.
- Konfigurasikan cara alur akan dilanjutkan jika pengguna tidak setuju untuk menautkan akunnya. Misalnya, kirim pesan konfirmasi dan alihkan ke scene yang menyediakan fungsi yang tidak memerlukan penautan akun.
- Klik Simpan.
- Di bagian Kondisi, klik Jika terjadi error sistem atau jaringan.
- Konfigurasikan cara alur akan dilanjutkan jika alur penautan akun tidak dapat diselesaikan karena error sistem atau jaringan. Misalnya, kirim pesan konfirmasi dan alihkan ke scene yang menyediakan fungsi yang tidak memerlukan penautan akun.
- Klik Simpan.
Menangani permintaan akses data
Jika permintaan Asisten berisi token akses, periksa terlebih dahulu apakah token akses valid (dan belum habis masa berlakunya), lalu ambil akun pengguna terkait dari database Anda.