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 diperlukan aplikasi Anda.
Untuk definisi istilah yang ditemukan di halaman ini, lihat Ringkasan autentikasi dan otorisasi.
Pilih kredensial akses yang tepat untuk Anda
Kredensial yang diperlukan bergantung pada jenis data, platform, dan metode akses aplikasi Anda. Ada tiga jenis kredensial yang tersedia:
Kasus penggunaan | Metode autentikasi | Tentang metode autentikasi ini |
---|---|---|
Akses 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. | Client ID OAuth | Memerlukan aplikasi Anda untuk meminta dan menerima izin dari pengguna. |
Mengakses data yang merupakan milik aplikasi Anda sendiri atau mengakses resource atas nama pengguna Google Workspace atau Cloud Identity melalui delegasi seluruh domain. | Service account | Saat 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, serta 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 detail selengkapnya, lihat
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 agar dapat digunakan dalam kode aplikasi. Kunci API juga dapat ditemukan di bagian "API keys" pada kredensial project Anda.
- Klik Batasi kunci untuk memperbarui setelan lanjutan dan membatasi penggunaan kunci API Anda. Untuk mengetahui detail selengkapnya, lihat Menerapkan pembatasan kunci API.
Kredensial client ID OAuth
Untuk mengautentikasi pengguna akhir dan mengakses data pengguna di aplikasi, Anda perlu membuat satu atau beberapa Client ID OAuth 2.0. Client ID digunakan untuk mengidentifikasi satu aplikasi ke server OAuth Google. Jika aplikasi Anda berjalan di beberapa platform, Anda harus membuat client ID terpisah untuk setiap platform.Pilih jenis aplikasi untuk mendapatkan petunjuk spesifik tentang cara membuat client ID OAuth:
Aplikasi web
- Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create Credentials > OAuth client ID.
- 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 Asal JavaScript yang diotorisasi, klik Tambahkan URI. Kemudian, masukkan URI yang akan digunakan untuk permintaan browser. Atribut ini mengidentifikasi domain tempat aplikasi Anda dapat mengirim permintaan API ke server OAuth 2.0.
- Aplikasi sisi server (Java, Python, dan lainnya)–Di bagian URI pengalihan yang diberi otorisasi, klik Tambahkan URI. Kemudian, masukkan URI endpoint tempat server OAuth 2.0 dapat mengirim respons.
- Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
Catat Client ID. Rahasia klien tidak digunakan untuk aplikasi Web.
- Klik Oke. Kredensial yang baru dibuat akan muncul di bagian Client ID OAuth 2.0.
Android
- Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create Credentials > OAuth client ID.
- Klik Application type > Android.
- Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
- Di kolom "Package name", masukkan nama paket dari file
AndroidManifest.xml
Anda. - Di kolom "Sidik jari sertifikat SHA-1", masukkan sidik jari sertifikat SHA-1 yang dibuat.
- Klik Buat. Layar klien OAuth yang dibuat akan muncul, yang menampilkan Client ID baru Anda.
- Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
iOS
- Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create Credentials > OAuth client ID.
- Klik Jenis aplikasi > iOS.
- Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
- Di kolom "ID Paket", 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 "ID Tim", masukkan string unik 10 karakter yang dibuat oleh Apple dan ditetapkan untuk tim Anda.
- Klik Buat. Layar yang menampilkan klien OAuth yang dibuat akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
- Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Aplikasi Chrome
- Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create Credentials > OAuth client ID.
- Klik Jenis aplikasi > Aplikasi Chrome.
- Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
- Di kolom "Application ID", masukkan string ID unik 32 karakter aplikasi Anda. Anda dapat menemukan nilai ID ini di URL Chrome Web Store aplikasi dan di Dasbor Developer Chrome Web Store.
- Klik Buat. Layar yang dibuat klien OAuth akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
- Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Aplikasi desktop
- Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create Credentials > OAuth client ID.
- Klik Jenis aplikasi > Aplikasi desktop.
- Di kolom Name, ketik nama untuk kredensial. Nama ini hanya ditampilkan di konsol Google Cloud.
- Klik Buat. Layar yang menampilkan klien OAuth yang dibuat akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
- Klik Oke. Kredensial yang baru dibuat akan muncul di bagian Client ID OAuth 2.0.
TV & Perangkat Input Terbatas
- Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create Credentials > OAuth client ID.
- Klik Jenis aplikasi > TV & Perangkat Input Terbatas.
- Di kolom "Nama", ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di konsol Google Cloud.
- Klik Buat. Layar yang menampilkan klien OAuth yang dibuat akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
- Klik Oke. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".
Universal Windows Platform (UWP)
- Di konsol Google Cloud, buka Menu > APIs & Services > Credentials.
- Klik Create Credentials > OAuth client ID.
- Klik Jenis aplikasi > Universal Windows Platform (UWP).
- Di kolom "Nama", ketik nama untuk kredensial tersebut. 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 Partner Center.
- Klik Buat. Layar yang menampilkan klien OAuth yang dibuat akan muncul, yang menampilkan Client ID dan Rahasia klien baru Anda.
- Klik Oke. 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 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 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 untuk memberikan akses ke resource project Google Cloud Anda. Untuk detail selengkapnya, lihat Memberikan, mengubah, dan mencabut akses ke resource.
Menetapkan peran ke akun layanan
Anda harus menetapkan peran bawaan atau khusus untuk akun layanan oleh akun administrator super.
Di konsol Google Admin, buka Menu > Akun > Peran admin.
Arahkan kursor ke peran yang ingin ditetapkan, lalu klik Tetapkan admin.
Klik Tetapkan akun layanan.
Masukkan alamat email akun layanan.
Klik Tambahkan > Tetapkan peran.
Membuat kredensial untuk akun layanan
Anda perlu mendapatkan kredensial dalam bentuk pasangan kunci publik/pribadi. Kredensial ini digunakan oleh kode Anda untuk memberikan otorisasi 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 Kunci > Tambahkan kunci > Buat kunci baru.
- Pilih JSON, lalu klik Create.
Pasangan kunci umum/pribadi baru Anda dibuat dan didownload ke komputer sebagai file baru. Simpan file JSON yang didownload sebagai
credentials.json
di direktori kerja Anda. File ini adalah satu-satunya salinan kunci ini. Untuk informasi tentang cara menyimpan kunci 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 otorisasi tingkat domain di konsol Google Workspace Admin oleh akun administrator super. Untuk informasi selengkapnya, lihat Mendelegasikan otoritas tingkat domain ke akun layanan.Untuk menyiapkan delegasi otoritas di seluruh domain untuk akun layanan:
- Di konsol Google Cloud, buka Menu > IAM & Admin > Service Accounts.
- Pilih akun layanan Anda.
- Klik Tampilkan setelan lanjutan.
- Di bagian "Domain-wide delegation", temukan "Client ID" akun layanan Anda. Klik Salin untuk menyalin nilai client ID ke papan klip.
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 berikut.
Jika Anda tidak memiliki akses administrator super ke akun Google Workspace yang relevan, hubungi administrator super untuk akun tersebut dan kirimkan Client ID 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 client ID 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 dengan 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.