Halaman ini berlaku untuk Apigee dan Apigee hybrid.
Lihat dokumentasi
Apigee Edge.
Produk API memaketkan API Anda dan menyediakannya untuk digunakan oleh developer aplikasi. Untuk ringkasan produk API, lihat Apa itu produk API?
Menjelajahi halaman ringkasan produk API
Halaman ringkasan Products menampilkan semua produk API Anda dan beberapa detail tentang setiap produk. Dari halaman ini, Anda dapat membuat produk API baru, menghapus produk, atau memilih produk untuk dilihat atau diedit.
Untuk mengakses halaman ringkasan Produk di konsol Apigee in Cloud:
UI Produk memungkinkan Anda melakukan tugas umum berikut:
- Menambahkan produk API
- Mengedit produk API
- Menelusuri daftar produk API
- Menghapus produk API
Tugas ini dijelaskan di bagian berikut.
Membuat produk API
Bagian ini menjelaskan cara membuat produk API menggunakan UI Apigee.
Untuk membuat produk API menggunakan UI Apigee:
Buka halaman ringkasan Products:
- Klik + Buat. Halaman konfigurasi produk akan ditampilkan.
- Konfigurasi produk API. Bagian halaman konfigurasi produk mencakup hal berikut:
- Detail produk: Informasi dasar tentang produk API seperti namanya, tingkat akses (pribadi, publik, atau internal), dan cakupan OAuth.
- Operasi: Grup proxy API, jalur resource, dan metode HTTP yang didukung oleh produk API ini. Anda juga dapat menentukan batas kuota untuk setiap operasi.
- Operasi GraphQL: Grup proxy API, jalur resource, dan jenis operasi GraphQL yang didukung oleh produk API ini. Jenis operasi GraphQL yang didukung mencakup kueri dan mutasi. Anda dapat menentukan salah satu jenis atau yang lain, atau keduanya. Sama seperti untuk proxy API berbasis REST, Anda dapat menentukan batas kuota pada setiap operasi.
- Operasi gRPC: Menentukan proxy gRPC API dan metode gRPC yang didukung oleh produk API ini. Sama seperti proxy API berbasis REST, Anda dapat menentukan batas kuota pada operasi.
- Atribut kustom: Pasangan nilai kunci yang membantu Anda mengontrol eksekusi proxy API.
Setiap bagian utama ini dijelaskan di bagian bawah.
- Bila telah selesai, klik Simpan. Apigee membuat produk API baru. Sekarang Anda dapat melampirkan produk ke aplikasi Developer. Lihat Mengontrol akses ke API Anda dengan mendaftarkan aplikasi. Untuk contoh tambahan, lihat Mengamankan API dengan mewajibkan kunci API dan Mengamankan API dengan OAuth.
Detail produk
Di bagian Product details, masukkan informasi dasar tentang produk API baru Anda. Tabel berikut menjelaskan kolom di bagian ini:
| Kolom | Wajib? | Deskripsi |
|---|---|---|
Name |
Wajib |
Menentukan nama internal produk API. Anda menggunakan nilai ini dalam panggilan ke Apigee API yang mereferensikan produk API. Nilai kolom Misalnya |
Display name |
Wajib |
Menentukan nama yang digunakan di UI Apigee untuk produk API. Anda dapat mengedit nama tampilan produk API kapan saja.
Misalnya, |
Description |
Opsional |
String yang dapat membantu Anda mengingat tujuan atau fungsi produk API. Deskripsi dapat menyertakan karakter khusus. Contoh, |
Environment |
Opsional |
Mengidentifikasi lingkungan yang diizinkan untuk diakses oleh produk API. Jika tidak ada lingkungan yang ditentukan, semua lingkungan diizinkan oleh Produk API. Lingkungan yang Anda pilih di kolom ini membatasi akses ke proxy API berdasarkan tempatnya di-deploy. Misalnya, jika proxy API A di-deploy ke lingkungan
|
Access |
Wajib | Tingkat akses yang diberikan kepada pengguna produk API ini. Untuk mengetahui detailnya, lihat Tingkat akses. |
Automatically approve access requests |
Opsional (default ke dipilih) |
Mengaktifkan persetujuan otomatis permintaan kunci yang masuk untuk produk API ini dari aplikasi mana pun. Untuk mewajibkan persetujuan kunci manual, nonaktifkan opsi ini. Default dipilih, yang berarti produk API ini otomatis menyetujui permintaan kunci. Jika memilih persetujuan kunci manual, Anda harus menyetujui permintaan kunci yang masuk dari aplikasi apa pun yang menggunakan produk API ini. Untuk menyetujui kunci secara manual:
Untuk informasi selengkapnya, lihat Mendaftarkan aplikasi dan mengelola kunci API. |
Quota |
Opsional |
Menentukan batas jumlah permintaan yang diizinkan untuk produk API ini. Nilai ini berlaku untuk jumlah semua permintaan operasi untuk produk API ini. Nilai ini diganti dengan batas kuota yang lebih spesifik yang ditetapkan pada operasi yang Anda tentukan di produk API. Memasukkan nilai kuota tidak otomatis menerapkan batasan pada jumlah panggilan yang dapat dilakukan melalui produk API. Anda juga harus menambahkan Kebijakan kuota ke proxy API yang dirujuk oleh produk API. Untuk mengetahui informasi selengkapnya, lihat Kuota. |
Allowed OAuth scope |
Opsional | Jika Anda menggunakan OAuth dengan produk API, masukkan daftar cakupan OAuth yang dipisahkan koma yang ingin Anda izinkan produk API (seperti Read atau cakupan lain yang dikirim aplikasi dengan panggilan API-nya). Untuk informasi selengkapnya, lihat Cakupan OAuth. |
Operasi
Tentukan operasi yang diizinkan di proxy API berbasis HTTP, termasuk jalur resource, metode HTTP, dan kuota. Operasi memungkinkan Anda mengontrol metode REST mana dan memiliki akses ke jalur resource mana dalam produk API, serta berapa banyak panggilan tersebut yang dapat dilakukan (dengan Kuota).
Untuk mengonfigurasi detail operasi, klik + TAMBAHKAN OPERASI di bagian Operasi. Tampilan Operasi akan ditampilkan.
| Kolom | Wajib? | Deskripsi |
|---|---|---|
API proxy |
Wajib |
Pilih proxy API yang akan dikaitkan dengan operasi ini. |
Path |
Wajib |
Masukkan jalur resource untuk operasi. Anda dapat menggunakan jalur operasi untuk mengizinkan atau melarang permintaan ke URI tertentu. Misalnya, jika Anda menetapkan sumber operasi ke proxy Dalam hal ini, panggilan ke Perhatikan bahwa ada aturan khusus untuk karakter pengganti di jalur resource, seperti yang dijelaskan dalam Mengonfigurasi jalur resource. |
Methods |
Opsional |
Pilih satu atau beberapa metode permintaan HTTP dalam daftar drop-down. (Metode ini terkadang disebut sebagai kata kerja HTTP.) Apigee mengizinkan permintaan ke proxy API yang hanya cocok dengan metode yang Anda pilih. Secara default, tidak ada pilihan, yang memungkinkan permintaan dengan metode HTTP apa pun. Jika Anda tidak memilih minimal satu metode, Apigee akan menyisipkan Untuk informasi tentang fungsi metode permintaan HTTP, lihat Metode permintaan HTTP. |
Quota |
Opsional | Tentukan batas kuota untuk operasi ini. Untuk mengetahui detail tentang cara penghitungan kuota, lihat Memahami penghitung kuota. |
Custom attributes |
Opsional | Lihat Atribut kustom. |
Operasi GraphQL
Untuk mengonfigurasi detail operasi GraphQL, klik + TAMBAHKAN OPERASI di bagian Operasi Graphql. Tampilan Operasi akan ditampilkan. Lihat juga Menggunakan GraphQL.
| Kolom | Wajib? | Deskripsi |
|---|---|---|
API proxy |
Wajib |
Pilih proxy API yang akan dikaitkan dengan operasi ini. |
Operation name |
Wajib |
Tentukan nama untuk operasi |
Operation type |
Opsional |
Pilih satu atau beberapa jenis operasi GraphQL di menu drop-down. Apigee mengizinkan permintaan ke proxy API yang hanya cocok dengan jenis operasi yang Anda pilih. Secara default, tidak ada pilihan, yang memungkinkan permintaan dengan jenis operasi apa pun. Jika Anda tidak memilih minimal satu jenis, Apigee akan menyisipkan Untuk mengetahui informasi tentang fungsi jenis operasi GraphQL, lihat Kueri dan Mutasi. |
Quota |
Opsional | Tentukan batas kuota untuk operasi ini. Kuota ini menggantikan kuota yang ditetapkan pada produk API. Lihat Kuota. |
Custom attributes |
Opsional | Lihat Atribut kustom. |
Operasi gRPC
Untuk mengonfigurasi detail operasi gRPC, klik + TAMBAHKAN OPERASI di bagian Operasi gRPC. Tampilan Operasi akan ditampilkan. Lihat juga Membuat proxy gRPC API.
| Kolom | Wajib? | Deskripsi |
|---|---|---|
API proxy |
Wajib |
Pilih proxy API yang akan dikaitkan dengan operasi ini. |
Service name |
Wajib |
Tentukan nama untuk operasi. Untuk rilis saat ini, tidak ada opsi untuk memberikan nama server target. (Nama layanan dan server target sama.) |
gRPC methods in service |
Opsional |
Masukkan metode gRPC yang tersedia, menggunakan daftar yang dipisahkan koma untuk beberapa metode. |
Quota |
Opsional | Tentukan batas kuota untuk operasi ini. Kuota ini menggantikan kuota yang ditetapkan pada produk API. Lihat Kuota. |
Custom attributes |
Opsional | Lihat Atribut kustom. |
Atribut khusus
Atribut kustom adalah pasangan kunci/nilai yang dapat digunakan dengan berbagai cara, termasuk membantu mengontrol eksekusi proxy API.
Secara total, produk API dapat memiliki hingga 18 atribut kustom, termasuk yang ditetapkan pada operasi.
Misalnya, Anda dapat membuat atribut kustom bernama deprecated dengan nilai true atau false. Dalam alur proxy API, Anda dapat memeriksa
nilai atribut deprecated produk API. Jika nilainya adalah
true, Anda dapat menampilkan error dengan kebijakan RaiseFault karena Anda
ingin operasi tersebut berperilaku seolah-olah tidak digunakan lagi dan tidak lagi didukung.
Kuota
Menentukan setelan kuota di proxy API atau cakupan operasi. Ada tiga kolom di bagian
Quota yang harus Anda tentukan, jika Anda menentukan kuota:
Kolom pertama menentukan jumlah maksimum permintaan yang diizinkan dari aplikasi developer ke proxy API selama periode yang ditentukan.
Kolom ini sesuai dengan elemen
<Allow>dalam kebijakan Kuota.Kolom kedua menentukan frekuensi (atau interval) reset kuota.
Kolom ini sesuai dengan elemen
<Interval>dalam kebijakan Kuota.Kolom ketiga menentukan jenis periode reset (atau satuan waktu), seperti hari, minggu, atau bulan.
Kolom ini sesuai dengan elemen
<TimeUnit>dalam kebijakan Kuota.
Contoh berikut menetapkan batas 1.000 permintaan GET, HEAD, dan
TRACE ke proxy API per hari (semua permintaan HTTP lainnya
akan diabaikan):
Contoh berikut menetapkan batas 42 permintaan setiap 3 menit, terlepas dari metode HTTP, ke resource /mypath:
Saat menentukan kuota untuk operasi, Anda harus memasukkan nilai untuk ketiga kolom di bagian Kuota.
Anda tidak dapat menentukan kuota berbeda untuk beberapa metode HTTP pada operasi yang sama. Untuk melakukannya, Anda harus membuat beberapa produk API dan menentukan kuota khusus metode di setiap produk.
Jika Anda menetapkan nilai ini di Kebijakan kuota dan di produk API (di UI seperti yang dijelaskan di sini atau dengan API produk API, setelan UI/API produk API akan diprioritaskan.
Mengonfigurasi jalur resource
Perhatikan aturan berikut untuk jalur resource:
/: Menunjukkan bahwa jalur dasar dan semua subjalur jalur dasar didukung./**: Menunjukkan bahwa semua subjalur jalur dasar didukung (tetapi bukan jalur dasar)./*: Menunjukkan bahwa hanya URI satu tingkat di bawah dari jalur dasar yang didukung.- Jalur resource yang ditentukan pada produk API atau pada operasinya berlaku untuk semua proxy API yang ditambahkan ke produk API.
- Jalur resource yang lebih inklusif dan kurang spesifik lebih diutamakan daripada yang
lebih spesifik. Misalnya, jika Anda menambahkan
/dan/**, jalur resource/akan diprioritaskan dan jalur resource/**akan diabaikan.
Tabel berikut menunjukkan perilaku default produk API untuk
berbagai jalur resource. 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 |
|||||
/v1/weatherapikey/ |
|||||
/v1/weatherapikey/1 |
|||||
/v1/weatherapikey/1/ |
|||||
/v1/weatherapikey/1/2 |
|||||
/v1/weatherapikey/1/2/ |
|||||
/v1/weatherapikey/1/2/3/ |
|||||
/v1/weatherapikey/1/a/2/3/ |
Secara default, jalur resource / dalam produk API
mendukung jalur dasar dan semua subjalur. Misalnya, jika jalur dasar
proxy API adalah /v1/weatherapikey, produk API akan mendukung permintaan ke
/v1/weatherapikey dan ke subjalur apa pun, seperti
/v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, dan sebagainya.
Dengan produk API, 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 membuat perubahan ini, dalam
tabel di atas, hanya dua baris pertama di bagian "Diizinkan untuk /" yang akan diizinkan.
Untuk informasi tambahan, lihat Memahami konfigurasi Produk API
Mengedit produk API
Untuk mengedit produk API:
Buka halaman ringkasan Products:
- Klik baris produk API yang ingin diedit. Apigee menampilkan detail produk API.
- Klik EDIT.
-
Edit setelan produk API, sesuai kebutuhan.
Anda tidak dapat mengedit resource API yang ada. Sebagai gantinya, Anda harus menghapus resource API dan menambahkan versi baru dengan nilai yang dikoreksi jika ingin mengubahnya.
Anda dapat menghapus resource jika tidak berfungsi atau memerlukan lebih banyak pengembangan. Jika dihapus, resource tersebut tidak lagi menjadi bagian dari produk API saat ini. Setiap aplikasi yang menggunakan produk API tidak dapat lagi mengakses resource yang dihapus. Resource yang dihapus dihapus dari produk API, tetapi tidak dihapus dari sistem, sehingga masih dapat digunakan oleh produk API lainnya.
- (Opsional) Jika Monetisasi Apigee diaktifkan, buat paket tarif untuk produk API dengan
mengklik Tambahkan paket tarif atau
(UI klasik). -
Klik Simpan.
Perubahan Anda akan diterapkan dalam waktu singkat (sekitar lima menit).
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:
Buka halaman ringkasan Products:
- Buka menu Actions di baris produk API yang akan dihapus, lalu pilih Delete.
- Setelah Anda mengonfirmasi operasi penghapusan, penghapusan akan diterapkan dalam jangka waktu singkat (sekitar lima menit).