Mengelola produk API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Produk API memaketkan API Anda dan menyediakannya bagi developer aplikasi untuk dipakai. Untuk ringkasan produk API, lihat Apa yang dimaksud dengan produk API?

Menjelajahi halaman Ringkasan produk

Halaman ringkasan Produk menampilkan semua produk API Anda dan sejumlah detail tentang setiap produk. Dari halaman ini, Anda dapat membuat produk API baru, menghapus produk, atau memilih produk untuk dilihat atau diedit.

Untuk mengakses Ringkasan produk:

  • Jika Anda menggunakan https://console.cloud.google.com/apigee: Pilih Distribusi > Produk API.
  • Jika Anda menggunakan UI Apigee klasik: Pilih Publish > API Products.

UI Produk memungkinkan Anda melakukan tugas umum berikut:

Tugas-tugas ini dijelaskan di bagian berikutnya.

Membuat produk API

Bagian ini menjelaskan cara membuat produk API menggunakan UI Apigee.

Untuk membuat produk API menggunakan UI Apigee:

    • Jika Anda menggunakan https://console.cloud.google.com/apigee: Pilih Distribusi > Produk API.
    • Jika Anda menggunakan UI Apigee klasik: Pilih Publish > API Products.

  2. Pilih Publish > API Products. Apigee menampilkan halaman ringkasan Products.
  3. Klik + Buat. Halaman konfigurasi produk akan ditampilkan.
  4. Konfigurasikan produk API. Bagian dari halaman konfigurasi produk mencakup bagian berikut:
    • Detail produk: Informasi dasar tentang produk API seperti nama, 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 lainnya, atau keduanya. Sama seperti 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 operasi.
    • Atribut khusus: Key-value pair yang membantu Anda mengontrol eksekusi proxy API.

    Setiap bagian utama ini dijelaskan di bagian bawah.

  5. Bila telah selesai, klik Simpan. Apigee membuat produk API baru. Sekarang Anda dapat menambahkan 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 Detail produk, masukkan informasi dasar tentang produk API baru Anda. Tabel berikut menjelaskan kolom di bagian ini:

Kolom Wajib? Deskripsi
Name Diperlukan

Menentukan nama internal produk API. Anda menggunakan nilai ini dalam panggilan ke Apigee API yang mereferensikan produk API tersebut. Nilai kolom Name dapat mencakup karakter alfanumerik, spasi, dan parameter berikut: _ - . # $ %

Misalnya My API Product atau my-product.
Display name Diperlukan

Menentukan nama yang digunakan di UI Apigee untuk produk API. Anda dapat mengedit nama tampilan produk API kapan saja.

Display name dapat berisi karakter khusus.

Misalnya, <My> API Product!!!.
Description Opsional

String yang bisa membantu Anda mengingat tujuan atau fungsi produk API. Deskripsi dapat menyertakan karakter khusus.

Contoh, The one where I let dev apps read but not write to the "/accounts" endpoints.
Environment Opsional

Mengidentifikasi lingkungan mana yang diizinkan aksesnya oleh produk API. Jika tidak ada lingkungan yang ditentukan, berarti semua lingkungan diizinkan oleh Produk API.

Lingkungan yang Anda pilih dalam kolom ini membatasi akses ke proxy API berdasarkan tempat deployment tersebut. Misalnya, jika proxy API A di-deploy ke lingkungan test dan prod, tetapi lingkungan test hanya dipilih untuk produk API, panggilan API untuk aplikasi developer terkait hanya mengizinkan akses ke proxy API A yang di-deploy di lingkungan test. Untuk mengetahui informasi selengkapnya tentang lingkungan, lihat Tentang lingkungan dan grup lingkungan.
Access Diperlukan Tingkat akses yang diberikan kepada pengguna produk API ini. Untuk mengetahui detailnya, lihat Tingkat akses.
Automatically approve access requests Opsional (default-nya adalah yang dipilih)

Mengaktifkan persetujuan otomatis atas permintaan kunci yang masuk untuk produk API ini dari aplikasi apa pun. Untuk mewajibkan persetujuan kunci manual, nonaktifkan opsi ini.

Setelan default dipilih, yang berarti produk API ini otomatis menyetujui permintaan kunci.

Jika memilih persetujuan kunci manual, Anda harus menyetujui permintaan kunci yang berasal dari aplikasi apa pun yang menggunakan produk API ini. Untuk menyetujui kunci secara manual:

Untuk mengetahui 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 digantikan oleh batas kuota yang lebih spesifik yang ditetapkan pada operasi yang Anda tentukan pada produk API.

Memasukkan nilai kuota tidak otomatis menerapkan pembatasan 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 lebih lanjut, lihat Kuota.
Allowed OAuth scope Opsional Jika Anda menggunakan OAuth dengan produk API, masukkan daftar yang dipisahkan koma dari cakupan OAuth yang Anda inginkan untuk diizinkan oleh produk API (seperti Baca atau cakupan lain yang dikirim aplikasi dengan panggilan API-nya). Untuk informasi selengkapnya, lihat Cakupan OAuth.

Operasi

Tentukan operasi yang diizinkan pada proxy API berbasis HTTP, termasuk jalur resource, metode HTTP, dan kuota. Dengan operasi, Anda dapat mengontrol metode REST dan mengakses jalur resource dalam produk API, serta jumlah panggilan yang dapat dilakukan (dengan Kuota).

Untuk mengonfigurasi detail operasi, klik + TAMBAHKAN OPERASI di bagian Operasi. Tampilan Operation akan ditampilkan.

Kolom Wajib? Deskripsi
API proxy Diperlukan

Pilih proxy API yang akan dikaitkan dengan operasi ini.
Path Diperlukan

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 API music dengan jalur dasar /music, produk API akan mengizinkan panggilan ke semua subjalur dalam /music. Namun, jika Anda ingin produk API hanya mengizinkan akses ke jalur resource venues yang memiliki URI /music/venues, tambahkan /venues sebagai jalur operasi. Anda dapat melakukan ini untuk semua operasi, atau untuk operasi tertentu.

Dalam hal ini, panggilan ke /music/venues?name=paramount diizinkan, tetapi panggilan ke /music/artists?name=Jack%Johnson diblokir.

Perlu diperhatikan bahwa terdapat aturan khusus untuk karakter pengganti di jalur resource, seperti yang dijelaskan dalam Mengonfigurasi jalur resource.
Methods Opsional

Pilih satu atau beberapa metode permintaan HTTP di menu drop-down. (Metode ini terkadang dikenal sebagai kata kerja HTTP.) Apigee mengizinkan permintaan ke proxy API yang hanya cocok dengan metode yang Anda pilih.

Defaultnya adalah tidak ada pilihan, yang memungkinkan permintaan dengan metode HTTP apa pun.

Jika Anda tidak memilih setidaknya satu metode, Apigee akan menyisipkan ALL sebagai nilai kolom ini saat Anda menyimpan operasi.

Untuk mengetahui 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 artikel Memahami penghitung kuota.
Custom attributes Opsional Lihat Atribut khusus.

Operasi GraphQL

Untuk mengonfigurasi detail operasi GraphQL, klik + ADD AN OPERATION di bagian Graphql Operations. Tampilan Operation akan ditampilkan. Lihat juga Menggunakan GraphQL.

Kolom Wajib? Deskripsi
API proxy Diperlukan

Pilih proxy API yang akan dikaitkan dengan operasi ini.
Operation name Diperlukan

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.

Defaultnya adalah tidak ada pilihan, yang memungkinkan permintaan dengan jenis operasi apa pun.

Jika Anda tidak memilih setidaknya satu jenis, Apigee akan menyisipkan ALL sebagai nilai kolom ini saat Anda menyimpan operasi.

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

Operasi gRPC

Untuk mengonfigurasi detail operasi gRPC, klik + TAMBAHKAN OPERASI di bagian Operasi gRPC. Tampilan Operation akan ditampilkan. Lihat juga Membuat proxy gRPC API.

Kolom Wajib? Deskripsi
API proxy Diperlukan

Pilih proxy API yang akan dikaitkan dengan operasi ini.
Service name Diperlukan

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

Atribut khusus

Atribut khusus adalah key-value pair yang dapat digunakan dengan banyak cara, termasuk membantu mengontrol eksekusi proxy API.

Secara total, produk API dapat memiliki hingga 18 atribut khusus, termasuk yang ditetapkan dalam operasi.

Misalnya, Anda dapat membuat atribut khusus 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. Jika Anda menentukan kuota, ada tiga kolom di Quota yang harus Anda tentukan:

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

  2. Kolom kedua menentukan frekuensi (atau interval) reset kuota.

    Kolom ini sesuai dengan elemen <Interval> dalam kebijakan Kuota.

  3. Kolom ketiga menentukan type 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):

Menambahkan kuota baru ke operasi

Contoh berikut menetapkan batas 42 permintaan setiap 3 menit, apa pun metode HTTP, ke resource /mypath:

Menambahkan kuota baru ke operasi

Saat menentukan kuota untuk suatu operasi, Anda harus memasukkan nilai untuk ketiga kolom di bagian Quota.

Anda tidak dapat menentukan kuota yang berbeda untuk beberapa metode HTTP di operasi yang sama. Untuk melakukannya, Anda harus membuat beberapa produk API dan menentukan kuota khusus metode pada setiap produk.

Jika Anda menetapkan nilai ini di Kebijakan kuota dan pada produk API (di UI seperti yang dijelaskan di sini atau dengan API produk API, setelan UI/API produk API akan lebih diutamakan.

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 yang satu tingkat di bawah 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 lebih sedikit lebih diutamakan daripada jalur resource 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 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
/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 mendukung permintaan ke /v1/weatherapikey dan subjalur apa pun, seperti /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, dan seterusnya.

Dengan produk API, Anda dapat mengubah setelan default ini sehingga jalur resource / hanya sesuai dengan jalur dasar proxy API. Ini berarti produk API tidak akan mengizinkan akses ke URI yang memiliki apa pun setelah /. Jika Anda membuat perubahan ini, maka dalam tabel di atas hanya dua baris pertama pada "Diizinkan untuk /" yang akan diizinkan.

Untuk informasi tambahan, lihat Memahami konfigurasi Produk API

Mengedit produk API

Untuk mengedit produk API:

    • Jika Anda menggunakan https://console.cloud.google.com/apigee: Pilih Distribusi > Produk API.
    • Jika Anda menggunakan UI Apigee klasik: Pilih Publish > API Products.

  2. Pilih Publish > API Products.
  3. Klik baris produk API yang ingin Anda edit. Apigee menampilkan detail tentang produk API.
  4. Klik EDIT.

  5. Edit setelan produk API, jika diperlukan.

    Anda tidak dapat mengedit resource API yang sudah ada. Sebagai gantinya, Anda harus menghapus resource API dan menambahkan versi baru dengan nilai yang sudah dikoreksi jika ingin mengubahnya.

    Anda dapat menghapus resource jika tidak berfungsi atau memerlukan pengembangan lebih lanjut. Saat dihapus, resource tersebut tidak lagi menjadi bagian dari produk API saat ini. Semua aplikasi yang menggunakan produk API tidak lagi dapat mengakses resource yang dihapus. Resource yang dihapus akan dibuang dari produk API, tetapi tidak dihapus dari sistem, sehingga masih dapat digunakan oleh produk API lainnya.

  6. (Opsional) Jika Monetisasi Apigee diaktifkan, buat paket tarif untuk produk API dengan mengklik Tambahkan.

  7. Klik Save.

    Perubahan 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. Anda dapat melakukannya dengan menghapus aplikasi atau mencabut kunci API aplikasi.

Untuk menghapus produk API:

    • Jika Anda menggunakan https://console.cloud.google.com/apigee: Pilih Distribusi > Produk API.
    • Jika Anda menggunakan UI Apigee klasik: Pilih Publish > API Products.

  2. Pilih Publish > API Products.
  3. Buka menu Tindakan di baris produk yang akan dihapus, lalu pilih Hapus.
  4. Setelah Anda mengonfirmasi operasi penghapusan, penghapusan akan diterapkan dalam waktu singkat (sekitar lima menit).