Mengelola produk API

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Produk API memaketkan API Anda dan menyediakannya bagi developer aplikasi untuk digunakan. Untuk tentang produk API, lihat Apa yang produk API?

Menjelajahi halaman Ringkasan produk

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

Untuk mengakses ringkasan Produk:

UI Produk memungkinkan Anda melakukan tugas umum berikut:

Tugas ini akan dijelaskan dalam bagian berikut.

Membuat produk API

Bagian ini menjelaskan cara membuat produk API menggunakan UI Apigee.

Untuk membuat produk API menggunakan UI Apigee:

  1. Jika Anda menggunakan UI Apigee di Konsol Cloud, pilih Distribution > API Google Cloud Platform. Jika Anda menggunakan UI Apigee klasik, pilih Publikasikan > API Produk.
  2. Apigee menampilkan halaman ringkasan Produk.
  3. Klik + Buat. Halaman konfigurasi produk akan ditampilkan.
  4. Konfigurasi produk API. Bagian-bagian halaman konfigurasi produk mencakup hal 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 didukung oleh produk API ini. Anda juga bisa menentukan batas kuota untuk setiap operasi.
    • GraphQL Operations: Grup proxy API, jalur resource, dan operasi GraphQL jenis didukung oleh produk API ini. Jenis operasi GraphQL yang didukung mencakup kueri dan mutasi. Anda dapat menentukan satu jenis atau keduanya, atau keduanya. Sama seperti untuk berbasis REST Dengan proxy API, Anda dapat menentukan batas kuota di setiap operasi.
    • Operasi gRPC: Menentukan proxy gRPC API dan Metode gRPC yang didukung oleh produk API ini. Hanya seperti untuk proxy API berbasis REST, Anda dapat menentukan batas kuota operasi.
    • Atribut khusus: Pasangan kunci/nilai yang membantu Anda mengontrol proxy API dalam proses eksekusi.

    Setiap bagian utama ini dijelaskan dalam bagian di bawah.

  5. Bila telah selesai, klik Simpan. Apigee membuat produk API baru. Anda sekarang dapat menghubungkan produk ke aplikasi Developer. Lihat Mengontrol akses ke API 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 API baru Anda Google. 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 Name dapat disertakan karakter alfanumerik, spasi, dan hal berikut: _ - . # $ %

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

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

Display name dapat berisi karakter khusus.

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

String yang dapat membantu Anda mengingat tujuan atau fungsi produk API. Tujuan deskripsi dapat berisi 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 yang ditetapkan maka semua lingkungan diizinkan oleh Produk API.

Lingkungan yang Anda pilih di kolom ini membatasi akses ke proxy API berdasarkan di mana mereka di-deploy. Misalnya, jika proxy API A di-deploy ke lingkungan test dan prod, tetapi produk API hanya memiliki test tertentu, maka panggilan API untuk aplikasi developer yang sesuai hanya mengizinkan akses ke proxy API A yang di-deploy di lingkungan test. Untuk informasi selengkapnya tentang lingkungan, lihat Tentang lingkungan dan grup lingkungan.
Access Wajib Tingkat akses yang diberikan kepada pengguna produk API ini. Untuk mengetahui detailnya, lihat Akses level aplikasi.
Automatically approve access requests Opsional (default ke dipilih)

Memungkinkan persetujuan otomatis untuk permintaan kunci yang masuk untuk produk API ini dari . Untuk mewajibkan persetujuan kunci manual, nonaktifkan opsi ini.

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

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

  • UI: Pilih Publikasikan > Aplikasi, pilih aplikasi, lalu edit. Lalu, klik Setujui.
  • API: Gunakan Developer app keys API.

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 operasi untuk produk API ini.

Nilai ini digantikan oleh batas kuota yang lebih spesifik yang ditetapkan pada operasi yang pada produk API.

Memasukkan nilai kuota tidak secara otomatis memberlakukan pembatasan jumlah yang dapat dilakukan melalui produk API. Anda juga harus menambahkan kebijakan Kuota ke Proxy API yang dirujuk oleh produk API.

Untuk informasi selengkapnya, lihat Kuota.
Allowed OAuth scope Opsional Jika Anda menggunakan OAuth dengan produk API, masukkan daftar OAuth yang dipisahkan koma cakupan yang Anda inginkan untuk diizinkan oleh produk API (seperti Baca atau cakupan lain yang dikirim aplikasi dengan panggilan API). Untuk informasi selengkapnya, lihat Cakupan OAuth.

Operasi

Menentukan operasi yang diizinkan pada proxy API berbasis HTTP, termasuk jalur resource, metode HTTP, dan kuota. Operasi memungkinkan Anda mengontrol metode REST dan memiliki akses ke metode jalur resource dalam produk API, dan cara banyak panggilan tersebut yang dapat dilakukan (dengan Kuota).

Untuk mengonfigurasi detail operasi, klik + TAMBAHKAN OPERASI di bagian Operasi. Tujuan 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. Sebagai contoh, jika Anda menetapkan sumber operasi ke music API proxy dengan jalur dasar /music, produk API memungkinkan panggilan ke semua subjalur pada /music. Akan tetapi, jika Anda ingin agar produk API mengizinkan akses hanya 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.

Perhatikan bahwa ada aturan khusus untuk karakter pengganti di jalur resource, seperti yang dijelaskan di Mengonfigurasi jalur resource.
Methods Opsional

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

Defaultnya adalah tanpa pilihan, yang mengizinkan permintaan dengan metode HTTP apa pun.

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

Untuk informasi tentang fungsi metode permintaan HTTP, lihat Metode permintaan HTTP.
Quota Opsional Tentukan batas kuota untuk operasi ini. Untuk mengetahui detail terkait cara penghitungan kuota, lihat Memahami penghitung kuota.
Custom attributes Opsional Lihat Atribut khusus.

Operasi GraphQL

Untuk mengonfigurasi detail operasi GraphQL, klik + TAMBAHKAN OPERASI di bagian Operasi Graphql. Tujuan 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

Menentukan 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 mengizinkan permintaan dengan jenis operasi apa pun.

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

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

Atribut khusus

Atribut khusus adalah pasangan kunci/nilai yang dapat digunakan dalam berbagai cara, termasuk membantu mengontrol eksekusi proxy API.

Secara total, sebuah produk API dapat memiliki hingga 18 atribut khusus, termasuk yang ditetapkan di operasional bisnis.

Misalnya, Anda dapat membuat atribut khusus yang disebut deprecated dengan nilai true atau false. Dalam alur proxy API, Anda bisa 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 pada cakupan operasi atau proxy API. Ada tiga bidang di bawah Quota yang harus Anda tentukan, jika Anda menentukan kuota:

  1. Kolom pertama menentukan jumlah maksimum permintaan 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 Kuota lebih lanjut.

  3. Kolom ketiga menentukan jenis periode (atau satuan waktu), seperti seperti hari, minggu, atau bulan.

    Kolom ini sesuai dengan elemen <TimeUnit> dalam Kuota lebih lanjut.

Contoh berikut menetapkan batas 1.000 GET, HEAD, dan TRACE permintaan ke proxy API per hari (semua permintaan HTTP lainnya diabaikan):

Menambahkan kuota baru ke operasi

Contoh berikut menetapkan batas 42 permintaan setiap 3 menit, terlepas dari ke resource /mypath:

Menambahkan kuota baru ke operasi

Ketika Anda menetapkan kuota untuk sebuah operasi, Anda harus memasukkan nilai untuk semua tiga kolom di bagian Quota.

Anda tidak dapat menetapkan kuota yang berbeda untuk beberapa metode HTTP pada operasi. Untuk melakukannya, Anda harus membuat beberapa produk API dan menentukan dan kuota spesifik per metode.

Jika Anda menetapkan nilai ini di Kebijakan kuota dan produk API (di UI seperti yang dijelaskan di sini atau dengan API produk API, setelan UI/API produk API 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 memiliki 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 diprioritaskan daripada jalur resource yang lebih spesifik. Misalnya, jika Anda menambahkan / dan /**, Jalur resource / lebih diprioritaskan dan jalur resource /** diutamakan 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 / di produk API mendukung jalur dasar dan semua subjalur. Misalnya, jika jalur dasar dari proxy API adalah /v1/weatherapikey, lalu produk API mendukung permintaan untuk /v1/weatherapikey dan ke subjalur mana pun, seperti /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, dan seterusnya.

Dengan produk API, Anda dapat mengubah setelan default ini agar jalur resource / sesuai hanya ke jalur dasar proxy API. Artinya, produk API tidak akan mengizinkan akses ke URI yang memiliki apa pun setelah /. Jika Anda membuat perubahan ini, maka di hanya di atas dua baris pertama di bawah "Allowed for /" akan diizinkan.

Untuk informasi tambahan, lihat Memahami konfigurasi Produk API

Mengedit produk API

Untuk mengedit produk API:

  1. Jika Anda menggunakan UI Apigee di Konsol Cloud, pilih Distribution > API Google Cloud Platform. Jika Anda menggunakan UI Apigee klasik, pilih Publikasikan > API Produk.
  2. Pilih Publikasikan > Produk API.
  3. Klik baris produk API yang ingin Anda edit. Apigee menampilkan detail tentang produk API.
  4. Klik EDIT.

  5. Edit setelan produk API, sesuai yang diperlukan.

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

    Anda dapat menghapus resource jika resource tidak berfungsi atau memerlukan lebih pengembangan produk. Saat dihapus, resource tersebut tidak lagi menjadi bagian dari produk API saat ini. Aplikasi apa pun yang menggunakan produk API tidak bisa lagi mengakses sumber daya yang dihapus. Resource yang dihapus dihapus 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 paket tarif atau Tambahkan (UI klasik).

  7. Klik Simpan.

Perubahan akan diterapkan dalam jangka waktu yang 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:

  1. Jika Anda menggunakan UI Apigee di Konsol Cloud, pilih Distribution > API Google Cloud Platform. Jika Anda menggunakan UI Apigee klasik, pilih Publikasikan > API Produk.
  2. Pilih Publikasikan > Produk API.
  3. Buka menu Tindakan di baris produk yang akan dihapus, lalu pilih Hapus.
  4. Setelah Anda mengonfirmasi operasi penghapusan, penghapusan akan berlaku dalam waktu singkat (sekitar lima menit).