Mengatur API kunci menggunakan API Gateway REST API - APIGerbang Amazon

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Mengatur API kunci menggunakan API Gateway REST API

Untuk mengatur API kunci, lakukan hal berikut:

  • Konfigurasikan API metode untuk memerlukan API kunci.

  • Membuat atau mengimpor API kunci untuk API di wilayah.

Sebelum menyiapkan API kunci, Anda harus membuat API dan menerapkannya ke panggung. Setelah Anda membuat nilai API kunci, itu tidak dapat diubah.

Untuk REST API panggilan untuk membuat dan menyebarkanAPI, lihat restapi:createdan deployment:create, masing-masing.

catatan

Untuk praktik terbaik untuk dipertimbangkan, lihatPraktik terbaik untuk API kunci dan paket penggunaan.

Memerlukan API kunci pada metode

Untuk meminta API kunci pada metode, lakukan salah satu hal berikut:

  • Panggilan method:putuntuk membuat metode. Setel apiKeyRequired ke true dalam payload permintaan.

  • Panggilan method:updateuntuk mengatur apiKeyRequired ketrue.

Buat atau impor API kunci

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

Anda tidak dapat mengubah nilai API kunci baru. Untuk mempelajari cara mengonfigurasi paket penggunaan, lihatMembuat, mengonfigurasi, dan menguji paket penggunaan menggunakan API Gateway CLI dan REST API.