Mengatur kunci API menggunakan API Gateway REST API

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:createdan 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:putuntuk membuat metode. Setel apiKeyRequired ke true dalam payload permintaan.

• Panggilan method:updateuntuk mengatur apiKeyRequired ketrue.

Membuat atau mengimpor kunci API

Untuk membuat atau mengimpor kunci API, lakukan salah satu hal berikut:

• Panggilan apikey:createuntuk membuat kunci API.

• Panggilan apikey:importuntuk 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.