Siapkan API kunci menggunakan konsol API Gateway - APIGerbang Amazon
Memerlukan API kunci pada metodeBuat API kunciAPIKunci impor

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

Siapkan API kunci menggunakan konsol API Gateway

Untuk mengatur API kunci, lakukan hal berikut:

  • Konfigurasikan API metode untuk memerlukan API kunci.

  • Membuat atau mengimpor API kunci untuk API di suatu wilayah.

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

Untuk petunjuk tentang cara membuat dan menerapkan API dengan menggunakan konsol API Gateway, lihat Berkembang REST APIs di API Gateway danTerapkan REST APIs di API Gateway, masing-masing.

Setelah Anda membuat API kunci, Anda harus mengaitkannya dengan rencana penggunaan. Untuk informasi selengkapnya, lihat Membuat, mengonfigurasi, dan menguji paket penggunaan dengan konsol API Gateway.

catatan

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

Memerlukan API kunci pada metode

Prosedur berikut menjelaskan cara mengkonfigurasi API metode untuk memerlukan API kunci.

Untuk mengkonfigurasi API metode untuk memerlukan API kunci

  1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  2. Pilih a RESTAPI.

  3. Di panel navigasi utama API Gateway, pilih Resources.

  4. Di bawah Sumber Daya, buat metode baru atau pilih yang sudah ada.

  5. Pada tab Permintaan metode, di bawah Pengaturan permintaan metode, pilih Edit.

    Tambahkan API kunci ke metode

  6. Pilih APIkunci yang diperlukan.

  7. Pilih Simpan.

  8. Menyebarkan atau menyebarkan kembali API agar persyaratan diterapkan.

Jika opsi APIkunci yang diperlukan disetel ke false dan Anda tidak menjalankan langkah-langkah sebelumnya, API kunci apa pun yang terkait dengan API tahap tidak digunakan untuk metode tersebut.

Buat API kunci

Jika Anda telah membuat atau mengimpor API kunci untuk digunakan dengan paket penggunaan, Anda dapat melewati ini dan prosedur berikutnya.

Untuk membuat kunci API

  1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  2. Pilih a RESTAPI.

  3. Di panel navigasi utama API Gateway, pilih APItombol.

  4. Pilih APItombol Buat.

    Buat API kunci untuk paket penggunaan

  5. Untuk Nama, masukkan nama.

  6. (Opsional) Untuk Deskripsi, masukkan deskripsi.

  7. Untuk APIkunci, pilih Auto generate agar API Gateway menghasilkan nilai kunci, atau pilih Custom untuk membuat nilai kunci Anda sendiri.

  8. Pilih Simpan.

APIKunci impor

Prosedur berikut menjelaskan cara mengimpor API kunci untuk digunakan dengan rencana penggunaan.

Untuk mengimpor API kunci

  1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  2. Pilih a RESTAPI.

  3. Di panel navigasi utama, pilih APItombol.

  4. Pilih menu tarik-turun Tindakan, lalu pilih Impor API kunci.

  5. Untuk memuat file kunci yang dipisahkan koma, pilih Pilih file. Anda juga dapat memasukkan tombol di editor teks. Untuk informasi tentang format file, lihatAPIFormat file API kunci gateway.

  6. Pilih Gagal pada peringatan untuk menghentikan impor saat ada kesalahan, atau pilih Abaikan peringatan untuk terus mengimpor entri kunci yang valid saat ada peringatan.

  7. Pilih Impor untuk mengimpor API kunci Anda.