Bagian 2: Membuat dan menguji kunci API

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

Direfaktor dan dialihkan ke Mengamankan API dengan mewajibkan kunci API.

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

Publikasi adalah proses membuat API Anda tersedia bagi developer aplikasi untuk digunakan. API publikasi dapat didefinisikan secara luas oleh tugas berikut:

  1. Buat produk API di Apigee Edge yang menggabungkan 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 menerima kunci API. Setelah memiliki kunci API, developer dapat membuat permintaan ke API Anda.

Untuk mengetahui informasi selengkapnya, lihat Pengantar publikasi.

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

Istilah Definisi
Produk API Kumpulan proxy API yang dikombinasikan dengan paket layanan yang menetapkan batas akses ke API tersebut. Produk API adalah mekanisme utama 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 dalam 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, tempat 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 berikut di kolom dialog Tambahkan Produk:
    Kolom Nilai
    Nama Produk API Gratis
    Nama Tampilan Produk API Gratis
    Deskripsi Produk API Gratis
    Lingkungan uji
    Akses Khusus internal
    Jenis persetujuan kunci Otomatis
    (kunci API otomatis disetujui setelah dibuat)
    Kuota 10 permintaan per 1 jam
    (membatasi jumlah permintaan hingga 10 per jam)
    Cakupan OAuth yang Diizinkan biarkan kosong

    Dialog yang telah diisi akan terlihat seperti ini:

  4. Di bagian Resources, pilih:
    • Proxy API: weatherapikey
    • Revisi: 1
    • Jalur Resource: /forecastrss**

      Jalur Resource menentukan URI resource yang aksesnya diizinkan oleh produk untuk aplikasi. Dalam contoh ini, aplikasi hanya dapat mengakses resource /forecastrss di proxy weatherapikey melalui produk API ini. Mencoba menggunakan produk API ini untuk mengakses resource lain di proxy weatherapiproxy, atau di proxy lain, dilarang.

      Karakter pengganti diizinkan untuk Jalur Resource. Karakter pengganti "/**" menunjukkan bahwa semua sub-URI disertakan, yang berarti resource dalam bentuk /forecastrss/foo/bar. Karakter pengganti "/" menunjukkan bahwa hanya URI satu tingkat di bawah yang disertakan. Lihat Membuat produk API untuk mengetahui informasi selengkapnya.

      Perhatikan bahwa menu dropdown Jalur Resource menampilkan semua alur bersyarat yang ditentukan pada proxy API yang ditentukan. Alur bersyarat proxy API menentukan logika, atau langkah-langkah pemrosesan, yang terkait dengan jalur resource. Produk API mengontrol akses ke jalur resource tersebut.
  5. Klik Impor Resource. Jalur resource ditambahkan, dan proxy API weatherapikey otomatis ditambahkan ke bagian API Proxies for Product.
  6. Klik Simpan. Produk baru Anda akan tercantum di halaman Produk.

Pelajari lebih lanjut:

Langkah 2: Daftarkan developer

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

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

Pelajari lebih lanjut:

Langkah 3: Daftarkan aplikasi

Setelah memiliki produk API dan developer, Anda dapat mendaftarkan aplikasi ke produk API. Pendaftaran aplikasi akan menghasilkan kunci API untuk produk API yang terkait dengan aplikasi tersebut. Kemudian, Anda dapat mendistribusikan kunci tersebut kepada developer aplikasi agar mereka dapat mengakses fitur dalam produk API dari aplikasi.

  1. Di UI Platform API, klik tab Publish, lalu Developer Apps.
  2. Klik (+) Aplikasi Developer.
  3. Di dialog Tambahkan Aplikasi, masukkan nilai berikut:
    • Nama Tampilan: Aplikasi Kunci API Cuaca
    • Developer: Jane Tutorial (janetutorial@example.com)
    • URL Panggilan Balik: 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 di daftar aplikasi di halaman Aplikasi Developer.
  6. Pilih Weather API Key App dalam daftar aplikasi. Tindakan ini akan membuka halaman detail aplikasi.
  7. Karena Anda memilih Jenis Persetujuan Kunci: Otomatis saat membuat produk API, kunci API akan disetujui secara otomatis dan Anda dapat melihatnya secara langsung. (Jika Anda telah memilih Jenis Persetujuan: Manual, Anda harus mengklik Setujui di kolom Tindakan untuk Produk API Gratis guna menyetujui kunci API.)
  8. Di bagian Produk, di samping entri untuk Free API Product, klik Tampilkan 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 dibutuhkan aplikasi untuk mengakses resource forecast melalui proxy API Anda . Consumer Secret diperlukan (bersama dengan Consumer Key) untuk mengamankan API melalui OAuth 2.0. Lihat, misalnya, OAuth 2.0: Mengonfigurasi proxy API baru.

Pelajari lebih lanjut:

Langkah 4: Gunakan kunci API dalam permintaan

Untuk memastikan 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 akan diminta dalam format:

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 tidak menyertakan kunci API dalam permintaan, atau menentukan nilai kunci yang tidak valid, Anda akan menerima respons error dalam bentuk:

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

Langkah 5: Ke mana selanjutnya?

Setelah 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.