Memilih jalur integrasi Anda
Pilih jalur yang paling sesuai dengan kebutuhan Anda:
| Jalur | Paling cocok untuk | Pelajari lebih lanjut |
|---|---|---|
| Universal Commerce Protocol (UCP) | Penjual dan retailer. | Dokumen UCP |
| Penautan Akun Standar | Smart Home, TV, dan YouTube. | Dokumen |
Penautan akun memungkinkan pemegang Akun Google terhubung ke layanan Anda dengan cepat, lancar, dan aman. Anda dapat memilih untuk menerapkan Penautan Akun Google untuk membagikan data pengguna dari platform Anda ke aplikasi dan layanan Google.
Protokol OAuth 2.0 yang aman memungkinkan Anda menautkan Akun Google pengguna dengan aman ke akunnya di platform Anda, sehingga memberikan akses ke layanan Anda bagi aplikasi dan perangkat Google.
Pengguna dapat menautkan atau membatalkan tautan akun mereka dan secara opsional membuat akun baru di platform Anda dengan Penautan Akun Google.
Kasus penggunaan
Beberapa alasan untuk menerapkan Penautan Akun Google adalah:
Membagikan data pengguna dari platform Anda ke aplikasi dan layanan Google.
Lakukan integrasi dengan Google Shopping dan platform AI (Penelusuran, Gemini) menggunakan Universal Commerce Protocol (UCP).
Putar konten video dan film Anda menggunakan Google TV.
Mengelola dan mengontrol perangkat yang terhubung ke Smart Home Google menggunakan aplikasi Google Home dan Asisten Google, "Ok Google, nyalakan lampu".
Buat pengalaman dan fungsi Asisten Google yang disesuaikan pengguna dengan Tindakan Percakapan, "Ok Google, pesan kopi seperti biasa dari Starbucks".
Memungkinkan pengguna mendapatkan reward dengan menonton live stream yang memenuhi syarat di YouTube setelah menautkan Akun Google mereka ke akun partner reward.
Mengisi otomatis akun baru selama pendaftaran dengan data yang dibagikan secara konsensual dari profil Akun Google.
Kemampuan & Persyaratan
Matriks berikut menentukan dukungan dan rekomendasi untuk setiap alur penautan.
| Menautkan Flow | Fitur Standar | Fitur UCP |
|---|---|---|
| App Flip | Disarankan | Disarankan |
| Penautan yang disederhanakan | Disarankan | Disarankan |
| Penautan OAuth | Wajib (Pengganti) | Wajib (Pengganti) |
| OAuth 2.1 | Disarankan | Disarankan |
Meningkatkan privasi pengguna dengan menentukan cakupan kustom untuk membagikan hanya data yang diperlukan, meningkatkan kepercayaan pengguna dengan menentukan secara jelas cara data mereka digunakan.
Akses ke data dan layanan yang dihosting di platform Anda dapat dicabut dengan membatalkan tautan akun. Dengan menerapkan endpoint pencabutan token opsional, Anda dapat tetap tersinkron dengan peristiwa yang dimulai Google, sementara Perlindungan Lintas Akun(RISC) memungkinkan Anda memberi tahu Google tentang peristiwa pembatalan tautan yang terjadi di platform Anda.
Alur penautan akun
Ada 3 alur Penautan Akun Google yang semuanya berbasis OAuth dan mengharuskan Anda mengelola atau mengontrol otorisasi yang sesuai dengan OAuth 2.0 dan endpoint pertukaran token.
Selama proses penautan, Anda menerbitkan token akses ke Google untuk setiap Akun Google setelah mendapatkan izin pemegang akun untuk menautkan akun mereka dan membagikan data.
Penautan OAuth
Ini adalah alur penautan OAuth yang mengarahkan pengguna ke situs Anda untuk penautan. Pengguna dialihkan ke situs Anda untuk login ke akun mereka. Setelah login, pengguna menyetujui untuk membagikan datanya, di layanan Anda, kepada Google. Pada saat itu, Akun Google pengguna dan layanan Anda akan ditautkan.
Penautan OAuth mendukung kode otorisasi dan alur OAuth implisit. Layanan Anda harus menghosting endpoint otorisasi yang kompatibel dengan OAuth 2.0 untuk alur implisit, dan harus mengekspos endpoint pertukaran token dan otorisasi saat menggunakan alur kode otorisasi.
Gambar 1. Penautan Akun di ponsel pengguna dengan penautan OAuth
Penautan App Flip berbasis OAuth ('App Flip')
Alur OAuth yang mengarahkan pengguna ke aplikasi Anda untuk penautan.
Penautan Flip Aplikasi Berbasis OAuth memandu pengguna saat mereka berpindah antara aplikasi seluler Android atau iOS terverifikasi Anda dan platform Google untuk meninjau usulan perubahan akses data dan memberikan izin mereka untuk menautkan akun mereka di platform Anda dengan Akun Google mereka. Untuk mengaktifkan App Flip, layanan Anda harus mendukung penautan OAuth atau Penautan Login dengan Google berbasis OAuth menggunakan alur kode otorisasi.
Pertukaran Aplikasi didukung untuk Android dan iOS.
Cara kerjanya:
Aplikasi Google memeriksa apakah aplikasi Anda diinstal di perangkat pengguna:
- Jika aplikasi ditemukan, pengguna akan "dialihkan" ke aplikasi Anda. Aplikasi Anda mengumpulkan izin dari pengguna untuk menautkan akun dengan Google, lalu "dialihkan kembali" ke platform Google.
- Jika aplikasi tidak ditemukan atau terjadi error selama proses penautan peralihan aplikasi, pengguna akan dialihkan ke alur penautan yang Disederhanakan atau OAuth.
Gambar 2. Penautan Akun di ponsel pengguna dengan App Flip
Penautan Sederhana Berbasis OAuth ('Sederhana')
Penautan yang disederhanakan untuk Login dengan Google berbasis OAuth menambahkan Login dengan Google di atas penautan OAuth, sehingga pengguna dapat menyelesaikan proses penautan tanpa keluar dari platform Google, sehingga mengurangi hambatan dan pengabaian.
Penautan Sederhana Berbasis OAuth menawarkan
pengalaman pengguna terbaik dengan login, pembuatan akun, dan penautan akun yang lancar
dengan menggabungkan Login dengan Google dan penautan OAuth. Layanan Anda harus mendukung endpoint pertukaran token dan otorisasi yang kompatibel dengan OAuth 2.0.
Selain itu, endpoint pertukaran token Anda harus mendukung pernyataan Token Web JSON (JWT) dan menerapkan maksud check, create, dan get.
Cara kerjanya:
Google menegaskan akun pengguna dan meneruskan informasi ini kepada Anda:
- Jika akun pengguna ada di database Anda, pengguna berhasil menautkan Akun Google-nya dengan akunnya di layanan Anda.
- Jika tidak ada akun untuk pengguna di database Anda, pengguna dapat membuat akun pihak ketiga baru dengan informasi yang diberikan Google: email, nama, dan foto profil, atau memilih untuk login dan menautkan dengan email lain (pengguna harus login ke layanan Anda menggunakan penautan OAuth).
Gambar 3. Penautan Akun di ponsel pengguna dengan Penautan yang Disederhanakan
Alur mana yang sebaiknya Anda gunakan?
Sebaiknya terapkan semua alur untuk memastikan pengguna mendapatkan pengalaman penautan terbaik. Alur yang Disederhanakan dan Pengalihan aplikasi mengurangi hambatan penautan karena pengguna dapat menyelesaikan proses penautan dalam beberapa langkah saja. Alur penautan OAuth memiliki tingkat upaya terendah dan merupakan tempat yang tepat untuk memulai, setelah itu Anda dapat menambahkan alur penautan lainnya.
Bekerja dengan token
Penautan Akun Google didasarkan pada standar industri OAuth 2.0.
Anda menerbitkan token akses ke Google untuk setiap Akun Google setelah mendapatkan izin pemegang akun untuk menautkan akun mereka dan membagikan data.
Jenis token
OAuth 2.0 menggunakan string yang disebut token untuk berkomunikasi antara agen pengguna, aplikasi klien, dan server OAuth 2.0.
Tiga jenis token OAuth 2.0 dapat digunakan selama penautan akun:
Kode otorisasi. Token berumur pendek yang dapat ditukar dengan token akses dan refresh. Untuk tujuan keamanan, Google memanggil endpoint otorisasi Anda untuk mendapatkan kode sekali pakai atau kode yang masa berlakunya sangat singkat.
Token akses. Token yang memberikan akses pembawa ke resource. Untuk membatasi eksposur yang dapat terjadi akibat hilangnya token ini, token tersebut memiliki masa aktif terbatas, biasanya berakhir setelah sekitar satu jam.
Token refresh. Token yang memiliki masa aktif yang lama yang dapat ditukar dengan token akses baru saat masa berlaku token akses berakhir. Saat layanan Anda terintegrasi dengan Google, token ini disimpan dan digunakan secara eksklusif oleh Google. Google memanggil endpoint pertukaran token Anda untuk menukar token refresh dengan token akses, yang pada gilirannya digunakan untuk mengakses data pengguna.
Penanganan token
Kondisi persaingan dalam lingkungan berklaster dan pertukaran klien-server dapat menghasilkan skenario penanganan error dan pengaturan waktu yang kompleks saat bekerja dengan token. Contoh:
- Anda menerima permintaan untuk token akses baru, dan Anda mengeluarkan token akses baru. Secara bersamaan, Anda menerima permintaan akses ke resource layanan Anda menggunakan token akses sebelumnya yang belum habis masa berlakunya.
- Respons token refresh Anda belum diterima (atau tidak pernah diterima) oleh Google. Sementara itu, token refresh yang sebelumnya valid digunakan dalam permintaan dari Google.
Permintaan dan balasan dapat tiba dalam urutan apa pun, atau tidak sama sekali karena layanan asinkron yang berjalan di cluster, perilaku jaringan, atau cara lainnya.
Status bersama yang langsung dan sepenuhnya konsisten, baik di dalam maupun di antara sistem penanganan token Anda dan Google, tidak dapat dijamin. Beberapa token yang valid dan belum habis masa berlakunya dapat ada bersama dalam atau di seluruh sistem dalam jangka waktu singkat. Untuk meminimalkan dampak negatif pada pengguna, sebaiknya lakukan hal berikut:
- Menerima token akses yang belum habis masa berlakunya, bahkan setelah token yang lebih baru dikeluarkan.
- Gunakan alternatif untuk Refresh Token Rotation.
- Mendukung beberapa token akses dan refresh yang valid secara bersamaan. Untuk keamanan, Anda harus membatasi jumlah token dan masa berlaku token.
Penanganan pemeliharaan dan gangguan
Selama pemeliharaan atau gangguan yang tidak direncanakan, Google mungkin tidak dapat memanggil endpoint otorisasi atau pertukaran token Anda untuk mendapatkan token akses dan refresh.
Endpoint Anda harus merespons dengan kode error 503 dan isi kosong. Dalam
kasus ini, Google mencoba kembali permintaan pertukaran token yang gagal untuk jangka waktu terbatas. Dengan catatan bahwa Google dapat memperoleh token akses dan refresh di lain waktu, permintaan yang gagal tidak terlihat oleh pengguna.
Permintaan token akses yang gagal akan menghasilkan error yang terlihat, jika dimulai oleh pengguna. Pengguna akan diminta untuk mencoba lagi kegagalan penautan jika alur OAuth 2.0 implisit digunakan.
Rekomendasi
Ada banyak solusi untuk meminimalkan dampak pemeliharaan. Beberapa opsi yang perlu dipertimbangkan:
Pertahankan layanan yang ada dan arahkan sejumlah kecil permintaan ke layanan yang baru diperbarui. Migrasikan semua permintaan hanya setelah mengonfirmasi fungsi yang diharapkan.
Kurangi jumlah permintaan token selama periode pemeliharaan:
Batasi periode pemeliharaan hingga kurang dari masa berlaku token akses.
Meningkatkan masa berlaku token akses untuk sementara:
- Tingkatkan masa berlaku token menjadi lebih lama dari periode pemeliharaan.
- Tunggu dua kali durasi masa aktif token akses Anda, sehingga pengguna dapat menukarkan token berdurasi singkat dengan token berdurasi lebih lama.
- Masuk ke pemeliharaan.
- Merespons permintaan token dengan kode error
503dan isi kosong. - Keluar dari pemeliharaan.
- Mengurangi masa aktif token kembali ke normal.
Penautan Persisten
Penautan Persisten adalah persyaratan inti untuk integrasi yang stabil. Hal ini memastikan bahwa akun pengguna tetap ditautkan meskipun terjadi kegagalan jaringan sementara atau pembaruan kredensial berkala.
Untuk menerapkan penautan persisten, gunakan pendekatan "sliding window": perpanjang masa berlaku Token Refresh yang ada, bukan menggantinya (merujuk ke RFC 6749 Bagian 6). Hal ini mencegah kondisi persaingan dan pembatalan tautan yang tidak disengaja yang dapat terjadi jika Token Refresh baru dikeluarkan, tetapi tidak berhasil diterima atau disimpan oleh Google.
Mendaftar dengan Google
Kami memerlukan detail penyiapan OAuth 2.0 Anda dan kredensial yang akan dibagikan untuk mengaktifkan penautan akun. Lihat pendaftaran untuk mengetahui detailnya.