Mengizinkan permintaan

Saat aplikasi Anda meminta data pribadi, permintaan itu harus diizinkan oleh pengguna terautentikasi yang memiliki akses ke data tersebut.

Saat aplikasi Anda meminta data publik, permintaan tidak perlu diizinkan, tetapi harus disertai dengan ID, seperti kunci API.

Setiap permintaan yang dikirim aplikasi Anda ke Cloud Resource Manager API harus mengidentifikasi aplikasi Anda ke Google. Ada dua cara untuk mengidentifikasi aplikasi Anda: menggunakan token OAuth 2.0 (yang juga mengizinkan permintaan) dan/atau menggunakan kunci API aplikasi. Berikut cara menentukan opsi mana yang akan digunakan:

  • Jika permintaan memerlukan otorisasi (seperti permintaan data pribadi seseorang), aplikasi harus memberikan token OAuth 2.0 dengan permintaan tersebut. Aplikasi juga dapat memberikan kunci API, tetapi tidak harus.
  • Jika permintaan tidak memerlukan otorisasi (seperti permintaan data publik), aplikasi harus memberikan kunci API atau token OAuth 2.0, atau keduanya—opsi mana pun yang paling nyaman bagi Anda.

Tentang protokol otorisasi

Aplikasi Anda harus menggunakan OAuth 2.0 untuk mengizinkan permintaan. Tidak ada protokol otorisasi lain yang didukung. Jika aplikasi Anda menggunakan Login dengan Google, beberapa aspek otorisasi akan ditangani untuk Anda.

Mengizinkan permintaan dengan OAuth 2.0

Permintaan ke Cloud Resource Manager API untuk data pengguna non-publik harus diizinkan oleh pengguna terautentikasi.

Detail proses otorisasi, atau "alur", untuk OAuth 2.0 bervariasi bergantung pada jenis aplikasi yang Anda tulis. Proses umum berikut berlaku untuk semua jenis aplikasi:

  1. Saat membuat aplikasi, Anda mendaftarkannya menggunakan konsolGoogle Cloud . Selanjutnya, Google menyediakan informasi yang akan Anda perlukan nanti, seperti ID klien dan rahasia klien.
  2. Aktifkan Cloud Resource Manager API di Google Cloud konsol. (Jika API tidak tercantum di konsol Google Cloud , lewati langkah ini.)
  3. Saat memerlukan akses ke data pengguna, aplikasi Anda akan meminta cakupan akses tertentu kepada Google.
  4. Google menampilkan layar izin kepada pengguna, yang meminta mereka mengizinkan aplikasi Anda untuk meminta beberapa data.
  5. Jika pengguna menyetujui, Google akan memberikan token akses berumur singkat ke aplikasi Anda.
  6. Aplikasi Anda meminta data pengguna, dengan menambahkan token akses ke permintaan.
  7. Jika Google menentukan bahwa permintaan Anda dan token tersebut valid, data yang diminta akan ditampilkan.

Beberapa alur mencakup langkah tambahan, seperti penggunaan token refresh untuk memperoleh token akses baru. Informasi selengkapnya tentang alur untuk berbagai jenis aplikasi dapat dilihat di dokumentasi OAuth 2.0 Google.

Berikut informasi cakupan OAuth 2.0 untuk Cloud Resource Manager API:

Cakupan Arti
https://www.googleapis.com/auth/cloud-platform Akses baca/tulis.

Untuk meminta akses menggunakan OAuth 2.0, aplikasi Anda memerlukan informasi cakupan, serta informasi yang disediakan oleh Google saat Anda mendaftarkan aplikasi (seperti ID klien dan rahasia klien).

Tips: Library klien Google API dapat menangani beberapa proses otorisasi secara otomatis. Library klien ini tersedia untuk berbagai bahasa pemrograman. Periksa halaman yang menjelaskan library beserta contohnya untuk mendapatkan informasi lebih mendetail.

Mendapatkan dan menggunakan kunci API

Permintaan ke Cloud Resource Manager API untuk data publik harus disertai dengan ID, yang dapat berupa kunci API atau token akses.

Untuk mendapatkan kunci API:

  1. Buka halaman Credentials di Google Cloud console.
  2. API ini mendukung dua jenis kredensial. Buat kredensial yang sesuai untuk project Anda:

    • OAuth 2.0: Setiap kali aplikasi Anda meminta data pengguna pribadi, aplikasi tersebut harus mengirimkan token OAuth 2.0 bersama dengan permintaan. Aplikasi Anda pertama-tama mengirimkan client ID dan, mungkin, rahasia klien untuk mendapatkan token. Anda dapat membuat kredensial OAuth 2.0 untuk aplikasi web, akun layanan, atau aplikasi yang terinstal.

      Untuk mengetahui informasi selengkapnya, lihat dokumentasi OAuth 2.0.

    • Kunci API: Permintaan yang tidak memberikan token OAuth 2.0 harus mengirimkan kunci API. Kunci ini mengidentifikasi project Anda dan memberikan akses API, kuota, dan laporan.

      API mendukung beberapa jenis pembatasan pada kunci API. Jika kunci API yang Anda butuhkan belum ada, buat kunci API di Konsol dengan mengklik Buat kredensial  > Kunci API. Anda dapat membatasi kunci sebelum menggunakannya dalam produksi dengan mengklik Batasi kunci dan memilih salah satu Pembatasan.

Untuk menjaga kunci API Anda tetap aman, ikuti praktik terbaik untuk menggunakan kunci API dengan aman.

Setelah memiliki kunci API, aplikasi Anda dapat menambahkan parameter kueri key=yourAPIKey ke semua URL permintaan.

Kunci API aman untuk disematkan di URL; tidak memerlukan encoding apa pun.