Dokumen ini menjelaskan langkah-langkah yang diperlukan untuk mulai menggunakan Geocoding API.
|
Pastikan Anda memenuhi prasyarat. |
Aktifkan API di project Google Cloud Anda. |
Konfigurasi kunci API atau OAuth untuk membuat permintaan API yang terautentikasi. |
Produk Google Maps Platform dilindungi dari penggunaan yang tidak sah dengan mewajibkan panggilan API untuk menyertakan salah satu dari kunci API atau token OAuth.
Buat token OAuth
Geocoding API mendukung penggunaan OAuth 2.0 untuk autentikasi. Google mendukung skenario OAuth 2.0 umum seperti skenario untuk server web.
Dokumen ini menjelaskan cara meneruskan token OAuth ke panggilan Geocoding API di lingkungan pengembangan Anda. Untuk mengetahui petunjuk tentang cara menggunakan OAuth di lingkungan produksi, lihat Metode autentikasi di Google.
Tentang OAuth
Ada banyak cara untuk membuat dan mengelola token akses dengan OAuth berdasarkan lingkungan deployment Anda.
Misalnya, sistem OAuth 2.0 Google mendukung interaksi server-ke-server, seperti interaksi antara aplikasi Anda dan layanan Google. Untuk skenario ini, Anda memerlukan akun layanan, yaitu akun milik aplikasi Anda, bukan milik pengguna akhir perorangan. Aplikasi Anda memanggil Google API atas nama akun layanan, sehingga pengguna tidak terlibat secara langsung. Untuk mengetahui informasi selengkapnya tentang metode autentikasi, lihat Metode autentikasi di Google.
Atau, Anda dapat menggunakan Geocoding API sebagai bagian dari aplikasi seluler Android atau iOS. Untuk informasi umum tentang penggunaan OAuth dengan Geocoding API, termasuk informasi tentang pengelolaan token akses untuk lingkungan deployment yang berbeda, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.
Tentang cakupan OAuth
Untuk menggunakan OAuth dengan Geocoding API, token OAuth harus diberi cakupan yang benar. Geocoding API mendukung cakupan berikut:
https://www.googleapis.com/auth/maps-platform.geocode— Gunakan dengan semua endpoint Geocoding API.https://www.googleapis.com/auth/maps-platform.geocode.address— Hanya digunakan denganGeocodeAddressuntuk geocoding maju.https://www.googleapis.com/auth/maps-platform.geocode.location— Hanya digunakan denganGeocodeLocationuntuk geocoding terbalik.https://www.googleapis.com/auth/maps-platform.geocode.place— Hanya digunakan denganGeocodePlaceuntuk geocoding tempat.
Selain itu, Anda dapat menggunakan cakupan https://www.googleapis.com/auth/cloud-platform
umum untuk semua endpoint Geocoding API. Cakupan tersebut berguna selama pengembangan
karena merupakan cakupan default yang digunakan saat membuat token menggunakan
gcloud.
Contoh: Mencoba panggilan REST API di lingkungan pengembangan lokal Anda
Jika ingin mencoba Geocoding API menggunakan token OAuth, tetapi tidak memiliki penyiapan lingkungan untuk membuat token, Anda dapat menggunakan prosedur di bagian ini untuk melakukan panggilan.
Contoh ini menjelaskan cara menggunakan token OAuth yang disediakan oleh Kredensial Default Aplikasi (ADC) untuk melakukan panggilan. Untuk mengetahui informasi tentang cara menggunakan ADC untuk memanggil Google API menggunakan library klien, lihat Mengautentikasi menggunakan library klien.
Prasyarat
Sebelum Anda dapat membuat permintaan REST menggunakan ADC, gunakan Google Cloud CLI untuk memberikan kredensial ke ADC:
- Instal dan lakukan inisialisasi gcloud CLI.
Jalankan perintah
gcloudberikut di komputer lokal Anda untuk membuat file kredensial:gcloud auth application-default login
- Layar login akan ditampilkan. Setelah Anda login, kredensial Anda akan disimpan dalam file kredensial lokal yang digunakan oleh ADC.
Untuk mengetahui informasi selengkapnya, lihat Menyiapkan ADC untuk lingkungan pengembangan lokal.
Membuat permintaan REST
Dalam contoh ini, Anda meneruskan dua header permintaan:
Teruskan token OAuth di header
Authorizationmenggunakan perintah berikut untuk membuat token:gcloud auth application-default print-access-tokenToken yang ditampilkan memiliki cakupan
https://www.googleapis.com/auth/cloud-platform.- Teruskan ID atau nama project Google Cloud Anda yang telah mengaktifkan penagihan di header
X-Goog-User-Project.
Contoh berikut melakukan panggilan ke Geocoding API menggunakan token OAuth.
Edit kolom PROJECT_ID untuk meneruskan ID project Google Cloud Anda.
curl -X GET -H 'Content-Type: application/json' \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://geocode.googleapis.com/v4beta/geocode/address/1600+Amphitheatre+Parkway,+Mountain+View,+CA"
- Klik ikon salin di contoh kode,
,
untuk menyalin perintah curl. - Tempel perintah di jendela terminal, lalu jalankan perintah.
Responsnya adalah objek JSON:
Pemecahan masalah
Jika permintaan Anda menampilkan pesan error tentang kredensial pengguna akhir yang tidak didukung oleh API ini, lihat Memecahkan masalah penyiapan ADC.