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 diotorisasi, tetapi harus disertai ID, seperti kunci API.
Setiap permintaan yang dikirimkan aplikasi Anda ke 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 yang akan digunakan:
- Jika permintaan memerlukan otorisasi (seperti permintaan untuk data pribadi individu), 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 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 sudah diautentikasi.
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:
- Saat membuat aplikasi, Anda mendaftarkannya menggunakan Konsol Google Cloud. Selanjutnya, Google menyediakan informasi yang akan Anda perlukan nanti, seperti client ID dan secret klien.
- Aktifkan Resource Manager API di konsol Google Cloud. (Jika API tidak tercantum di konsol Google Cloud, lewati langkah ini.)
- Saat memerlukan akses ke data pengguna, aplikasi Anda akan meminta cakupan akses tertentu kepada Google.
- Google menampilkan layar izin kepada pengguna, yang meminta mereka mengizinkan aplikasi Anda untuk meminta beberapa data.
- Jika pengguna menyetujui, Google akan memberikan token akses berumur singkat ke aplikasi Anda.
- Aplikasi Anda meminta data pengguna, dengan menambahkan token akses ke permintaan.
- 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. Untuk informasi selengkapnya tentang alur untuk berbagai jenis aplikasi, lihat dokumentasi OAuth 2.0 Google.
Berikut 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 client ID 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 Resource Manager API untuk data publik harus disertai dengan ID, yang dapat berupa kunci API atau token akses.
Untuk mendapatkan kunci API:
- Buka halaman Credentials di Konsol Google Cloud.
-
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, secret klien untuk mendapatkan token. Anda dapat membuat kredensial OAuth 2.0 untuk aplikasi web, akun layanan, atau aplikasi yang diinstal.
Untuk 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, kuota, dan 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 sebelum menggunakannya dalam produksi dengan mengklik Batasi kunci dan memilih salah satu Batasan.
-
Untuk menjaga keamanan kunci API Anda, 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; kunci API tidak memerlukan encoding apa pun.