Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Paket penggunaan dan API kunci untuk REST APIs di API Gateway
Setelah membuat, menguji, dan menerapkanAPIs, Anda dapat menggunakan paket penggunaan API Gateway agar tersedia sebagai penawaran produk bagi pelanggan Anda. Anda dapat mengonfigurasi paket penggunaan dan API kunci untuk memungkinkan pelanggan mengakses yang dipilihAPIs, dan mulai membatasi permintaan APIs berdasarkan batas dan kuota yang ditentukan. Ini dapat diatur padaAPI, atau tingkat API metode.
Apa itu paket penggunaan dan API kunci?
Paket penggunaan menentukan siapa yang dapat mengakses satu atau beberapa API tahapan dan metode yang disebarkan—dan secara opsional menetapkan tingkat permintaan target untuk memulai pembatasan permintaan. Rencana menggunakan API kunci untuk mengidentifikasi API klien dan siapa yang dapat mengakses API tahapan terkait untuk setiap kunci.
APIkunci adalah nilai string alfanumerik yang Anda distribusikan ke pelanggan pengembang aplikasi untuk memberikan akses ke Anda. API Anda dapat menggunakan API kunci bersama dengan otorisasi Lambda, IAMperan, atau Amazon Cognito untuk mengontrol akses ke Anda. APIs APIGateway dapat menghasilkan API kunci atas nama Anda, atau Anda dapat mengimpornya dari CSVfile. Anda dapat membuat API kunci di API Gateway, atau mengimpornya ke API Gateway dari sumber eksternal. Untuk informasi selengkapnya, lihat Siapkan API kunci menggunakan konsol API Gateway.
APIKunci memiliki nama dan nilai. (Istilah “APIkunci” dan “nilai API kunci” sering digunakan secara bergantian.) Nama tidak boleh melebihi 1024 karakter. Nilainya adalah string alfanumerik antara 20 dan 128 karakter, misalnya,. apikey1234abcdefghij0123456789
penting
APInilai-nilai kunci harus unik. Jika Anda mencoba membuat dua API kunci dengan nama berbeda dan nilai yang sama, API Gateway menganggapnya sebagai API kunci yang sama.
APIKunci dapat dikaitkan dengan lebih dari satu paket penggunaan. Rencana penggunaan dapat dikaitkan dengan lebih dari satu tahap. Namun, API kunci yang diberikan hanya dapat dikaitkan dengan satu paket penggunaan untuk setiap tahap AndaAPI.
Batas pelambatan menetapkan titik target di mana pelambatan permintaan harus dimulai. Ini dapat diatur pada tingkat API atau API metode.
Batas kuota menetapkan jumlah maksimum target permintaan dengan API kunci tertentu yang dapat dikirimkan dalam interval waktu tertentu. Anda dapat mengonfigurasi API metode individual untuk memerlukan otorisasi API kunci berdasarkan konfigurasi paket penggunaan.
Batas pembatasan dan kuota berlaku untuk permintaan API kunci individual yang digabungkan di semua API tahapan dalam paket penggunaan.
catatan
Pelambatan rencana penggunaan dan kuota bukanlah batas yang sulit, dan diterapkan atas dasar upaya terbaik. Dalam beberapa kasus, klien dapat melebihi kuota yang Anda tetapkan. Jangan mengandalkan kuota paket penggunaan atau pembatasan untuk mengontrol biaya atau memblokir akses ke file. API Pertimbangkan AWS Budgetsuntuk menggunakan untuk memantau biaya dan AWS WAFmengelola API permintaan.
Langkah-langkah untuk mengonfigurasi paket penggunaan dan API kunci di API Gateway
Tugas berikut menguraikan langkah-langkah yang diperlukan untuk mengonfigurasi paket penggunaan dan API kunci. Untuk praktik terbaik, lihat Praktik terbaik untuk API kunci dan paket penggunaan.
Untuk mengonfigurasi paket penggunaan dan API kunci
-
Buat API dan konfigurasikan permintaan metode untuk setiap API metode untuk memerlukan API kunci. Kemudian, gunakan Anda API ke panggung.
Untuk menyertakan API metode dalam paket penggunaan, Anda harus mengonfigurasi API metode individual untuk memerlukan API kunci.
Untuk informasi selengkapnya tentang cara mengonfigurasi metode agar memerlukan API kunci, lihatMemerlukan API kunci pada metode.
-
Hasilkan atau impor API kunci untuk didistribusikan ke pengembang aplikasi (pelanggan Anda) yang akan menggunakan AndaAPI. APIkunci diperlukan untuk paket penggunaan Anda.
Untuk informasi selengkapnya tentang cara membuat atau mengimpor API kunci, lihatBuat API kunci.
-
Buat paket penggunaan dengan batas throttle dan kuota yang diinginkan, lalu kaitkan API tahapan dan API kunci dengan paket penggunaan.
Untuk informasi selengkapnya tentang cara membuat paket penggunaan, lihatBuat rencana penggunaan.
Penelepon API harus menyediakan API kunci yang ditetapkan di x-api-key header dalam permintaan ke. API
Untuk AWS CloudFormation template lengkap yang membuat dan mengaitkan rencana penggunaan dengan tahap dan API kunci baru, lihatBuat dan konfigurasikan API kunci dan paket penggunaan dengan AWS CloudFormation.
Praktik terbaik untuk API kunci dan paket penggunaan
Berikut ini adalah praktik terbaik yang disarankan untuk diikuti saat menggunakan API kunci dan paket penggunaan.
penting
-
Jangan gunakan API kunci untuk otentikasi atau otorisasi untuk mengontrol akses ke Anda. APIs Jika Anda memiliki beberapa APIs dalam paket penggunaan, pengguna dengan API kunci yang valid untuk satu API di paket penggunaan tersebut dapat mengakses semua APIs dalam paket penggunaan tersebut. Sebagai gantinya, untuk mengontrol akses ke AndaAPI, gunakan IAM peran, otorisasi Lambda, atau kumpulan pengguna Amazon Cognito.
-
Gunakan API kunci yang dihasilkan API Gateway. APIkunci tidak boleh menyertakan informasi rahasia; klien biasanya mengirimkannya di header yang dapat dicatat.
-
Jika Anda menggunakan portal pengembang untuk mempublikasikanAPIs, perhatikan bahwa semua paket penggunaan Anda APIs dapat berlangganan oleh pelanggan, bahkan jika Anda belum membuatnya terlihat oleh pelanggan Anda.
-
Dalam beberapa kasus, klien dapat melebihi kuota yang Anda tetapkan. Jangan mengandalkan rencana penggunaan untuk mengontrol biaya. Pertimbangkan AWS Budgetsuntuk menggunakan untuk memantau biaya dan AWS WAFmengelola API permintaan.
-
Setelah Anda menambahkan API kunci ke paket penggunaan, operasi pembaruan mungkin memerlukan beberapa menit untuk menyelesaikannya.
