APIFormat file API kunci gateway

APIGateway dapat mengimpor API kunci dari file eksternal dengan format value (CSV) yang dipisahkan koma, lalu mengaitkan kunci yang diimpor dengan satu atau beberapa paket penggunaan. File yang diimpor harus berisi Key kolom Name dan. Nama header kolom tidak peka huruf besar/kecil, dan kolom dapat dalam urutan apa pun, seperti yang ditunjukkan pada contoh berikut:

Key,name
apikey1234abcdefghij0123456789,MyFirstApiKey

KeyNilai harus antara 20 dan 128 karakter. NameNilai tidak boleh melebihi 1024 karakter.

File API kunci juga dapat memilikiDescription,Enabled, atau UsagePlanIds kolom, seperti yang ditunjukkan pada contoh berikut:

Name,key,description,Enabled,usageplanIds
MyFirstApiKey,apikey1234abcdefghij0123456789,An imported key,TRUE,c7y23b

Ketika kunci dikaitkan dengan lebih dari satu paket penggunaan, UsagePlanIds nilainya adalah string yang dipisahkan koma dari rencana penggunaanIDs, diapit dengan sepasang tanda kutip ganda atau tunggal, seperti yang ditunjukkan pada contoh berikut:

Enabled,Name,key,UsageplanIds
true,MyFirstApiKey,apikey1234abcdefghij0123456789,"c7y23b,glvrsr"

Kolom yang tidak dikenal diizinkan, tetapi diabaikan. Nilai default adalah string kosong atau nilai true Boolean.

APIKunci yang sama dapat diimpor beberapa kali, dengan versi terbaru menimpa yang sebelumnya. Dua API kunci identik jika mereka memiliki key nilai yang sama.

catatan

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