Penautan akun dengan OAuth

Jenis penautan OAuth mendukung dua alur OAuth 2.0 standar industri, yaitu alur kode implisit dan otorisasi.

Dalam alur kode implisit, Google membuka endpoint otorisasi Anda di browser pengguna. Setelah berhasil login, Anda akan menampilkan token akses berumur panjang ke Google. Token akses ini sekarang disertakan di setiap permintaan yang dikirim dari Asisten ke Action.

Dalam alur kode otorisasi, Anda membutuhkan dua endpoint:

• Endpoint otorisasi, yang bertanggung jawab untuk menampilkan UI login kepada pengguna yang belum login, dan merekam izin untuk akses yang diminta dalam bentuk kode otorisasi yang memiliki masa aktif singkat.
• Endpoint pertukaran token, yang bertanggung jawab atas dua jenis pertukaran:
  1. Menukarkan kode otorisasi dengan token refresh yang memiliki masa aktif lama dan token akses yang memiliki masa aktif singkat. Pertukaran ini terjadi saat pengguna melalui alur penautan akun.
  2. Menukarkan token refresh yang memiliki masa aktif lama dengan token akses yang memiliki masa aktif singkat. Pertukaran ini terjadi saat Google memerlukan token akses baru karena masa berlakunya telah berakhir.

Meskipun alur kode implisit lebih mudah diimplementasikan, Google merekomendasikan agar token akses yang dikeluarkan menggunakan alur implisit tidak pernah kedaluwarsa, karena menggunakan masa berlaku token dengan alur implisit akan memaksa pengguna untuk menautkan akunnya lagi. Jika Anda memerlukan masa berlaku token untuk alasan keamanan, Anda harus mempertimbangkan penggunaan alur kode autentikasi.

Catatan: Pilih alur OAuth 2.0 yang ingin Anda terapkan. Jika diperlukan, konten dalam panduan ini akan dimuat ulang untuk disesuaikan dengan pilihan Anda.

Kode Auth Alur implisit

Menerapkan penautan akun OAuth

Catatan: Jika Anda menerapkan penautan akun untuk menangani informasi keuangan, perlu diperhatikan bahwa kebijakan tambahan mungkin berlaku untuk Action Anda. Kami membutuhkan waktu hingga enam minggu untuk meninjau Action dengan penautan akun untuk mendapatkan informasi keuangan, jadi perhitungkan waktu tersebut saat merencanakan jadwal rilis Anda. Untuk memudahkan proses peninjauan, pastikan Anda mematuhi kebijakan jasa keuangan sebelum mengirimkan Action untuk ditinjau.

Mengonfigurasi project

Untuk mengonfigurasi project Anda agar menggunakan penautan OAuth, ikuti langkah-langkah berikut:

1. Buka Konsol Actions dan pilih project yang ingin Anda gunakan.
2. Klik tab Develop dan pilih Account linking.
3. Aktifkan tombol di samping Penautan akun.
4. Di bagian Pembuatan akun, pilih Tidak, saya hanya ingin mengizinkan pembuatan akun di situs saya.

5. Di Jenis penautan, pilih OAuth dan Implisit.

   

6. 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.

Catatan: Jika Anda ingin client ID dikirim sebagai string berenkode base64, klik panah drop-down di sebelah Configure your client (optional), lalu centang kotak Google to mengirimkan clientID and secret via HTTP basic auth header.

6. 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:

1. 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.
2. Layanan Anda membuat token akses dan mengembalikannya ke Google dengan mengalihkan browser pengguna kembali ke Google dengan token akses dilampirkan pada permintaan.
3. 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:

1. Verifikasi nilai client_id dan redirect_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.

2. Periksa apakah pengguna sudah login ke layanan Anda. Jika pengguna tidak login di layanan Anda, selesaikan proses login atau pendaftaran.

3. 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.

4. 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 buat
   • token_type: string bearer
   • 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

Peringatan: Jangan beri pengguna permintaan penautan akun wajib di awal percakapan dengan Action Anda. Sebagai gantinya, berikan alur tamu kepada pengguna yang tidak diautentikasi untuk menunjukkan cara kerja Action Anda, lalu minta penautan akun hanya jika diperlukan untuk melanjutkan. Jika pengguna keluar dari Action secara konsisten karena masalah penautan akun, Google tidak akan secara aktif mempromosikan Action, sehingga dapat menurunkan traffic pengguna Action tersebut.

Catatan: Anda harus menggunakan Actions Builder untuk membuat Action yang menerapkan penautan akun.

Periksa apakah pengguna telah diverifikasi dan mulai alur penautan akun

1. Buka project Action Builder Anda di Konsol Actions.
2. Buat scene baru untuk memulai penautan akun di Action Anda:
   1. Klik Scene.
   2. Klik ikon add (+) untuk menambahkan adegan baru.
3. Pada scene yang baru dibuat, klik ikon tambahkan untuk Kondisi.
4. 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.
   1. Di kolom Enter new expression pada bagian Kondisi, masukkan logika berikut: user.verificationStatus != "VERIFIED"
   2. Di bagian Transition, pilih scene yang tidak memerlukan penautan akun atau scene yang merupakan titik entri ke fungsi khusus tamu.

1. Klik ikon tambahkan untuk Kondisi.
2. Tambahkan kondisi untuk memicu alur penautan akun jika pengguna tidak memiliki identitas terkait.
   1. Di kolom Enter new expression pada bagian Kondisi, masukkan logika berikut: user.verificationStatus == "VERIFIED"
   2. Di bagian Transisi, pilih scene sistem Penautan Akun.
   3. Klik Simpan.

Setelah disimpan, scene sistem penautan akun baru yang disebut <SceneName>_AccountLinking akan ditambahkan ke project Anda.

Menyesuaikan adegan penautan akun

1. Di bagian Scene, pilih scene sistem penautan akun.
2. Klik Kirim perintah dan tambahkan kalimat singkat untuk menjelaskan kepada pengguna alasan Action perlu mengakses identitas mereka (misalnya, "Untuk menyimpan preferensi Anda").
3. Klik Simpan.

1. Di bagian Kondisi, klik Jika pengguna berhasil menyelesaikan penautan akun.
2. 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.
3. Klik Simpan.

1. Di bagian Kondisi, klik Jika pengguna membatalkan atau menolak penautan akun.
2. 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.
3. Klik Simpan.

1. Di bagian Kondisi, klik Jika terjadi error sistem atau jaringan.
2. 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.
3. 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.