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