Kredensial digunakan untuk mendapatkan token akses dari server otorisasi Google sehingga aplikasi Anda dapat memanggil Google Workspace API. Panduan ini menjelaskan cara memilih dan menyiapkan kredensial yang dibutuhkan aplikasi Anda.
Untuk definisi istilah yang ada di halaman ini, lihat Ringkasan autentikasi dan otorisasi.
Pilih kredensial akses yang tepat untuk Anda
Kredensial yang diperlukan bergantung pada jenis data, platform, dan metodologi akses aplikasi Anda. Ada tiga jenis kredensial yang tersedia:
Kasus penggunaan | Metode autentikasi | Tentang metode autentikasi ini |
---|---|---|
Mengakses data yang tersedia secara publik secara anonim di aplikasi Anda. | Kunci API | Pastikan API yang ingin Anda gunakan mendukung kunci API sebelum menggunakan metode autentikasi ini. |
Mengakses data pengguna seperti alamat email atau usia mereka. | ID klien OAuth | Mewajibkan aplikasi Anda untuk meminta dan menerima izin dari pengguna. |
Mengakses data milik aplikasi Anda sendiri atau mengakses resource atas nama pengguna Google Workspace atau Cloud Identity melalui delegasi tingkat domain. | Service account | Saat aplikasi melakukan autentikasi sebagai akun layanan, aplikasi memiliki akses ke semua resource yang boleh diakses oleh akun layanan. |
Kredensial kunci API
Kunci API adalah string panjang yang berisi huruf besar dan kecil, angka,
garis bawah, dan tanda hubung, seperti AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe
.
Metode autentikasi ini digunakan untuk mengakses data yang tersedia secara publik secara anonim, seperti file Google Workspace yang dibagikan menggunakan setelan berbagi "Siapa saja di Internet dengan link ini". Untuk mengetahui detail selengkapnya, lihat bagian Menggunakan kunci API.
Untuk membuat kunci API:
- Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create credentials > API key.
- Kunci API baru Anda akan ditampilkan.
- Klik Salin untuk menyalin kunci API Anda untuk digunakan dalam kode aplikasi Anda. Kunci API juga dapat ditemukan di bagian "API Keys" pada kredensial project Anda.
- Untuk mencegah penggunaan tanpa izin, sebaiknya batasi tempat dan API yang dapat menggunakan kunci API. Untuk mengetahui detail selengkapnya, lihat Menambahkan pembatasan API.
Kredensial ID klien OAuth
Untuk mengautentikasi pengguna akhir dan mengakses data pengguna di aplikasi Anda, Anda perlu membuat satu atau beberapa ID Klien OAuth 2.0. Client ID digunakan untuk mengidentifikasi aplikasi tunggal ke server OAuth Google. Jika aplikasi Anda berjalan di beberapa platform, Anda harus membuat client ID terpisah untuk setiap platform.Pilih jenis aplikasi Anda untuk mendapatkan petunjuk khusus tentang cara membuat client ID OAuth:
Aplikasi web
- Di Konsol Google Cloud, buka Menu > > Clients.
- Klik Buat Klien.
- Klik Application type > Web application.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Tambahkan URI resmi yang terkait dengan aplikasi Anda:
- Aplikasi sisi klien (JavaScript)–Di bagian Authorized JavaScript origins, klik Add URI. Kemudian, masukkan URI yang akan digunakan untuk permintaan browser. Parameter ini mengidentifikasi domain tempat aplikasi Anda dapat mengirim permintaan API ke server OAuth 2.0.
- Aplikasi sisi server (Java, Python, dan lainnya)–Di bagian Authorized redirect URIs, klik Add URI. Kemudian, masukkan URI endpoint yang dapat digunakan server OAuth 2.0 untuk mengirim respons.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian Client ID OAuth 2.0.
Catat ID Klien. Rahasia klien tidak digunakan untuk Aplikasi web.
Android
- Di Konsol Google Cloud, buka Menu > > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > Android.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Di kolom "Nama paket", masukkan nama paket dari file
AndroidManifest.xml
Anda. - Di kolom "SHA-1 certificate fingerprint", masukkan sidik jari sertifikat SHA-1 yang dihasilkan.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
iOS
- Di Konsol Google Cloud, buka Menu > > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > iOS.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Di kolom "Bundle ID", masukkan ID paket seperti yang tercantum dalam file
Info.plist
aplikasi. - Opsional: Jika aplikasi Anda muncul di Apple App Store, masukkan ID App Store.
- Opsional: Di kolom "Team ID", masukkan string unik yang terdiri atas 10 karakter yang dibuat oleh Apple dan ditetapkan bagi tim Anda.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Ekstensi Chrome
- Di Konsol Google Cloud, buka Menu > > Clients.
- Klik Buat Klien.
- Klik Application type > Chrome Extension.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Di kolom "ID Item", masukkan string ID 32 karakter unik aplikasi Anda. Anda dapat menemukan nilai ID ini di URL Chrome Web Store aplikasi Anda dan di Dasbor Pengembang Chrome Web Store.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Aplikasi desktop
- Di Konsol Google Cloud, buka Menu > > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > Aplikasi desktop.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
TV & Perangkat Input Terbatas
- Di Konsol Google Cloud, buka Menu > > Clients.
- Klik Buat Klien.
- Klik Jenis aplikasi > TV & perangkat Input Terbatas.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Universal Windows Platform (UWP)
- Di Konsol Google Cloud, buka Menu > > Clients.
- Klik Buat Klien.
- Klik Application type > Universal Windows Platform (UWP).
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Di kolom "ID Toko", masukkan nilai ID Microsoft Store 12 karakter yang unik untuk aplikasi Anda. Anda dapat menemukan ID ini di URL Microsoft Store aplikasi Anda dan di Pusat Partner.
- Klik Buat.
Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Kredensial akun layanan
Akun layanan adalah jenis akun khusus yang digunakan oleh aplikasi, bukan oleh pengguna. Anda dapat menggunakan akun layanan untuk mengakses data atau melakukan tindakan oleh akun robot, atau untuk mengakses data atas nama pengguna Google Workspace atau Cloud Identity. Untuk mengetahui informasi selengkapnya, lihat Memahami akun layanan.Membuat akun layanan
Konsol Google Cloud
- Di Konsol Google Cloud, buka Menu > IAM & Admin > Service Accounts.
- Klik Create service account.
- Isi detail akun layanan, lalu klik Buat dan lanjutkan.
- Opsional: Tetapkan peran ke akun layanan Anda untuk memberikan akses ke resource project Google Cloud Anda. Untuk mengetahui detail selengkapnya, lihat Memberikan, mengubah, dan mencabut akses ke resource.
- Klik Lanjutkan.
- Opsional: Masukkan pengguna atau grup yang dapat mengelola dan melakukan tindakan dengan akun layanan ini. Untuk mengetahui detail selengkapnya, lihat Mengelola peniruan identitas akun layanan.
- Klik Selesai. Catat alamat email untuk akun layanan.
gcloud CLI
- Buat akun layanan:
gcloud iam service-accounts create
SERVICE_ACCOUNT_NAME
\ --display-name="SERVICE_ACCOUNT_NAME
" - Opsional: Tetapkan peran ke akun layanan Anda untuk memberikan akses ke resource project Google Cloud Anda. Untuk mengetahui detail selengkapnya, lihat Memberikan, mengubah, dan mencabut akses ke resource.
Menetapkan peran ke akun layanan
Anda harus menetapkan peran standar atau khusus ke akun layanan oleh akun administrator super.
Di konsol Google Admin, buka Menu > Akun > Peran admin.
Arahkan kursor ke peran yang ingin Anda tetapkan, lalu klik Tetapkan admin.
Klik Tetapkan akun layanan.
Masukkan alamat email akun layanan.
Klik Tambahkan > Tetapkan peran.
Membuat kredensial untuk akun layanan
Anda harus mendapatkan kredensial dalam bentuk pasangan kunci publik/pribadi. Kredensial ini digunakan oleh kode Anda untuk mengizinkan tindakan akun layanan dalam aplikasi Anda.Untuk mendapatkan kredensial akun layanan Anda:
- Di Konsol Google Cloud, buka Menu > IAM & Admin > Service Accounts.
- Pilih akun layanan Anda.
- Klik Keys > Add key > Create new key.
- Pilih JSON, lalu klik Buat.
Pasangan kunci umum/pribadi baru Anda dibuat dan didownload ke komputer Anda sebagai file baru. Simpan file JSON yang didownload sebagai
credentials.json
di direktori kerja Anda. File ini adalah satu-satunya salinan kunci ini. Untuk mengetahui informasi tentang cara menyimpan kunci Anda dengan aman, lihat Mengelola kunci akun layanan. - Klik Tutup.
Opsional: Menyiapkan delegasi tingkat domain untuk akun layanan
Untuk memanggil API atas nama pengguna di organisasi Google Workspace, akun layanan Anda harus diberi delegasi otoritas tingkat domain di konsol Admin Google Workspace oleh akun administrator super. Untuk mengetahui informasi selengkapnya, lihat Mendelegasikan otoritas tingkat domain ke akun layanan.Untuk menyiapkan pendelegasian kewenangan tingkat domain untuk akun layanan:
- Di Konsol Google Cloud, buka Menu > IAM & Admin > Service Accounts.
- Pilih akun layanan Anda.
- Klik Tampilkan setelan lanjutan.
- Di bagian "Delegasi tingkat domain", temukan "ID Klien" akun layanan Anda. Klik Salin untuk menyalin nilai ID klien ke papan klip Anda.
Jika Anda memiliki akses administrator super ke akun Google Workspace yang relevan, klik Lihat Konsol Admin Google Workspace, lalu login menggunakan akun pengguna administrator super dan lanjutkan mengikuti langkah-langkah ini.
Jika Anda tidak memiliki akses administrator super ke akun Google Workspace yang relevan, hubungi administrator super untuk akun tersebut dan kirimkan ID Klien akun layanan Anda dan daftar Cakupan OAuth agar mereka dapat menyelesaikan langkah-langkah berikut di konsol Admin.
- Di konsol Google Admin, buka Menu > Keamanan > Kontrol data dan akses > Kontrol API.
- Klik Kelola Delegasi Tingkat Domain.
- Klik Tambahkan baru.
- Di kolom "Client ID", tempelkan ID klien yang sebelumnya Anda salin.
- Di kolom "OAuth Scopes", masukkan daftar cakupan yang dipisahkan koma yang diperlukan oleh aplikasi Anda. Ini adalah kumpulan cakupan yang sama yang Anda tentukan saat mengonfigurasi layar izin OAuth.
- Klik Authorize.
Langkah berikutnya
Anda siap mengembangkan aplikasi di Google Workspace. Tinjau daftar produk developer Google Workspace dan cara menemukan bantuan.