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

Konfigurasikan rencana 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 tarif, pilih jenis paket tarif Notifikasi yang Dapat Disesuaikan dan di bagian Notifikasi yang Dapat Disesuaikan, konfigurasikan 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 menetapkan atribut khusus untuk produk API, Anda dapat mengonfigurasi parameter rating kustom untuk menentukan penghitung transaksi berdasarkan atribut khusus.

Misalnya, Anda mungkin perlu:

Menagih developer jumlah variabel berdasarkan nilai yang diberikan dalam pesan panggilan API.
Misalnya, Anda dapat menagih developer aplikasi berdasarkan jumlah byte yang dikirim dalam permintaan API.
Memaketkan beberapa panggilan API ke dalam satu transaksi.
Dalam hal ini, pilih Gunakan parameter rating kustom dan pilih atribut kustom dari menu drop-down.

Untuk informasi selengkapnya, lihat Mengonfigurasi paket tarif dengan atribut kustom.

Edge Klasik (Private Cloud)

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

Pilih Notifikasi yang Dapat Disesuaikan di kolom Rate Plan Type pada 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 memilih jenis Notifikasi yang Dapat Disesuaikan, karena tidak berlaku untuk paket notifikasi yang dapat disesuaikan.
Tetapkan kolom Jangka Waktu Perpanjangan ke jumlah bulan saat paket diperpanjang secara otomatis (kecuali jika developer menghentikan perjanjian sebelum tanggal tersebut). Jika Anda menetapkan nilai ini ke 0, rencana akan tetap berlaku hingga developer memilih untuk mengakhirinya.
Klik Detail di bagian Paket Tarif Umum.
Tetapkan Aggregation Basis ke jangka waktu penggabungan volume transaksi. Pilih angka antara 1 dan 24 bulan. Nilai ini secara default adalah 1 bulan.
Klik Terapkan dan Tutup.
Klik Simpan Draf.
Publikasikan rencana hanya jika Anda benar-benar yakin bahwa rencana tersebut sudah final. Lihat Paket tarif publikasi untuk mengetahui informasi tentang cara menetapkan Tanggal Publikasi dan memublikasikan rencana.

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

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 di ratePlanDetails isi permintaan:

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

Misalnya, berikut adalah contoh penentuan paket notifikasi yang dapat disesuaikan dengan dasar 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 yang menggunakan API

Untuk setiap developer aplikasi yang telah menyetujui paket tarif 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 target jumlah transaksi untuk developer aplikasi saat developer menerima paket tarif, dan Anda dapat memperbarui nilainya nanti.

Menetapkan target jumlah transaksi saat menyetujui paket tarif

Saat menyetujui paket tarif, untuk menetapkan target jumlah 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 ditetapkan secara default ke 0.

Misalnya, permintaan berikut menetapkan target jumlah transaksi menjadi 4.000 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 target jumlah transaksi saat memperbarui paket tarif yang diterima

Untuk menetapkan target jumlah 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 secara default ditetapkan ke 0.

{developer_rateplan_id} ditampilkan dalam respons saat Anda menerima 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 paket tarif developer 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 \
'{ 
   "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