Konfigurasikan rencana notifikasi yang dapat disesuaikan

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

Pengantar

Dalam paket notifikasi yang dapat disesuaikan, penyedia API dapat menyesuaikan jumlah target transaksi untuk setiap developer aplikasi. Anda dapat mengonfigurasi apakah dan kapan notifikasi dikirim berdasarkan kapan persentase jumlah target tercapai, seperti 90%, 100%, atau 150%. Transaksi tambahan 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.

Edge

Untuk mengonfigurasi paket notifikasi yang dapat disesuaikan menggunakan UI Edge, saat menambahkan atau mengedit paket harga, pilih jenis paket harga Adjustable Notification dan di bagian Adjustable Notification , konfigurasi informasi berikut:

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

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

Misalnya, Anda mungkin perlu:

  • Menagih developer jumlah variabel berdasarkan nilai yang diberikan dalam pesan panggilan API.
    Misalnya, Anda mungkin ingin menagih developer aplikasi berdasarkan jumlah byte yang ditransmisikan dalam permintaan API.
  • Menggabungkan beberapa panggilan API ke dalam satu transaksi.
    Dalam hal ini, pilih Gunakan parameter rating kustom dan pilih atribut kustom dari daftar drop-down.

Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi paket harga dengan atribut kustom.

Classic Edge (Private Cloud)

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

  1. Pilih Adjustable Notification di kolom Rate Plan Type di tab Plan Details di jendela Rate Plan.

    Lihat Membuat paket harga menggunakan UI untuk mengetahui informasi tentang cara mengakses jendela Paket Harga.

  2. Tetapkan kolom Renewal Term ke jumlah bulan saat paket diperpanjang secara otomatis (kecuali jika developer mengakhiri perjanjian sebelum tanggal tersebut). Jika Anda menetapkan nilai ini ke 0, paket akan tetap berlaku hingga developer memilih untuk mengakhirinya.
  3. Klik Details di bagian Generic Rate Plan.
  4. Tetapkan Aggregation Basis ke jangka waktu penggabungan volume transaksi. Pilih angka antara 1 dan 24 bulan. Nilai ini ditetapkan secara default ke 1 bulan.
  5. Klik Apply and Close.
  6. Klik Save Draft.
  7. Publikasikan paket hanya jika Anda benar-benar yakin bahwa paket tersebut sudah final. Lihat Memublikasikan paket harga untuk informasi tentang cara menetapkan Tanggal Publikasi dan memublikasikan paket.

    Setelah memublikasikan paket harga, Anda hanya dapat mengubah tanggal berakhir. Anda tidak dapat menghapus paket harga setelah dipublikasikan, tetapi Anda dapat mengakhiri masa berlaku paket harga dan menggantinya dengan paket harga mendatang, seperti yang dijelaskan dalam Mengakhiri masa berlaku paket harga yang dipublikasikan.

Mengonfigurasi paket notifikasi yang dapat disesuaikan menggunakan API

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

Untuk menentukan paket notifikasi yang dapat disesuaikan, tentukan nilai berikut di ratePlanDetails isi permintaan:

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

Tetapkan ke jangka waktu untuk basis agregasi, bersama dengan durationType. Untuk paket harga notifikasi yang dapat disesuaikan, tetapkan nilai ini ke MONTH.

Untuk mengetahui informasi selengkapnya tentang properti konfigurasi yang dapat ditetapkan saat menentukan detail paket notifikasi yang dapat disesuaikan, lihat Setelan konfigurasi detail paket harga.

Misalnya, berikut ini menentukan paket notifikasi yang dapat disesuaikan dengan basis agregasi yang 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 jumlah target transaksi untuk setiap developer aplikasi menggunakan API

Untuk setiap developer aplikasi yang telah menerima paket harga notifikasi yang dapat disesuaikan, Anda perlu menetapkan jumlah target transaksi. Anda dapat mengonfigurasi apakah dan kapan notifikasi dikirim berdasarkan kapan 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 menerima paket harga, dan Anda dapat memperbarui nilai tersebut nanti.

Menetapkan jumlah target transaksi saat menerima paket harga

Saat menerima paket harga, untuk menetapkan jumlah target transaksi, 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 bagi developer aplikasi. Jika tidak ditentukan, quotaTarget akan ditetapkan secara default ke 0.

Misalnya, permintaan berikut menetapkan jumlah target transaksi ke 4000 saat developer aplikasi menerima 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 jumlah target transaksi saat memperbarui paket harga yang diterima

Untuk menetapkan jumlah target transaksi, Anda dapat memperbarui paket harga 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. Tetapkan quotaTarget ke bilangan bulat positif atau 0 untuk menonaktifkan notifikasi bagi developer aplikasi. Jika tidak ditentukan, quotaTarget akan ditetapkan secara default ke 0.

{developer_rateplan_id} ditampilkan dalam respons saat Anda menerima paket harga 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 dapat memperoleh {developer-rateplan-id} untuk paket harga developer dengan mengirimkan permintaan GET ke /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, dengan {developer_id} adalah alamat email developer. Untuk mengetahui informasi selengkapnya, lihat Melihat semua paket harga 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 target transaksi menjadi 4000.

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