Halaman ini diterjemahkan oleh Cloud Translation API.

Konfigurasikan rencana notifikasi yang dapat disesuaikan

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

Pengantar

Dalam paket notifikasi yang bisa disesuaikan, penyedia API bisa menyesuaikan jumlah target transaksi untuk setiap pengembang aplikasi. Anda dapat mengonfigurasi apakah dan kapan notifikasi dikirim berdasarkan saat persentase jumlah target tercapai, misalnya 90%, 100%, atau 150%. Tambahan transaksi tidak diblokir setelah jumlah target tercapai.

Mengonfigurasi paket notifikasi yang dapat disesuaikan menggunakan UI

Konfigurasi paket notifikasi yang dapat disesuaikan, seperti yang dijelaskan di bawah ini.

Edge

Untuk mengonfigurasi rencana notifikasi yang dapat disesuaikan menggunakan UI Edge, saat menambahkan atau mengedit tarif pilih jenis paket tarif Notifikasi yang Dapat Disesuaikan dan konfigurasi informasi berikut di bagian Notifikasi yang Dapat Disesuaikan:

Kolom	Deskripsi	Default
Frekuensi penghitungan	Periode waktu penghitungan volume transaksi (atau volume terkait atribut khusus). Pilih jumlah bulan (1-24 bulan).	1 bulan

Jika Anda menentukan atribut khusus untuk produk API, Anda dapat mengonfigurasi parameter rating kustom untuk menentukan penghitung transaksi berdasarkan atribut khusus.

Misalnya, Anda mungkin perlu:

Membebankan biaya kepada developer dengan jumlah yang berbeda-beda berdasarkan nilai yang diberikan dalam pesan panggilan API.
Misalnya, Anda mungkin ingin mengenakan biaya kepada developer aplikasi berdasarkan jumlah byte yang ditransmisikan dalam permintaan API.
Gabungkan beberapa panggilan API ke dalam satu transaksi.
Dalam hal ini, pilih Gunakan parameter rating kustom dan pilih atribut kustom dari menu drop-down.

Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi paket tarif dengan atribut khusus.

Edge Klasik (Private Cloud)

Untuk mengonfigurasi rencana notifikasi yang dapat disesuaikan menggunakan UI Classic Edge:

Pilih Adjustable Notification di Rate Plan Type di tab Plan Details di jendela Rate Plan.
Lihat Membuat paket tarif menggunakan UI untuk mengetahui informasi tentang cara mengakses jendela Paket Tarif.

Catatan: Tab Biaya dan Freemium akan berwarna abu-abu setelah Anda pilih jenis Notifikasi yang Dapat Disesuaikan, karena tidak berlaku untuk notifikasi paket notifikasi.
Tetapkan kolom Masa Berlaku Perpanjangan ke jumlah bulan saat paket tersebut diperpanjang secara otomatis (kecuali jika developer menghentikan perjanjian sebelum tanggal tersebut). Jika Anda menetapkan nilai ini ke 0, paket tetap berlaku sampai pengembang memilih untuk mengakhirinya.
Klik Detail di bagian Paket Tarif Umum.
Tetapkan Dasar Agregasi ke periode waktu saat volume transaksi akan digabungkan. Pilih angka antara 1 dan 24 bulan. Nilai ini ditetapkan secara default ke 1 bulan.
Klik Terapkan dan Tutup.
Klik Simpan Draf.
Publikasikan rencana hanya ketika Anda benar-benar yakin itu sudah final. Lihat Publikasi paket tarif untuk informasi tentang menetapkan Tanggal Publikasi dan menerbitkan rencana.

Setelah memublikasikan paket tarif, Anda hanya dapat mengubah tanggal akhir. Anda tidak dapat menghapus tarif paket tarif tersebut setelah dipublikasikan, tetapi Anda dapat mengakhiri paket tarif dan menggantinya dengan tarif mendatang paket, seperti yang dijelaskan dalam Menghentikan tarif yang dipublikasikan rencana Anda.

Mengonfigurasi paket notifikasi yang dapat disesuaikan menggunakan API

Tentukan detail paket notifikasi yang dapat disesuaikan di properti ratePlanDetails dalam isi permintaan dalam permintaan POST untuk /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Untuk menentukan paket notifikasi yang dapat disesuaikan, tentukan nilai berikut dalam kolom ratePlanDetails dari isi permintaan:

Properti	Nilai
`type`	Tetapkan ke `USAGE_TARGET`.
`meteringType`	Tetapkan ke `DEV_SPECIFIC`.
`duration`	Tetapkan jangka waktu untuk dasar agregasi, bersama dengan `durationType`. Untuk paket tarif notifikasi yang dapat disesuaikan, tetapkan parameter ini ke bilangan bulat nilai antara 1 dan 24.
`durationType`	Tetapkan jangka waktu untuk dasar agregasi, bersama dengan `durationType`. Untuk paket tarif notifikasi yang dapat disesuaikan, tetapkan nilai ini ke `MONTH`.

Untuk informasi selengkapnya tentang properti konfigurasi yang dapat ditetapkan saat menentukan detail paket notifikasi yang dapat disesuaikan, lihat Detail paket tarif setelan konfigurasi.

Misalnya, berikut ini menentukan rencana notifikasi yang dapat disesuaikan dengan dasar agregasi ditetapkan ke 1 bulan.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Menetapkan target jumlah transaksi untuk setiap developer aplikasi yang menggunakan API

Untuk setiap developer aplikasi yang telah menerima paket tarif notifikasi yang dapat disesuaikan, Anda harus menetapkan target jumlah transaksi. Anda dapat mengonfigurasi waktu dan waktu pengiriman notifikasi berdasarkan saat persentase jumlah target tercapai, seperti 90%, 100%, atau 150%. Transaksi tambahan tidak diblokir setelah jumlah target tercapai.

Anda dapat menetapkan jumlah target transaksi untuk developer aplikasi saat developer menyetujuinya paket tarif, dan Anda dapat memperbarui nilainya nanti.

Menetapkan target jumlah transaksi saat menyetujui paket tarif

Saat menyetujui paket tarif, untuk menetapkan jumlah transaksi target, tentukan Properti quotaTarget dalam isi permintaan dalam permintaan POST ke Resource /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Tetapkan quotaTarget ke bilangan bulat positif atau 0 untuk menonaktifkan notifikasi aplikasi developer. Jika tidak ditentukan, quotaTarget secara default ditetapkan ke 0.

Misalnya, permintaan berikut menetapkan jumlah target transaksi ke 4.000 saat aplikasi developer menyetujui paket notifikasi yang dapat disesuaikan.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Menetapkan target jumlah transaksi saat memperbarui paket tarif yang diterima

Untuk menetapkan jumlah target transaksi, Anda dapat memperbarui paket tarif yang diterima dan menentukan properti quotaTarget dalam isi permintaan dalam permintaan PUT ke /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} resource Anda Tetapkan quotaTarget ke bilangan bulat positif atau 0 untuk menonaktifkan notifikasi untuk developer aplikasi. Jika tidak ditentukan, quotaTarget secara default ditetapkan ke 0.

{developer_rateplan_id} akan ditampilkan dalam respons saat Anda menyetujui paket tarif yang dipublikasikan.

Contoh:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Atau, Anda bisa mendapatkan {developer-rateplan-id} untuk tarif developer rencana Anda dengan mengajukan permintaan GET ke /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, dengan {developer_id} adalah alamat email developer. Untuk informasi selengkapnya, lihat Melihat semua paket tarif yang diterima oleh developer.

Contoh:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}

Permintaan berikut memperbarui jumlah transaksi target menjadi 4.000.

$ curl -H "Content-Type:application/json" -X PUT -d \
{ 
   &quot;id&quot; : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   &quot;developer&quot;:{
     "id":"dev@perusahaansaya.com"
   },
   &quot;ratePlan&quot;:{
     &quot;id&quot;:&quot;p1_adjustable-notification-plan&quot;
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressPeringatan":false
}' \
&quot;https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1&quot;
-u email:password