Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Untuk menyiapkan kunci API, lakukan hal berikut:
Konfigurasikan metode API untuk memerlukan kunci API.
Membuat atau mengimpor kunci API untuk API di suatu wilayah.
Sebelum menyiapkan kunci API, Anda harus membuat API dan menerapkannya ke panggung. Setelah Anda membuat nilai kunci API, nilai tersebut tidak dapat diubah.
Untuk panggilan REST API untuk membuat dan menerapkan API, lihat restapi:create
dan deployment:create
, masing-masing.
catatan
Untuk praktik terbaik untuk dipertimbangkan, lihatPraktik terbaik untuk kunci API dan paket penggunaan.
Memerlukan kunci API pada suatu metode
Untuk mewajibkan kunci API pada suatu metode, lakukan salah satu hal berikut:
-
Panggilan
method:put
untuk membuat metode. SetelapiKeyRequired
ketrue
dalam payload permintaan. -
Panggilan
method:update
untuk mengaturapiKeyRequired
ketrue
.
Membuat atau mengimpor kunci API
Untuk membuat atau mengimpor kunci API, lakukan salah satu hal berikut:
-
Panggilan
apikey:create
untuk membuat kunci API. -
Panggilan
apikey:import
untuk mengimpor kunci API dari file. Untuk format file, lihatFormat file kunci API Gateway API.
Anda tidak dapat mengubah nilai kunci API baru. Untuk mempelajari cara mengonfigurasi paket penggunaan, lihatMembuat, mengonfigurasi, dan menguji rencana penggunaan menggunakan API Gateway CLI dan REST API.