Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Saat Anda mengaitkan rencana penggunaan dengan API dan mengaktifkan kunci API pada metode API, setiap permintaan masuk ke API harus berisi kunci API. API Gateway membaca kunci dan membandingkannya dengan kunci dalam paket penggunaan. Jika ada kecocokan, API Gateway membatasi permintaan berdasarkan batas permintaan dan kuota paket. Kalau tidak, itu melempar InvalidKeyParameter pengecualian. Akibatnya, penelepon menerima 403 Forbidden respons.
API Gateway API Anda dapat menerima kunci API dari salah satu dari dua sumber:
HEADER-
Anda mendistribusikan kunci API ke pelanggan Anda dan meminta mereka untuk meneruskan kunci API sebagai
X-API-Keyheader dari setiap permintaan yang masuk. AUTHORIZER-
Anda memiliki otorisasi Lambda yang mengembalikan kunci API sebagai bagian dari respons otorisasi. Untuk informasi selengkapnya tentang respons otorisasi, lihatKeluaran dari otorisasi API Gateway Lambda.
catatan
Untuk praktik terbaik untuk dipertimbangkan, lihatPraktik terbaik untuk kunci API dan paket penggunaan.
Untuk memilih sumber kunci API untuk API dengan menggunakan konsol API Gateway
-
Masuk ke konsol API Gateway.
-
Pilih API yang sudah ada atau buat yang baru.
-
Di panel navigasi utama, pilih pengaturan API.
-
Di bagian detail API, pilih Edit.
-
Di bawah sumber kunci API, pilih
HeaderatauAuthorizerdari daftar tarik-turun. -
Pilih Simpan perubahan.
update-rest-apiPerintah berikut memperbarui API untuk menyetel sumber kunci API keAUTHORIZER:
aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/apiKeySource,value=AUTHORIZER
Untuk meminta klien mengirimkan kunci API, atur value ke HEADER dalam perintah sebelumnya.
Untuk memilih sumber kunci API untuk API dengan menggunakan API Gateway REST API, panggil restapi:updatesebagai berikut:
PATCH /restapis/fugvjdxtri/ HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T205348Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash} { "patchOperations" : [ { "op" : "replace", "path" : "/apiKeySource", "value" : "HEADER" } ] }
Agar otorisasi mengembalikan kunci API, setel value ke AUTHORIZER dalam patchOperations input sebelumnya.
