Membuat kredensial akses

Kredensial digunakan untuk mendapatkan token akses dari server otorisasi Google agar aplikasi Anda dapat memanggil Google Workspace API. Panduan ini menjelaskan cara memilih dan menyiapkan kredensial yang dibutuhkan 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 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. Client ID OAuth Mewajibkan aplikasi Anda untuk meminta dan menerima izin dari pengguna.
Akses data milik aplikasi Anda sendiri atau akses resource atas nama pengguna Google Workspace atau Cloud Identity melalui delegasi tingkat domain. Service account Jika melakukan autentikasi sebagai akun layanan, aplikasi akan 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 yang memiliki link ini". Untuk mengetahui detail selengkapnya, lihat Menggunakan kunci API.

Untuk membuat kunci API:

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Create credentials > API key.
  3. Kunci API baru Anda akan ditampilkan.
    • Klik Salin untuk menyalin kunci API yang akan digunakan dalam 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. Untuk detail selengkapnya, lihat Menerapkan pembatasan kunci API.

Kredensial client ID OAuth

Untuk mengautentikasi sebagai pengguna akhir dan mengakses data pengguna di aplikasi Anda, 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 khusus tentang cara membuat client ID OAuth:

Aplikasi web

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Buat Kredensial > Client ID OAuth.
  3. Klik Jenis aplikasi > Aplikasi web.
  4. Di kolom Name, ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di Konsol Google Cloud.
  5. Tambahkan URI resmi yang terkait dengan aplikasi Anda:
    • Aplikasi sisi klien (JavaScript)–Pada Asal JavaScript resmi, 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)–Pada URI pengalihan yang diotorisasi, klik Tambahkan URI. Kemudian, masukkan URI endpoint yang dapat menjadi tujuan pengiriman respons oleh server OAuth 2.0.
  6. Klik Create. Layar yang dibuat klien OAuth akan muncul, menampilkan Client ID dan Rahasia klien baru Anda.

    Catat Client-ID. Rahasia klien tidak digunakan untuk aplikasi Web.

  7. Klik OK. Kredensial yang baru dibuat akan muncul pada Client ID OAuth 2.0.

Android

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Buat Kredensial > Client ID OAuth.
  3. Klik Jenis aplikasi > Android.
  4. Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
  5. Di kolom "Nama paket", masukkan nama paket dari file AndroidManifest.xml Anda.
  6. Di kolom "SHA-1 certificate sidik jari", masukkan sidik jari sertifikat SHA-1 yang dihasilkan.
  7. Klik Create. Layar yang dibuat klien OAuth akan muncul, menampilkan Client-ID baru Anda.
  8. Klik OK. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

iOS

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Buat Kredensial > Client ID OAuth.
  3. Klik Jenis aplikasi > iOS.
  4. Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
  5. Di kolom "ID Paket", masukkan ID paket seperti yang tercantum dalam file Info.plist aplikasi.
  6. Opsional: Jika aplikasi Anda muncul di Apple App Store, masukkan ID App Store.
  7. Opsional: Di kolom "Team ID", masukkan string unik 10 karakter, yang dibuat oleh Apple dan ditetapkan ke tim Anda.
  8. Klik Create. Layar yang dibuat klien OAuth akan muncul, menampilkan Client ID dan Rahasia klien baru Anda.
  9. Klik OK. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

Aplikasi Chrome

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Buat Kredensial > Client ID OAuth.
  3. Klik Jenis aplikasi > Aplikasi Chrome.
  4. Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
  5. Di kolom "ID Aplikasi", masukkan string ID unik berisi 32 karakter untuk aplikasi Anda. Anda dapat menemukan nilai ID ini di URL Chrome Web Store aplikasi dan di Dasbor Developer Chrome Web Store.
  6. Klik Create. Layar yang dibuat klien OAuth akan muncul, menampilkan Client ID dan Rahasia klien baru Anda.
  7. Klik OK. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

Aplikasi desktop

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Buat Kredensial > Client ID OAuth.
  3. Klik Jenis aplikasi > Aplikasi desktop.
  4. Di kolom Name, ketik nama untuk kredensial tersebut. Nama ini hanya ditampilkan di Konsol Google Cloud.
  5. Klik Create. Layar yang dibuat klien OAuth akan muncul, menampilkan Client ID dan Rahasia klien baru Anda.
  6. Klik OK. Kredensial yang baru dibuat akan muncul pada Client ID OAuth 2.0.

TV & Perangkat Input Terbatas

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Buat Kredensial > Client ID OAuth.
  3. Klik Jenis aplikasi > TV & Perangkat Input Terbatas.
  4. Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
  5. Klik Create. Layar yang dibuat klien OAuth akan muncul, menampilkan Client ID dan Rahasia klien baru Anda.
  6. Klik OK. Kredensial yang baru dibuat akan muncul di bagian "Client ID OAuth 2.0".

Universal Windows Platform (UWP)

  1. Di Konsol Google Cloud, buka Menu > APIs & Services > Credentials.

    Buka Kredensial

  2. Klik Buat Kredensial > Client ID OAuth.
  3. Klik Application type > Universal Windows Platform (UWP).
  4. Di kolom "Nama", ketik nama untuk kredensial. Nama ini hanya ditampilkan di Konsol Google Cloud.
  5. 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 untuk aplikasi Anda dan di Pusat Partner.
  6. Klik Create. Layar yang dibuat klien OAuth akan muncul, menampilkan Client ID dan Rahasia klien baru Anda.
  7. Klik OK. 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 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

Konsol Google Cloud

  1. Di konsol Google Cloud, buka Menu > IAM & Admin > Akun Layanan.

    Buka Akun Layanan

  2. Klik Create service account.
  3. Isi detail akun layanan, lalu klik Buat dan lanjutkan.
  4. 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.
  5. Klik Continue.
  6. Opsional: Masukkan pengguna atau grup yang dapat mengelola dan melakukan tindakan dengan akun layanan ini. Untuk detail selengkapnya, lihat Mengelola peniruan identitas akun layanan.
  7. Klik Done. Catat alamat email untuk akun layanan.

gcloud CLI

  1. Buat akun layanan:
    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
      --display-name="SERVICE_ACCOUNT_NAME"
  2. 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 bawaan atau khusus untuk akun layanan oleh akun administrator super.

  1. Di konsol Google Admin, buka Menu > Akun > Peran admin.

    Buka Peran admin

  2. Arahkan kursor ke peran yang ingin ditetapkan, lalu klik Tetapkan admin.

  3. Klik Tetapkan akun layanan.

  4. Masukkan alamat email akun layanan.

  5. 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 mengizinkan tindakan akun layanan dalam aplikasi Anda.

Untuk mendapatkan kredensial untuk akun layanan Anda:

  1. Di konsol Google Cloud, buka Menu > IAM & Admin > Akun Layanan.

    Buka Akun Layanan

  2. Pilih akun layanan Anda.
  3. Klik Kunci > Tambahkan kunci > Buat kunci baru.
  4. Pilih JSON, lalu klik Create.

    Pasangan kunci umum/pribadi baru Anda dihasilkan 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 Anda dengan aman, lihat Mengelola kunci akun layanan.

  5. Klik Close.

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 seluruh domain ke akun layanan.

Untuk menyiapkan delegasi otoritas di seluruh domain untuk akun layanan:

  1. Di konsol Google Cloud, buka Menu > IAM & Admin > Akun Layanan.

    Buka Akun Layanan

  2. Pilih akun layanan Anda.
  3. Klik Tampilkan setelan lanjutan.
  4. Di bagian "Delegasi tingkat domain", temukan "ID Klien" akun layanan Anda. Klik Salin untuk menyalin nilai client ID ke papan klip.
  5. 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 Client ID akun layanan Anda serta daftar Cakupan OAuth agar mereka dapat menyelesaikan langkah-langkah berikut di konsol Admin.

    1. Di konsol Google Admin, buka Menu > Keamanan > Kontrol data dan akses > Kontrol API.

      Buka kontrol API

    2. Klik Kelola Delegasi Tingkat Domain.
    3. Klik Tambahkan baru.
    4. Di kolom "ID Klien", tempel ID klien yang sebelumnya Anda salin.
    5. Di kolom "Cakupan OAuth", masukkan daftar cakupan yang dipisahkan koma yang diperlukan oleh aplikasi Anda. Ini adalah kumpulan cakupan yang sama dengan yang Anda tetapkan saat mengonfigurasi layar izin OAuth.
    6. Klik Authorize.

Langkah berikutnya

Anda siap mengembangkan aplikasi di Google Workspace. Tinjau daftar produk developer Google Workspace dan cara menemukan bantuan.