

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

# Siapkan kunci API untuk REST APIs di API Gateway
<a name="api-gateway-setup-api-keys"></a>

Untuk menyiapkan kunci API, lakukan hal berikut:
+ Konfigurasikan metode API untuk memerlukan kunci API.
+ Membuat atau mengimpor kunci API untuk API di Wilayah.

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

Untuk petunjuk tentang cara membuat dan menerapkan API menggunakan konsol API Gateway, lihat [Kembangkan REST APIs di API Gateway](rest-api-develop.md) dan[Menerapkan REST APIs di API Gateway](how-to-deploy-api.md), masing-masing.

Setelah membuat kunci API, Anda harus mengaitkannya dengan paket penggunaan. Untuk informasi selengkapnya, lihat [Siapkan paket penggunaan untuk REST APIs di API Gateway](api-gateway-create-usage-plans.md).

**catatan**  
Untuk praktik terbaik untuk dipertimbangkan, lihat[Praktik terbaik untuk kunci API dan paket penggunaan](api-gateway-api-usage-plans.md#apigateway-usage-plans-best-practices).

**Topics**
+ [Memerlukan kunci API pada suatu metode](#api-gateway-usage-plan-configure-apikey-on-method)
+ [Membuat kunci API](#api-gateway-usage-plan-create-apikey)
+ [Impor kunci API](#api-gateway-usage-pan-import-apikey)

## Memerlukan kunci API pada suatu metode
<a name="api-gateway-usage-plan-configure-apikey-on-method"></a>

Prosedur berikut menjelaskan cara mengonfigurasi metode API agar memerlukan kunci API.

------
#### [ Konsol Manajemen AWS ]

**Untuk mengonfigurasi metode API agar memerlukan kunci API**

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

1. Pilih REST API.

1. Di panel navigasi utama API Gateway, pilih **Resources**.

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

1. Pada tab **Permintaan metode**, di bawah **Pengaturan permintaan metode**, pilih **Edit**.  
![\[Menambahkan kunci API ke metode\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/api-gateway-new-console-add-key-to-method.png)

1. Pilih **kunci API yang diperlukan**.

1. Pilih **Simpan**.

1. Menerapkan atau menerapkan ulang API agar persyaratan diterapkan.

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

------
#### [ AWS CLI ]

Perintah [put-method](https://docs.aws.amazon.com/cli/latest/reference/apigateway/put-method.html) berikut membuat `PUT` metode yang memerlukan kunci API:

```
aws apigateway put-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --authorization-type "NONE" \
    --api-key-required
```

Perintah [update-method](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-method.html) berikut memperbarui metode yang ada untuk memerlukan kunci API:

```
aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method PUT \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"
```

------
#### [ REST API ]

Untuk mewajibkan kunci API pada suatu metode, lakukan salah satu hal berikut:
+ Panggilan [https://docs.aws.amazon.com/apigateway/latest/api/API_PutMethod.html](https://docs.aws.amazon.com/apigateway/latest/api/API_PutMethod.html)untuk membuat metode. Setel `apiKeyRequired` ke `true` dalam payload permintaan.
+ Panggilan [https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateMethod.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateMethod.html)untuk mengatur `apiKeyRequired` ke`true`.

------

## Membuat kunci API
<a name="api-gateway-usage-plan-create-apikey"></a>

Prosedur berikut menunjukkan cara membuat kunci API. Jika Anda ingin mengimpor kunci API Anda, lewati langkah ini.

------
#### [ Konsol Manajemen AWS ]

**Untuk membuat kunci API**

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

1. Pilih REST API.

1. Di panel navigasi utama API Gateway, pilih **kunci API**.

1. Pilih **Buat kunci API**.  
![\[Buat kunci API untuk paket penggunaan\]](http://docs.aws.amazon.com/id_id/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-choose-create-api-key-from-actions-menu.png)

1. Untuk **Nama**, masukkan nama.

1. (Opsional) Untuk **Deskripsi**, masukkan deskripsi.

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

1. Pilih **Simpan**.

------
#### [ AWS CLI ]

[create-api-key](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html)Perintah berikut membuat kunci API:

```
 aws apigateway create-api-key \
    --name 'Dev API key' \
    --description 'API key for Devs' \
    --enabled
```

------
#### [ REST API ]

Panggilan [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateApiKey.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateApiKey.html)untuk membuat kunci API.

------

## Impor kunci API
<a name="api-gateway-usage-pan-import-apikey"></a>

Prosedur berikut menjelaskan cara mengimpor kunci API. Jika Anda sudah membuat kunci API, lewati langkah ini.

------
#### [ Konsol Manajemen AWS ]

**Untuk mengimpor kunci API**

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

1. Pilih REST API.

1. Di panel navigasi utama, pilih **kunci API**.

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

1. Untuk memuat file kunci yang dipisahkan koma, pilih **Pilih** file. Anda juga dapat memasukkan tombol di editor teks. Untuk informasi tentang format file, lihat[Format file kunci API untuk API Gateway](api-key-file-format.md).

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

1. Pilih **Impor** untuk mengimpor kunci API Anda.

------
#### [ AWS CLI ]

[import-api-keys](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-api-keys.html)Perintah berikut mengimpor kunci API:

```
aws apigateway import-api-key \
    a--body fileb://keys.csv \
    --format csv
```

------
#### [ REST API ]

Panggilan [https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html](https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html)untuk mengimpor kunci API dari file. Untuk format file, lihat[Format file kunci API untuk API Gateway](api-key-file-format.md).

------

Anda tidak dapat mengubah nilai kunci API baru. Setelah membuat API, Anda mengonfigurasi paket penggunaan. Untuk informasi selengkapnya, lihat [Siapkan paket penggunaan untuk REST APIs di API Gateway](api-gateway-create-usage-plans.md).