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 metodologi akses aplikasi Anda. Ada tiga jenis jenis kredensial yang tersedia:
Kasus penggunaan | Metode autentikasi | Tentang metode autentikasi ini |
---|---|---|
Mengakses data yang tersedia secara publik dan 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 | Mewajibkan aplikasi Anda meminta dan menerima izin dari pengguna. |
Mengakses data milik aplikasi Anda atau mengakses resource atas nama pengguna Google Workspace atau Cloud Identity melalui delegasi tingkat domain. | Service account | Jika aplikasi diautentikasi sebagai akun layanan, aplikasi memiliki akses ke semua resource yang dapat 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
yang memiliki link ini". Untuk mengetahui detail selengkapnya, baca
Menggunakan kunci API.
Untuk membuat kunci API:
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Create credentials > API key.
- Kunci API baru Anda akan ditampilkan.
- Klik Salin untuk menyalin kunci API Anda agar dapat digunakan di kode aplikasi Anda. Kunci API juga dapat ditemukan di bagian "Kunci API" pada kredensial project Anda.
- Klik Restrict key untuk memperbarui setelan lanjutan dan membatasi penggunaan kunci API Anda. Untuk detail selengkapnya, lihat Menerapkan pembatasan kunci API.
Kredensial client ID OAuth
Untuk mengautentikasi sebagai pengguna akhir dan mengakses data pengguna di aplikasi, Anda harus 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 mengetahui petunjuk spesifik tentang cara membuat client ID OAuth:
Aplikasi web
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Buat Kredensial > Client ID OAuth.
- Klik Jenis aplikasi > Aplikasi web.
- Di kolom Name, ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di Google Cloud Console.
- Tambahkan URI resmi yang terkait dengan aplikasi Anda:
- Aplikasi sisi klien (JavaScript)–Di bagian Asal JavaScript resmi, klik Tambahkan URI. Kemudian, masukkan URI yang akan digunakan untuk permintaan browser. 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 sah, klik Tambahkan URI. Kemudian, masukkan URI endpoint yang dapat digunakan oleh server OAuth 2.0 untuk mengirim respons.
- Klik Create. Layar klien OAuth yang dibuat akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
Catat Client ID. Rahasia klien tidak digunakan untuk aplikasi Web.
- Klik OK. Kredensial yang baru dibuat muncul di Client ID OAuth 2.0.
Android
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Buat Kredensial > Client ID OAuth.
- Klik Jenis aplikasi > Android.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Google Cloud Console.
- 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 dihasilkan.
- Klik Create. Layar klien OAuth yang dibuat akan muncul, yang menunjukkan Client ID baru Anda.
- Klik OK. Kredensial yang baru dibuat muncul di bagian "Client ID OAuth 2.0".
iOS
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Buat Kredensial > Client ID OAuth.
- Klik Jenis aplikasi > iOS.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Google Cloud Console.
- 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 10 karakter unik, yang dibuat oleh Apple dan ditugaskan ke tim Anda.
- Klik Create. Layar klien OAuth yang dibuat akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
- Klik OK. Kredensial yang baru dibuat muncul di bagian "Client ID OAuth 2.0".
Aplikasi Chrome
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Buat Kredensial > Client ID OAuth.
- Klik Jenis aplikasi > Aplikasi Chrome.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Google Cloud Console.
- Di kolom "ID Aplikasi", masukkan string ID 32 karakter unik aplikasi Anda. Anda dapat menemukan nilai ID ini di URL Chrome Web Store aplikasi dan di Dasbor Developer Chrome Web Store.
- Klik Create. Layar klien OAuth yang dibuat akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
- Klik OK. Kredensial yang baru dibuat muncul di bagian "Client ID OAuth 2.0".
Aplikasi desktop
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Buat Kredensial > Client ID OAuth.
- Klik Jenis aplikasi > Aplikasi desktop.
- Di kolom Name, ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di Google Cloud Console.
- Klik Create. Layar klien OAuth yang dibuat akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
- Klik OK. Kredensial yang baru dibuat muncul di ID Klien OAuth 2.0.
TV & Perangkat Input Terbatas
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Buat Kredensial > Client ID OAuth.
- Klik Jenis aplikasi > TV & Perangkat Input Terbatas.
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Google Cloud Console.
- Klik Create. Layar klien OAuth yang dibuat akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
- Klik OK. Kredensial yang baru dibuat muncul di bagian "Client ID OAuth 2.0".
Universal Windows Platform (UWP)
- Di Google Cloud Console, buka Menu > API & Layanan > Kredensial.
- Klik Buat Kredensial > Client ID OAuth.
- Klik Jenis aplikasi > Platform Windows Universal (UWP).
- Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Google Cloud Console.
- Di kolom "ID Toko", masukkan nilai unik Microsoft Store ID untuk 12 karakter untuk aplikasi Anda. Anda dapat menemukan ID ini di URL Microsoft Store aplikasi dan di Pusat Partner.
- Klik Create. Layar klien OAuth yang dibuat akan muncul, yang menunjukkan Client ID dan Rahasia klien baru Anda.
- Klik OK. Kredensial yang baru dibuat muncul di bagian "Client ID OAuth 2.0".
Kredensial akun layanan
Akun layanan adalah jenis akun khusus yang digunakan aplikasi, bukan orang. Anda dapat menggunakan akun layanan untuk mengakses data atau melakukan tindakan dengan akun robot, atau untuk mengakses data atas nama pengguna Google Workspace atau Cloud Identity. Untuk informasi selengkapnya, lihat Memahami akun layanan.Membuat akun layanan
- Di Google Cloud Console, buka Menu > IAM & Admin > Akun Layanan.
- 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. Untuk mengetahui detail selengkapnya, lihat Memberikan, mengubah, dan mencabut akses ke resource.
- Klik Continue.
- Opsional: Masukkan pengguna atau grup yang dapat mengelola dan melakukan tindakan dengan akun layanan ini. Untuk detail selengkapnya, lihat Mengelola peniruan identitas akun layanan.
- Klik Selesai. Catat alamat email untuk akun layanan.
Menetapkan peran ke akun layanan
Anda harus menetapkan peran bawaan atau kustom ke 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 harus mendapatkan kredensial dalam bentuk pasangan kunci publik/pribadi. Kredensial ini digunakan oleh kode Anda untuk mengizinkan tindakan akun layanan dalam aplikasi Anda.Cara mendapatkan kredensial untuk akun layanan Anda:
- Di Google Cloud Console, buka Menu > IAM & Admin > Akun Layanan.
- Pilih akun layanan Anda.
- Klik Keys > Add key > Create new key.
- Pilih JSON, lalu klik Buat.
Pasangan kunci umum/pribadi baru Anda akan dibuat dan didownload ke mesin Anda sebagai file baru. File ini adalah satu-satunya salinan kunci ini. Untuk informasi tentang cara menyimpan kunci Anda dengan aman, lihat Mengelola kunci akun layanan.
- Klik Tutup.
Opsional: Menyiapkan delegasi di seluruh domain untuk akun layanan
Untuk memanggil API atas nama pengguna di organisasi Google Workspace, akun layanan Anda harus mendapatkan delegasi seluruh domain di konsol Admin Google Workspace oleh akun administrator super. Untuk informasi selengkapnya, lihat Mendelegasikan otoritas seluruh domain ke akun layanan.Untuk menyiapkan delegasi otorisasi seluruh domain untuk akun layanan:
- Di Google Cloud Console, buka Menu > IAM & Admin > Akun Layanan.
- Pilih akun layanan Anda.
- Klik Tampilkan setelan lanjutan.
- Di bagian "Delegasi tingkat domain", temukan "ID Klien" pada 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 terus ikuti 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 dan daftar Cakupan OAuth akun layanan Anda sehingga 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.
- Pada kolom "Client ID", tempelkan client ID yang sebelumnya Anda salin.
- Di kolom "Cakupan OAuth", 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 Otorisasi.
Langkah berikutnya
Anda siap untuk mengembangkan aplikasi di Google Workspace. Tinjau daftar produk developer Google Workspace dan cara menemukan bantuan.