Ringkasan Kunci API

Kunci API adalah string terenkripsi sederhana yang dapat Anda gunakan saat memanggil APIGoogle Cloud . Penggunaan umum kunci API adalah meneruskan kunci ke dalam panggilan REST API sebagai parameter kueri dengan format berikut:

http://example-library.googleapis.com/v1/publishers/mypublisher/books?key=API_KEY
 Kunci API berguna untuk mengakses data publik secara anonim, dan digunakan untuk mengaitkan permintaan API dengan project konsumen Google Cloud untuk kuota dan penagihan.

API Keys menyediakan antarmuka terprogram untuk membuat dan mengelola kunci API untuk project Anda. API ini memberi Anda lebih banyak kontrol atas kunci API daripada tugas terkait kunci API yang dapat Anda lakukan di konsol Google Cloud .

Untuk mempelajari lebih lanjut cara melakukan autentikasi ke Google Cloud API dan menentukan strategi autentikasi terbaik untuk skenario umum, lihat Ringkasan autentikasi. Untuk mempelajari lebih lanjut cara menggunakan kunci API untuk API dan SDK Google Maps Platform, lihat dokumentasi Google Maps Platform.

Mengamankan kunci API

Saat Anda menggunakan kunci API di aplikasi, pastikan kunci tersebut tetap aman selama penyimpanan dan transmisi. Menampilkan kredensial Anda kepada publik dapat menyebabkan akun Anda disusupi, yang dapat menimbulkan tagihan tidak terduga pada akun Anda. Untuk membantu menjaga kunci API Anda tetap aman, ikuti praktik terbaik berikut:

  • Jangan sematkan kunci API secara langsung di dalam kode. Kunci API yang disematkan dalam kode dapat terekspos secara tidak sengaja kepada publik. Misalnya, Anda mungkin lupa menghapus kunci dari kode yang Anda bagikan. Daripada menyematkan kunci API di aplikasi, simpan kunci tersebut dalam variabel lingkungan atau dalam file di luar hierarki sumber aplikasi Anda.

  • Tambahkan pembatasan pada kunci API. Dengan menambahkan batasan, Anda dapat mengurangi dampak kunci API yang disusupi.

  • Hapus kunci API yang tidak diperlukan untuk meminimalkan paparan serangan.

  • Rotasi kunci API Anda secara berkala. Untuk merotasi kunci API, panggil metode CreateKey. Setelah kunci pengganti dibuat, perbarui aplikasi Anda untuk menggunakan kunci yang baru dibuat dan hapus kunci lama.

  • Tinjau kode Anda sebelum merilisnya kepada publik. Pastikan kode Anda tidak berisi kunci API atau informasi pribadi lainnya sebelum Anda membuat kode tersebut tersedia untuk publik.

Langkah berikutnya