Mengelola produk API

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

Kelola produk API menggunakan UI pengelolaan Apigee Edge, seperti yang dijelaskan di bagian ini. Untuk mengelola produk API menggunakan API, lihat Menggunakan API pengelolaan Edge untuk Memublikasikan API.

Tonton video berikut untuk mempelajari cara membuat produk API.

Untuk ringkasan produk API, lihat Apa yang dimaksud dengan produk API?.

Menjelajahi halaman produk API

Akses halaman produk API, seperti yang dijelaskan di bawah ini.

Edge

Untuk mengakses halaman produk API menggunakan Edge UI:

  1. Login ke https://apigee.com/edge.
  2. Pilih Publish > API Products.

Halaman Produk API akan ditampilkan.

Halaman Produk API yang menampilkan daftar produk API. Info disediakan yang menampilkan tugas yang dapat Anda selesaikan, yang tercantum di bawah gambar.

Seperti yang ditampilkan dalam gambar sebelumnya, halaman produk API memungkinkan Anda melakukan tugas berikut, yang akan dijelaskan nanti di bagian ini:

Edge Klasik (Private Cloud)

Untuk mengakses halaman produk API menggunakan UI Edge Klasik:

  1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih Publikasikan > Produk.

Halaman produk API memungkinkan Anda melakukan tugas berikut, yang akan dijelaskan nanti di bagian ini:

Menambahkan produk API

Tambahkan produk API menggunakan UI, seperti yang dijelaskan di bawah ini. Untuk menggunakan Edge API, lihat Mengonfigurasi produk API menggunakan API.

Untuk menambahkan produk API menggunakan UI Edge:

  1. Akses halaman produk API, seperti yang dijelaskan sebelumnya di bagian ini.
  2. Klik +Produk API.
  3. Masukkan Detail Produk untuk produk API Anda.
    Kolom Deskripsi
    Nama Nama internal produk API. Anda tidak dapat mengedit nama setelah produk API dibuat. Jangan cantumkan karakter khusus dalam nama.
    Nama tampilan Nama tampilan untuk produk API. Nama tampilan digunakan di UI dan Anda dapat mengeditnya kapan saja. Jika tidak ditentukan, nilai Name akan digunakan. Kolom ini diisi secara otomatis menggunakan nilai Nama; Anda dapat mengedit atau menghapus kontennya. Nama tampilan dapat berisi karakter khusus.
    Deskripsi Deskripsi produk API.
    Environment Lingkungan yang akan diizinkan oleh produk API. Misalnya test atau prod.
    Akses Tingkat akses. Untuk mengetahui detailnya, lihat Tingkat akses.
    Menyetujui permintaan akses secara otomatis Aktifkan persetujuan otomatis permintaan kunci untuk produk API ini dari aplikasi apa pun. Untuk mewajibkan persetujuan kunci secara manual, nonaktifkan opsi ini. Lihat Mendaftarkan aplikasi dan mengelola kunci API (UI) dan Kunci Aplikasi Developer (API).
    Kuota Batas kuota yang ingin Anda referensikan dari kebijakan kuota. Memasukkan nilai kuota tidak secara otomatis menerapkan pembatasan pada jumlah panggilan yang dapat dilakukan melalui produk. Proxy API yang dirujuk oleh produk harus menyertakan kebijakan Kuota untuk menerapkan kuota. Untuk mengetahui informasi selengkapnya, lihat Kuota.
    Cakupan OAuth yang Diizinkan Jika Anda menggunakan OAuth dengan produk API, cakupan OAuth yang diizinkan dan yang diizinkan oleh produk API (seperti Baca atau cakupan lain yang akan dikirim aplikasi dengan panggilan API-nya). Tentukan beberapa cakupan sebagai daftar yang dipisahkan koma. Lihat cakupan OAuth.
  4. Tambahkan Resource API yang tersedia di produk API, termasuk proxy API dan jalur resource.

    Misalnya, jika Anda menambahkan proxy API "musik" ke produk dengan jalur dasar /music, produk API tersebut akan mengizinkan panggilan ke /music. Namun, jika Anda ingin produk API hanya mengizinkan akses ke jalur resource venues, yang memiliki URI /music/venues, tambahkan jalur resource /venues ke produk. Dalam hal ini, panggilan ke /music/venues?name=paramount diizinkan, tetapi panggilan ke /music/artists?name=Jack%Johnson akan diblokir.

    Tetapkan jalur resource spesifik atau tetapkan jalur dasar dan semua subjalur yang memungkinkan dengan menentukan jalur resource sebagai /. Jalur resource dapat menyertakan karakter pengganti /** dan /*. Karakter pengganti tanda bintang ganda menunjukkan bahwa semua subjalur jalur dasar didukung (tetapi bukan jalur dasar). Tanda bintang tunggal menunjukkan bahwa hanya URI yang satu tingkat di bawah jalur dasar yang didukung. Lihat Mengonfigurasi perilaku jalur resource '/', '/*', dan '/**', seperti yang akan dijelaskan di bagian ini nanti.

    Untuk menambahkan resource API:

    1. Klik Add a proxy atau Add a path di bagian API resources.
    2. Pilih apakah Anda ingin menambahkan proxy API, Jalur, atau proxy dan jalur API.

      Bagian Menambahkan resource API memungkinkan Anda menambahkan proxy API, jalur resource, atau keduanya.

    3. Tambahkan satu atau beberapa proxy API dan jalur resource.

      Perhatikan hal berikut:

      • Jalur resource yang Anda tentukan berlaku untuk semua proxy API yang ditambahkan ke produk API.
      • Jalur resource yang lebih inklusif dan kurang spesifik lebih diutamakan daripada jalur yang lebih spesifik. Misalnya, jika Anda menambahkan / dan /**, jalur resource / akan diprioritaskan; jalur resource /** akan diabaikan.

      Contoh:

      Jalur resource yang diterapkan ke semua proxy API dan jalur resource yang lebih spesifik akan diabaikan

    4. Klik Add atau Add and Start another (untuk menentukan resource API tambahan).
  5. (Opsional) Gunakan bagian Target layanan jarak jauh Apigee untuk mengikat produk ke satu atau beberapa target layanan jarak jauh. Anda dapat mengabaikan setelan ini, kecuali jika menggunakan Apigee Envoy Adapter. Untuk mengetahui informasi selengkapnya, lihat Panduan operasi untuk Adaptor Envoy Apigee.
  6. (Opsional) Gunakan bagian Atribut khusus untuk menambahkan hingga 18 atribut khusus ke sebuah produk API.

    Atribut khusus adalah key-value pair yang dapat digunakan dalam berbagai cara, termasuk membantu mengontrol eksekusi proxy API. Misalnya, Anda dapat membuat atribut khusus bernama deprecated dengan nilai true (benar) atau false (salah). Dalam alur proxy API, Anda dapat memeriksa nilai atribut deprecated produk API (misalnya, menggunakan variabel verifyapikey.{policy_name}.apiproduct.deprecated yang tersedia secara otomatis setelah Anda membuat atribut khusus). Jika nilainya true (tidak digunakan lagi), Anda dapat menampilkan error dengan kebijakan Raise Fault.

  7. Klik Simpan.

Mengonfigurasi perilaku jalur resource '/', '/*', dan '/**'

Tabel berikut menjelaskan perilaku default produk API untuk jalur resource yang berbeda. Dalam contoh ini, proxy API memiliki jalur dasar /v1/weatherapikey. Jalur resource produk API berlaku untuk akhiran jalur setelah jalur dasar.

URI Permintaan Diizinkan untuk / Diizinkan untuk /* Diizinkan untuk /** Diizinkan untuk /*/2/** Diizinkan untuk /*/2/*

/v1/weatherapikey

Y

N

T

T

N

/v1/weatherapikey/

Y

N

T

T

N

/v1/weatherapikey/1

Y

Y

Y

N

N

/v1/weatherapikey/1/

Y

Y

Y

N

N

/v1/weatherapikey/1/2

Y

T

Y

N

N

/v1/weatherapikey/1/2/

Y

T

Y

Y

N

/v1/weatherapikey/1/2/3/

Y

T

Y

Y

Y

/v1/weatherapikey/1/a/2/3/

Y

T

Y

N

N

Secara default, jalur resource / dalam produk API mendukung jalur dasar dan semua subjalur. Misalnya, jika Jalur Dasar proxy API adalah /v1/weatherapikey, produk API mendukung permintaan ke /v1/weatherapikey dan subjalur apa pun, seperti /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, dan seterusnya.

Anda dapat mengubah setelan default ini sehingga jalur resource / hanya sesuai dengan Jalur Dasar proxy API. Artinya, produk API tidak akan mengizinkan akses ke URI yang memiliki apa pun setelah /. Jika Anda melakukan perubahan ini, pada tabel di atas, hanya dua baris pertama di bagian "Allowed for /" yang akan berisi "Y".

Untuk mengubah setelan default, administrator sistem harus menetapkan nilai properti features.isSingleForwardSlashBlockingEnabled di organisasi Anda ke true. Pelanggan cloud dapat mengirimkan permintaan tersebut ke Dukungan Apigee Edge.

Mengedit produk API

Untuk mengedit produk API:

  1. Akses halaman produk API, seperti yang dijelaskan sebelumnya di bagian ini.
  2. Klik baris produk API yang ingin Anda edit.
  3. Klik Edit di halaman produk API.
  4. Edit kolom sesuai kebutuhan.

    Anda dapat menghapus resource yang telah ditambahkan ke produk API. Sebaiknya lakukan hal ini jika resource tidak berfungsi atau memerlukan pengembangan lebih lanjut. Saat dihapus, resource tersebut tidak lagi menjadi bagian dari produk API. Aplikasi apa pun yang menggunakan produk API tidak dapat lagi mengakses resource yang dihapus. Resource yang dihapus akan dihapus dari produk, tetapi tidak dihapus dari sistem, sehingga masih dapat digunakan oleh produk lain.

  5. Klik Simpan.

Dengan Apigee Edge untuk Cloud Publik, Edge menyimpan entity berikut dalam cache selama minimal 180 detik setelah entity diakses.

  • Token akses OAuth. Artinya, token yang dicabut mungkin masih berhasil selama maksimal tiga menit, sampai batas cache-nya berakhir.
  • Entitas Key Management Service (KMS) (Aplikasi, Developer, Produk API).
  • Atribut khusus pada token OAuth dan entitas KMS.

Menghapus produk API

Sebelum dapat menghapus produk API, Anda harus membatalkan pendaftaran/membatalkan pengaitan aplikasi developer apa pun yang terkait dengan produk tersebut. Anda dapat melakukannya dengan menghapus aplikasi atau mencabut kunci API aplikasi.

Untuk menghapus produk API:

  1. Akses halaman produk API, seperti yang dijelaskan sebelumnya di bagian ini.
  2. Posisikan kursor di atas produk API dalam daftar.
  3. Klik Ikon hapus.
  4. Klik Hapus untuk mengonfirmasi operasi penghapusan.