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 Edge Management API untuk Memublikasikan API.

Tonton video berikut untuk mempelajari cara membuat produk API.

Untuk mengetahui ringkasan produk API, lihat Apa itu produk API?.

Mempelajari halaman produk API

Akses halaman produk API, seperti yang dijelaskan di bawah.

Edge

Untuk mengakses halaman produk API menggunakan UI Edge:

  1. Login ke https://apigee.com/edge.
  2. Pilih Publikasikan > Produk API.

Halaman Produk API akan ditampilkan.

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

Seperti yang ditunjukkan pada gambar sebelumnya, halaman produk API memungkinkan Anda melakukan tugas berikut, yang dijelaskan nanti di bagian ini:

Classic Edge (Private Cloud)

Untuk mengakses halaman produk API menggunakan UI Edge Klasik:

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

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

Menambahkan produk API

Tambahkan produk API menggunakan UI, seperti yang dijelaskan di bawah. 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 tentukan 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 Nama akan digunakan. Kolom ini diisi otomatis menggunakan nilai Nama; Anda dapat mengedit atau menghapus isinya. Nama tampilan dapat menyertakan karakter khusus.
    Deskripsi Deskripsi produk API.
    Lingkungan Lingkungan yang akan diizinkan aksesnya 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 mana 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 rujuk dari kebijakan kuota. Memasukkan nilai kuota tidak secara otomatis memberlakukan batasan 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 yang Anda inginkan agar produk API diizinkan (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 API Resources 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 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 tertentu atau tetapkan jalur dasar dan semua kemungkinan subjalur dengan menentukan jalur resource sebagai /. Jalur resource dapat menyertakan karakter pengganti /** dan /*. Karakter pengganti dua tanda bintang menunjukkan bahwa semua subjalur dari jalur dasar didukung (tetapi bukan jalur dasar). Satu tanda bintang menunjukkan bahwa hanya URI satu tingkat di bawah jalur dasar yang didukung. Lihat Mengonfigurasi perilaku jalur resource '/', '/*', dan '/**', seperti yang dijelaskan nanti di bagian ini.

    Untuk menambahkan resource API:

    1. Klik Tambahkan proxy atau Tambahkan jalur di bagian resource API.
    2. Pilih apakah Anda ingin menambahkan proxy API, Jalur, atau proxy API dan jalur.

      Bagian Add API resource 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 diterapkan ke semua proxy API dan jalur resource yang lebih spesifik diabaikan

    4. Klik Tambahkan atau Tambahkan dan Mulai yang lain (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. Kecuali jika Anda menggunakan Apigee Envoy Adapter, Anda dapat mengabaikan setelan ini. Untuk mengetahui informasi selengkapnya, lihat Panduan operasi untuk Apigee Envoy Adapter.

  6. (Opsional) Gunakan bagian Atribut kustom untuk menambahkan hingga 18 atribut kustom ke produk API.

    Atribut khusus adalah pasangan kunci/nilai yang dapat digunakan dengan berbagai cara, termasuk membantu mengontrol eksekusi proxy API. Misalnya, Anda dapat membuat atribut kustom bernama deprecated dengan nilai benar atau salah. Dalam alur proxy API, Anda dapat memeriksa nilai atribut deprecated produk API (misalnya, menggunakan variabel verifyapikey.{policy_name}.apiproduct.deprecated yang otomatis tersedia setelah Anda membuat atribut kustom). Jika nilainya benar (tidak digunakan lagi), Anda dapat memunculkan 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 sufiks jalur setelah jalur dasar.

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

/v1/weatherapikey

Y

T

T

T

T

/v1/weatherapikey/

Y

T

T

T

T

/v1/weatherapikey/1

Y

Y

Y

T

T

/v1/weatherapikey/1/

Y

Y

Y

T

T

/v1/weatherapikey/1/2

Y

T

Y

T

T

/v1/weatherapikey/1/2/

Y

T

Y

Y

T

/v1/weatherapikey/1/2/3/

Y

T

Y

Y

Y

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

Y

T

Y

T

T

Secara default, jalur resource / di 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 ke subjalur apa pun, seperti /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, dan sebagainya.

Anda dapat mengubah default ini sehingga jalur resource / hanya sesuai dengan Jalur Dasar proxy API, yang berarti produk API tidak akan mengizinkan akses ke URI yang memiliki sesuatu setelah /. Jika Anda melakukan perubahan ini, maka dalam tabel di atas, hanya dua baris pertama di bagian "Diizinkan untuk /" yang akan berisi "Y".

Untuk mengubah default, administrator sistem harus menetapkan nilai properti features.isSingleForwardSlashBlockingEnabled di organisasi Anda ke true. Pelanggan Cloud dapat membuat 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 di 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. Anda mungkin perlu melakukannya jika resource tidak berfungsi dengan baik atau memerlukan pengembangan lebih lanjut. Jika 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 resource tersebut masih dapat digunakan oleh produk lain.

  5. Klik Simpan.

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

  • Token akses OAuth. Artinya, token yang dicabut masih dapat berhasil digunakan hingga tiga menit, hingga batas cache-nya berakhir.
  • Entitas Key Management Service (KMS) (Aplikasi, Developer, Produk API).
  • Atribut kustom pada token OAuth dan entitas KMS.

Menghapus produk API

Sebelum dapat menghapus produk API, Anda harus membatalkan pendaftaran/membatalkan pengaitan aplikasi developer 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.