Konfigurasikan rencana notifikasi yang dapat disesuaikan

Anda sedang 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 waktu persentase jumlah target tercapai, seperti 90%, 100%, atau 150%. Transaksi tambahan tidak akan diblokir setelah jumlah target tercapai.

Mengonfigurasi rencana notifikasi yang dapat disesuaikan menggunakan UI

Konfigurasikan paket notifikasi yang dapat disesuaikan, seperti yang dijelaskan di bawah.

Mengonfigurasi rencana 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 dalam ratePlanDetails pada isi permintaan:

Properti	Nilai
type	Tetapkan ke USAGE_TARGET.
meteringType	Tetapkan ke DEV_SPECIFIC.
duration	Tetapkan ke periode waktu untuk dasar agregasi, bersama dengan durationType. Untuk paket tarif notifikasi yang dapat disesuaikan, tetapkan nilainya ke bilangan bulat antara 1 dan 24.
durationType	Tetapkan ke periode waktu untuk dasar agregasi, bersama dengan durationType. Untuk paket tarif 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 tarif.

Misalnya, perintah berikut 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 target jumlah transaksi untuk setiap developer aplikasi menggunakan API

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

Menetapkan jumlah target transaksi saat menyetujui paket tarif

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

Misalnya, permintaan berikut menetapkan jumlah target transaksi ke 4000 jika developer aplikasi 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 jumlah target 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 resource /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Tetapkan quotaTarget ke bilangan bulat positif atau 0 untuk menonaktifkan notifikasi bagi developer aplikasi. Jika tidak ditentukan, quotaTarget ditetapkan secara default ke 0.

{developer_rateplan_id} akan ditampilkan sebagai 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 dapat memperoleh {developer-rateplan-id} untuk paket tarif developer dengan mengajukan permintaan GET ke /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, dengan {developer_id} sebagai 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 target transaksi menjadi 4.000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
 "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
 "developer":{
 "iddev@mycompany.com"
 }:
 "iddev@mycompany.com"
 },email:password