Menggunakan Kunci API

Pilih platform: Android iOS JavaScript

Topik ini menjelaskan cara membuat kunci API untuk Maps SDK for Android, menambahkannya ke aplikasi Anda, dan mengamankan aplikasi dengan membatasi kunci tersebut. Anda harus menambahkan kunci API ke setiap aplikasi yang menggunakan SDK tersebut.

Sebelum memulai

Sebelum mulai menggunakan Maps SDK for Android, Anda harus memiliki project dengan akun penagihan dan mengaktifkan Maps SDK for Android. Untuk mempelajari lebih lanjut, lihat Menyiapkan project di Cloud Console.

Membuat kunci API

Kunci API adalah ID unik yang mengautentikasi permintaan terkait project untuk tujuan penggunaan dan penagihan. Anda harus memiliki setidaknya satu kunci API terkait project.

Untuk membuat kunci API:

Konsol

  1. Buka halaman Google Maps Platform > Credentials.

    Buka halaman Credentials

  2. Pada halaman Credentials, klik Create credentials > API key.
    Dialog API key created akan menampilkan kunci API yang baru dibuat.
  3. Klik Close.
    Kunci API baru dicantumkan pada halaman Credentials di bawah API keys.
    (Jangan lupa untuk membatasi kunci API sebelum menggunakannya dalam produksi.)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Baca selengkapnya tentang Google Cloud SDK, Penginstalan Cloud SDK, dan perintah berikut:

Membatasi kunci API

Google sangat menyarankan agar Anda membatasi penggunaan kunci API hanya untuk API yang diperlukan aplikasi Anda. Membatasi kunci API akan meningkatkan keamanan aplikasi Anda dengan melindunginya dari permintaan yang tidak sah. Untuk informasi selengkapnya, lihat Praktik terbaik keamanan API.

Saat membatasi kunci API, Anda harus memberikan sidik jari sertifikat SHA-1 untuk kunci penandatanganan yang digunakan untuk menandatangani aplikasi. Ada dua jenis sertifikat:

  • Sertifikat debug: Hanya gunakan jenis sertifikat ini bersama aplikasi yang sedang Anda uji dan kode non-produksi lainnya. Jangan mencoba memublikasikan aplikasi yang ditandatangani dengan sertifikat debug. Android SDK Tools membuat sertifikat ini secara otomatis saat Anda menjalankan build debug.
  • Sertifikat rilis: Gunakan sertifikat ini jika Anda siap merilis aplikasi ke app store. Android SDK Tools membuat sertifikat ini saat Anda menjalankan build rilis.

Untuk mendapatkan informasi selengkapnya tentang sertifikat digital, lihat panduan Menandatangani aplikasi .

Untuk informasi tentang cara mendapatkan sidik jari sertifikat, lihat halaman Mengautentikasi Klien Anda. Jika Anda menggunakan Penandatanganan Aplikasi Play, Anda harus membuka halaman penandatanganan aplikasi di Konsol Play untuk mendapatkan sidik jari sertifikat.

Cara membatasi kunci API:

Konsol

  1. Buka halaman Google Maps Platform > Credentials.

    Buka halaman Credentials

  2. Pilih kunci API yang ingin Anda batasi. Halaman properti kunci API akan muncul.
  3. Di bagian Pembatasan kunci, tetapkan pembatasan berikut:
    • Pembatasan aplikasi:
      1. Pilih Android apps.
      2. Klik + Add package name and fingerprint.
      3. Masukkan nama paket dan sidik jari sertifikat SHA-1. Contoh:
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Pembatasan API:
      1. Klik Restrict key.
      2. Pilih Maps SDK for Android dari dropdown Select APIs. Jika Maps SDK for Android tidak tercantum, Anda harus mengaktifkannya.
  4. Untuk menyelesaikan perubahan, klik Save.

Cloud SDK

Cantumkan kunci yang ada.

gcloud services api-keys list --project="PROJECT"

Hapus pembatasan yang ada pada kunci yang ada.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Tetapkan pembatasan baru pada kunci yang ada.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api_target="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

Baca selengkapnya tentang Google Cloud SDK, Penginstalan Cloud SDK, dan perintah berikut:

Langkah berikutnya

Setelah Anda memiliki kunci API, buat dan konfigurasikan project seperti yang dijelaskan dalam Menyiapkan Project Android Studio.