Izinkan permintaan

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

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

Setiap permintaan yang dikirimkan aplikasi Anda ke Resource Manager API perlu 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 harus digunakan:

  • Jika permintaan memerlukan otorisasi (seperti permintaan untuk data pribadi individu), aplikasi harus menyediakan token OAuth 2.0 bersama permintaan tersebut. Aplikasi juga dapat menyediakan kunci API, tetapi tidak harus demikian.
  • Jika permintaan tidak memerlukan otorisasi (seperti permintaan untuk data publik), aplikasi harus memberikan kunci API atau token OAuth 2.0, atau keduanya—opsi apa 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 Resource Manager API untuk data pengguna non-publik harus diizinkan oleh pengguna yang diautentikasi.

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

  1. Saat membuat aplikasi, Anda mendaftarkannya menggunakan konsol Google Cloud. Selanjutnya, Google akan menyediakan informasi yang akan Anda perlukan nanti, seperti client ID dan rahasia klien.
  2. Aktifkan Resource Manager API di Konsol Google Cloud. (Jika API tidak tercantum di Google Cloud Console, 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 melampirkan token akses ke permintaan.
  7. Jika Google menentukan bahwa permintaan Anda dan token valid, data yang diminta akan ditampilkan.

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

Berikut adalah informasi cakupan OAuth 2.0 untuk 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 lanjut.

Memperoleh dan menggunakan kunci API

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

Cara mendapatkan kunci API:

  1. Buka halaman Credentials di Konsol Google Cloud.
  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 harus mengirimkan token OAuth 2.0 beserta permintaannya. Aplikasi Anda terlebih dahulu mengirimkan client ID dan, mungkin, rahasia klien untuk mendapatkan token. Anda dapat membuat kredensial OAuth 2.0 untuk aplikasi web, akun layanan, atau aplikasi terinstal.

      Untuk informasi selengkapnya, lihat dokumentasi OAuth 2.0.

    • Kunci API: Permintaan yang tidak menyediakan token OAuth 2.0 harus mengirim kunci API. Kunci tersebut mengidentifikasi project Anda dan memberikan akses, kuota, serta laporan API.

      API ini mendukung beberapa jenis pembatasan pada kunci API. Jika kunci API yang Anda perlukan belum ada, buat kunci API di Konsol dengan mengklik Create credentials > API key. Anda dapat membatasi kunci ini sebelum menggunakannya dalam produksi dengan mengklik Restrict key dan memilih salah satu Restrictions.

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

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

Kunci API aman untuk disematkan dalam URL; tanpa encoding apa pun.