Bagian 2: Membuat dan menguji kunci API

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Difaktorkan ulang dan dialihkan ke Secure an API dengan mewajibkan kunci API.

Developer membuat aplikasi yang membuat permintaan ke API Anda untuk mengakses layanan backend. Untuk mengontrol akses ke API, Anda dapat mengharuskan developer untuk meneruskan kunci API pada setiap permintaan. Jika kunci tidak ada atau tidak valid, permintaan akan gagal.

Publikasi adalah proses menyediakan API bagi developer aplikasi untuk digunakan. Publishing API dapat ditentukan secara luas berdasarkan tugas berikut:

1. Buat produk API di Apigee Edge yang memaketkan API Anda.
2. Mendaftarkan developer aplikasi di Edge. Hanya developer aplikasi terdaftar yang dapat mendaftarkan aplikasi.
3. Developer mendaftarkan aplikasi di Edge untuk mengakses produk API. Sebagai respons, developer akan menerima kunci API. Setelah memiliki kunci API, developer dapat membuat permintaan ke API Anda.

Untuk informasi selengkapnya, lihat Pengantar publikasi.

Tabel berikut mendefinisikan beberapa istilah yang digunakan untuk mendaftarkan aplikasi dan membuat kunci:

Masa Berlaku	Definisi
Produk API	Paket proxy API yang digabungkan dengan paket layanan yang menetapkan batas akses ke API tersebut. Produk API adalah mekanisme sentral yang digunakan Apigee Edge untuk otorisasi dan kontrol akses ke API Anda.
Developer	Konsumen API. Developer menulis aplikasi yang membuat permintaan ke API Anda.
Aplikasi	Aplikasi sisi klien yang didaftarkan developer untuk mengakses produk API. Mendaftarkan aplikasi dengan produk API akan menghasilkan kunci API untuk mengakses API di produk tersebut.
Kunci API	String dengan informasi otorisasi yang digunakan aplikasi sisi klien untuk mengakses resource yang diekspos oleh produk API. Kunci API dibuat saat aplikasi terdaftar dikaitkan dengan produk API.

Prasyarat untuk tutorial ini

Tutorial ini mengasumsikan bahwa Anda telah menyelesaikan tutorial pertama, di mana Anda membuat proxy API untuk mengakses Yahoo weather API. Jika Anda belum menyelesaikan tutorial pertama, lihat Mengamankan API dengan mewajibkan kunci API.

Langkah 1: Buat produk API

1. Di UI pengelolaan, klik tab Publikasikan, lalu Produk.
2. Klik (+) Produk.
3. Masukkan atau pilih hal berikut di kolom dialog Tambahkan Produk:

   Kolom	Nilai
   Nama	Produk API Gratis
   Nama Tampilan	Produk API Gratis
   Deskripsi	Produk API Gratis
   Lingkungan	tes
   Akses	Khusus internal
   Jenis persetujuan kunci	Otomatis (kunci API otomatis disetujui setelah dibuat)
   Kuota	10 permintaan per 1 jam (membatasi jumlah permintaan menjadi 10 per jam)
   Cakupan OAuth yang Diizinkan	biarkan kosong

   Dialog yang terisi akan terlihat seperti ini:

   

4. Di bagian Referensi, pilih:
   • Proxy API: weatherapikey
   • Revisi: 1
   • Resource Path: /forecastrs**
     
     Resource Path menentukan URI resource yang diizinkan oleh produk untuk diakses oleh aplikasi. Dalam contoh ini, aplikasi hanya dapat mengakses resource /forecastrss di proxy weatherapikey melalui produk API ini. Dilarang mencoba menggunakan produk API ini untuk mengakses resource lain pada proxy weatherapiproxy, atau pada proxy lainnya.
     
     Karakter pengganti diizinkan untuk Jalur Resource. Karakter pengganti "/**" menunjukkan bahwa semua sub-URI disertakan, yang berarti resource berbentuk /forecastrss/foo/bar. Karakter pengganti "/" menunjukkan bahwa hanya URI satu tingkat ke bawah yang disertakan. Lihat Membuat produk API untuk mengetahui informasi selengkapnya.
     
     Perhatikan bahwa daftar dropdown Resource Path menampilkan semua flow bersyarat yang ditentukan pada proxy API yang ditentukan. Alur kondisional proxy API menentukan logika, atau langkah-langkah pemrosesan, yang terkait dengan jalur resource. Produk API mengontrol akses ke jalur resource tersebut.
     
5. Klik Import Resource. Jalur resource ditambahkan, dan proxy API weatherapikey ditambahkan secara otomatis ke bagian API Proxy untuk Product.
6. Klik Simpan. Produk baru Anda tercantum di halaman Produk.

Pelajari lebih lanjut:

• Membuat produk API

Langkah 2: Daftarkan developer

Untuk membuat kunci API, Anda harus mendaftarkan aplikasi dan mengaitkannya dengan produk API. Namun, Anda tidak dapat mendaftarkan aplikasi tanpa mendaftarkan developer aplikasi tersebut terlebih dahulu.

1. Di UI pengelolaan, klik tab Publikasikan, lalu Developer.
2. Klik (+) Developer.
3. Pada dialog Developer Baru, masukkan nilai berikut:
   • Nama Depan: Jane
   • Nama Belakang: Tutorial
   • Alamat email: janetutorial@example.com
   • Nama pengguna: jtutorial
4. Klik Simpan. Developer baru akan muncul dalam daftar developer di halaman Developer.

Pelajari lebih lanjut:

• Mengelola developer aplikasi

Langkah 3: Daftarkan aplikasi

Setelah memiliki produk API dan developer, Anda dapat mendaftarkan aplikasi ke produk API. Mendaftarkan aplikasi akan menghasilkan kunci API untuk produk API yang terkait dengan aplikasi. Anda kemudian dapat mendistribusikan kunci tersebut ke developer aplikasi agar mereka dapat mengakses fitur di produk API dari aplikasi.

1. Di UI Platform API, klik tab Publikasikan, lalu Aplikasi Developer.
2. Klik (+) Aplikasi Developer.
3. Masukkan nilai berikut ke dalam dialog Add an App:
   • Nama Tampilan: Aplikasi Kunci Weather API
   • Developer: Tutorial Jane (janetutorial@example.com)
   • Callback URL: biarkan kosong
4. Kaitkan aplikasi dengan produk:
   1. Di bagian Produk, klik + Produk.
   2. Pilih Free API Product.
   3. Klik ikon tanda centang untuk menerima perubahan.
5. Klik Simpan. Aplikasi baru akan muncul dalam daftar aplikasi di halaman Aplikasi Developer.
6. Pilih Weather API Key App di daftar aplikasi. Tindakan ini akan membuka halaman detail aplikasi.
7. Karena Anda memilih Key Approval Type: Otomatis saat membuat produk API, kunci API akan otomatis disetujui dan Anda dapat langsung melihatnya. (Jika telah memilih Approval Type: Manual, Anda harus mengklik Setujui di kolom Action untuk Free API Product guna menyetujui kunci API.)
8. Di bagian Products, di samping entri untuk Free API Product, klik Show di kolom Consumer Key dan Consumer Secret untuk menampilkan kunci yang dibuat.
   

   Kunci Konsumen adalah nama lain untuk kunci API dan merupakan satu-satunya kunci yang diperlukan aplikasi untuk mengakses resource perkiraan melalui proxy API Anda . Rahasia Konsumen diperlukan (beserta Kunci Konsumen) untuk mengamankan API melalui OAuth 2.0. Lihat, untuk contoh, OAuth 2.0: Mengonfigurasi proxy API baru.

Pelajari lebih lanjut:

• Daftarkan aplikasi dan kelola kunci API.

Langkah 4: Gunakan kunci API dalam permintaan

Untuk memastikan bahwa kebijakan VerifyAPIKey berfungsi dengan benar, Anda harus mengujinya dengan melakukan panggilan ke proxy API dengan kunci API yang valid. Anda dapat meminta proxy API di browser, dari halaman Trace proxy API, dari Konsol Apigee, atau dengan menggunakan cURL. URL yang dapat diminta berformat:

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

Ganti nama organisasi Apigee Anda dengan {org-name} dan nilai apikey yang benar.

Cari konten berikut dalam respons:

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

Jika Anda menghilangkan kunci API dari permintaan, atau menentukan nilai kunci yang tidak valid, Anda akan menerima respons error dalam formulir:

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Langkah 5: Apa langkah berikutnya?

Setelah Anda membuat permintaan ke API menggunakan parameter kueri untuk meneruskan kunci API, ubah API untuk meneruskan kunci sebagai header.

Lanjutkan ke Mengamankan API dengan mewajibkan kunci API.