Mengelola paket tarif

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

Kelola paket tarif menggunakan UI dan API, seperti yang dijelaskan di bagian berikut.

Menjelajahi halaman paket tarif

Akses halaman paket tarif, seperti yang dijelaskan di bawah.

Edge

Untuk melihat paket tarif di UI Edge, akses halaman Paket Tarif:

  1. Login ke apigee.com/edge.
  2. Pilih Publish > Monetization > Rate Plans di menu navigasi kiri.

Halaman Paket Tarif akan ditampilkan.

Seperti yang ditunjukkan dalam gambar, halaman Paket Tarif memungkinkan Anda:

Classic Edge (Private Cloud)

Untuk melihat paket tarif menggunakan UI Edge Klasik, akses halaman Paket API:

  1. Login ke http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
  2. Pilih Publish > Packages di menu navigasi atas.

Halaman Paket API menampilkan paket tarif yang ditentukan untuk setiap paket.

Halaman Paket Tarif memungkinkan Anda:

Membuat paket tarif

Untuk membuat paket tarif:

  1. Akses halaman Paket Tarif.
  2. Klik +Paket Tarif.
  3. Konfigurasi kolom berikut di panel atas:
    Kolom Deskripsi Default Wajib
    Nama paket tarif Nama paket tarif Anda.

    NOTE: Nama harus unik dalam paket produk API. Dua paket dalam paket produk yang sama tidak boleh memiliki nama yang sama.

    T/A Ya
    Jenis paket tarif Jenis paket tarif. Pilih nilai dari menu drop-down. Untuk mengetahui daftar jenis paket tarif yang valid, lihat Jenis paket tarif yang didukung. T/A Ya
    Paket produk Paket produk API. Pilih nilai dari menu drop-down. Untuk mengetahui informasi selengkapnya tentang paket produk API, lihat Mengelola paket produk API.

    Jika Anda memilih paket produk yang berisi lebih dari satu produk API, Anda harus memilih apakah akan mengonfigurasi paket tarif individual untuk setiap produk API atau paket tarif umum yang akan berlaku untuk semua produk API.

    T/A Ya
    Audiens Audiens yang dapat mengakses paket tarif. Pilih salah satu nilai berikut dari menu drop-down:
    • Semua orang - Semua developer.
    • Developer - Developer atau perusahaan. Masukkan nama developer atau perusahaan. Saat Anda mengetik, daftar developer/perusahaan yang berisi string akan ditampilkan di drop-down. Klik nama developer atau perusahaan dari daftar drop-down.
    • Kategori developer - Kategori developer. Pilih kategori developer dari menu drop-down.

      Konfigurasi kategori developer sesuai kebutuhan, seperti yang dijelaskan dalam Mengelola kategori developer.

    Semua orang Tidak
    Tanggal mulai Tanggal mulai berlakunya paket tarif. Masukkan tanggal mulai atau pilih tanggal menggunakan kalender. Hari ini Tidak
    Tanggal akhir Tanggal berakhirnya paket tarif. Untuk menentukan tanggal akhir, aktifkan tombol Memiliki Tanggal Akhir,lalu masukkan tanggal akhir atau pilih tanggal menggunakan kalender.

    CATATAN: Paket tarif akan berlaku hingga akhir hari pada tanggal yang ditentukan. Misalnya, jika Anda ingin mengakhiri paket tarif pada 1 Desember 2018, Anda harus menetapkan nilai endDate ke 2018-11-30. Dalam hal ini, paket tarif akan berakhir pada akhir hari 30 November 2018; semua permintaan pada 1 Desember 2018 akan diblokir.

    Tidak ada Tidak
    Dapat dilihat oleh portal Tetapkan apakah paket tarif bersifat Publik atau Pribadi. Lihat Paket tarif publik vs. tarif khusus. Aktif Tidak
  4. Konfigurasi biaya untuk paket tarif. Lihat Mengonfigurasi biaya untuk paket tarif.
    NOTE: Tidak berlaku untuk paket notifikasi yang dapat disesuaikan.
  5. Jika Anda memilih paket produk yang berisi lebih dari satu produk API, tetapkan preferensi berikut di bagian Paket tarif spesifik atau umum:
    CATATAN: Langkah ini tidak berlaku untuk paket notifikasi yang dapat disesuaikan.
    Kolom Deskripsi Default
    Konfigurasi setiap produk satu per satu Flag yang menentukan apakah akan mengonfigurasi paket tarif individual untuk setiap produk API. Nonaktif
    Konfigurasi penawaran freemium setiap produk secara terpisah Flag yang menentukan apakah akan mengonfigurasi paket freemium untuk setiap produk API. Nonaktif
    Pilih produk Jika Anda mengaktifkan salah satu atau kedua tanda tersebut, Anda harus memilih setiap produk satu per satu dari daftar drop-down dan mengonfigurasi detail paket tarifnya.

    NOTE: Pastikan Anda mengonfigurasi semua produk dalam paket produk.

    T/A
  6. Konfigurasi detail paket tarif, berdasarkan jenis paket tarif yang dipilih:
  7. Klik salah satu opsi berikut:
    Tombol Deskripsi
    Simpan sebagai Draf Simpan paket tarif sebagai draf.

    Paket tarif tidak akan terlihat oleh developer aplikasi hingga Anda memublikasikannya. Anda dapat mengedit kolom apa pun dalam draf paket tarif.

    Publikasikan Rencana Baru Publikasikan rencana.

    NOTE: Setelah memublikasikan paket tarif, Anda hanya dapat mengubah tanggal akhir jika belum ditetapkan. Anda tidak dapat menghapus paket tarif setelah dipublikasikan, tetapi Anda dapat mengakhiri masa berlaku paket tarif dan menggantinya dengan paket tarif mendatang, seperti yang dijelaskan dalam Mengakhiri masa berlaku paket tarif yang dipublikasikan.

  8. Lampirkan kebijakan Pemeriksaan Batas Monetisasi ke proxy API yang terkait dengan produk API yang disertakan dalam paket tarif. Kebijakan Pemeriksaan Batas Monetisasi menerapkan batas monetisasi pada proxy API dan memastikan bahwa setiap kesalahan dicatat secara akurat dalam laporan analisis dan monetisasi. Untuk mengetahui informasi selengkapnya, lihat Menerapkan batas monetisasi pada proxy API.

Mengedit paket tarif

Anda dapat mengedit semua kolom dalam draf paket tarif, kecuali untuk Paket Produk, jenis, dan audiens. Setelah memublikasikan paket tarif, Anda hanya dapat mengedit tanggal akhir dan hanya jika tidak ada tanggal akhir yang ditentukan.

Untuk mengedit paket tarif:

  1. Akses halaman Paket Tarif.
  2. Klik dalam baris paket tarif yang ingin Anda edit.
    Panel paket tarif ditampilkan.
  3. Edit kolom paket tarif sesuai kebutuhan.
    NOTE: Setelah memublikasikan paket tarif, Anda hanya dapat mengubah tanggal akhir jika belum ditetapkan.
  4. Klik salah satu opsi berikut:
    Tombol Deskripsi
    Perbarui Draf (paket tarif draf) Simpan paket tarif sebagai draf.

    Paket tarif tidak akan terlihat oleh developer aplikasi hingga Anda memublikasikannya. Anda dapat mengedit kolom apa pun dalam draf paket tarif.
    Publikasikan Draf (paket tarif draf) Publikasikan paket tarif.

    NOTE: Setelah memublikasikan paket tarif, Anda hanya dapat mengubah tanggal akhir jika belum ditetapkan. Anda tidak dapat menghapus paket tarif setelah dipublikasikan, tetapi Anda dapat mengakhiri masa berlaku paket tarif dan menggantinya dengan paket tarif mendatang, seperti yang dijelaskan dalam Mengakhiri masa berlaku paket tarif yang dipublikasikan.
    Tanggal Berakhir yang Diperbarui (paket tarif yang dipublikasikan) Tetapkan tanggal akhir untuk rencana yang dipublikasikan.

    NOTE: Setelah tanggal akhir ditetapkan untuk paket tarif yang dipublikasikan, tanggal tersebut tidak dapat diubah lagi.

Menghapus draf paket tarif

Hapus paket tarif draf jika tidak diperlukan lagi.

CATATAN: Anda tidak dapat menghapus paket tarif yang dipublikasikan.

Untuk menghapus paket tarif draf:

  1. Akses halaman Paket Tarif.
  2. Posisikan kursor Anda di atas paket tarif yang ingin Anda hapus untuk menampilkan menu tindakan.
  3. Klik .
  4. Klik Hapus untuk mengonfirmasi tindakan.

Mengelola paket tarif menggunakan API

Bagian berikut menjelaskan cara mengelola paket tarif menggunakan API.

Membuat paket tarif menggunakan API

Untuk membuat paket tarif, kirim permintaan POST ke /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, dengan {monetizationpackage_id} adalah ID paket produk API yang akan Anda buatkan paket tarifnya (ID ditampilkan dalam respons saat Anda membuat paket produk API).

Saat membuat paket tarif, Anda harus menentukan hal berikut dalam isi permintaan:

  • ID Organisasi
  • ID paket produk API
  • Nama paket tarif
  • Deskripsi paket tarif
  • Cakupan paket tarif (apakah berlaku untuk semua developer, atau hanya untuk developer, perusahaan, atau kategori developer tertentu)
  • Tanggal mulai berlaku paket tarif
  • Mata uang untuk paket tarif
  • Apakah akan memublikasikan paket tarif
  • Apakah paket tarif bersifat publik atau pribadi

Ada setelan lain yang dapat Anda tentukan secara opsional, seperti periode saat pembayaran jatuh tempo (misalnya, 30 hari). Lihat Properti konfigurasi untuk paket tarif.

Jika membuat paket tarif (selain paket khusus biaya) untuk paket produk API yang memiliki lebih dari satu produk, Anda dapat menerapkan paket tersebut ke produk tertentu dalam paket produk. Anda melakukannya dengan mengidentifikasi produk dalam permintaan. Jika Anda tidak mengidentifikasi produk, paket akan diterapkan ke semua produk dalam paket produk API.

Bagian berikut menjelaskan cara membuat paket tarif:

Membuat paket tarif standar menggunakan API

Untuk membuat paket tarif standar, tetapkan atribut type ke STANDARD, seperti yang ditunjukkan dalam contoh berikut.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Membuat paket tarif developer atau perusahaan menggunakan API

Untuk menerapkan paket tarif ke developer atau perusahaan tertentu, tetapkan nilai type ke Developer. Anda juga perlu mengidentifikasi developer atau perusahaan dalam permintaan, mengidentifikasi ID, nama resmi, dan nama developer atau perusahaan.

Misalnya, kutipan berikut membuat paket tarif untuk developer Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Membuat paket tarif kategori developer menggunakan API

Untuk menerapkan paket tarif ke kategori developer, tetapkan nilai type ke Developer_Category. Anda juga perlu mengidentifikasi kategori developer dalam permintaan. Contoh:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

Membuat paket tarif khusus produk API menggunakan API

Saat membuat paket tarif untuk paket produk API yang mencakup beberapa produk API, Anda dapat menentukan detail paket tarif untuk setiap produk API.

Misalnya, kode berikut membuat rencana pembagian keuntungan dengan dua produk API:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

Untuk menambahkan produk API ke paket produk API my-package, Anda harus menambahkan detail paket tarif untuk produk API di isi permintaan, seperti yang dijelaskan dalam Menambahkan produk API ke paket produk API dengan paket tarif khusus produk API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

Menetapkan paket tarif sebagai publik atau pribadi menggunakan API

Saat membuat paket tarif, Anda dapat menentukan apakah paket tersebut bersifat publik atau pribadi menggunakan atribut isPrivate dalam isi permintaan. Jika disetel ke true, paket tarif akan bersifat pribadi. Untuk mengetahui informasi selengkapnya, lihat Paket tarif publik vs. paket tarif khusus.

Misalnya, kode berikut membuat paket tarif khusus:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Memublikasikan paket tarif menggunakan API

Untuk memublikasikan paket tarif, tetapkan nilai properti published ke benar (true) saat Anda membuat paket tarif. Developer akan dapat melihat paket tarif mulai tanggal yang ditentukan di properti startDate untuk paket tersebut.

Misalnya, kode berikut membuat paket kartu tarif dan memublikasikannya (hanya sebagian permintaan yang ditampilkan):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Menyimpan draf paket tarif menggunakan API

Untuk menyimpan paket tarif tanpa memublikasikannya, tetapkan nilai properti published ke false saat Anda membuat paket tarif.

Misalnya, kode berikut membuat paket kartu tarif dan menyimpannya sebagai draf (hanya bagian dari permintaan yang ditampilkan):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Mengedit draf paket tarif menggunakan API

Untuk memperbarui draf paket tarif, kirim permintaan PUT ke /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}, dengan{package_id} adalah identifikasi paket API, dan {plan_Id} adalah identifikasi paket tarif. Saat melakukan pembaruan, Anda perlu menentukan setelan yang diperbarui dan ID paket tarif dalam isi permintaan. Jika Anda memperbarui tarif paket tarif, Anda juga perlu menentukan ID tarif paket tarif. Misalnya, permintaan berikut memperbarui tarif paket tarif dalam paket tarif yang ID-nya adalah location_flat_rate_card_plan (pembaruan ditandai):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Respons mencakup tarif paket tarif yang diperbarui (hanya sebagian respons yang ditampilkan):

"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],

Melihat paket tarif menggunakan API

Anda dapat melihat paket tarif menggunakan Monetization API seperti yang dijelaskan di bagian berikut.

Melihat semua paket tarif untuk organisasi menggunakan API

Untuk melihat semua paket tarif untuk organisasi, kirim permintaan GET ke /mint/organizations/{org_name}/rate-plans, dengan {org_name} adalah nama organisasi Anda.

Anda dapat meneruskan parameter kueri berikut untuk memfilter hasil:

Parameter Kueri Deskripsi
all Flag yang menentukan apakah akan menampilkan semua paket tarif. Jika disetel ke false, jumlah paket tarif yang ditampilkan per halaman ditentukan oleh parameter kueri size. Default-nya adalah true.
size Jumlah paket API yang ditampilkan per halaman. Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.
page Nomor halaman yang ingin Anda tampilkan (jika konten dipaginasi). Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.

Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

Melihat semua paket tarif untuk paket produk API menggunakan API

Untuk melihat semua paket tarif untuk paket API, kirim permintaan GET ke /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, dengan {package_id} adalah ID paket API (ID paket ditampilkan saat Anda membuat paket monetisasi).

Secara default, hanya paket tarif aktif, publik, dan standar yang ditampilkan dalam hasil. Untuk menyertakan:

  • Paket tarif draf atau yang sudah berakhir, tetapkan parameter kueri current ke false (misalnya, ?current=false).
  • Paket tarif pribadi, tetapkan parameter kueri showPrivate ke true (misalnya, ?showPrivate=true).
  • Semua paket tarif standar, tetapkan parameter kueri standard ke true (misalnya, ?standard=true).

Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

Melihat paket tarif untuk paket API menggunakan API

Untuk melihat paket tarif untuk paket API, kirim permintaan GET ke /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, dengan {package_id} adalah ID paket API, dan {plan_id} adalah ID paket tarif (ID paket ditampilkan saat Anda membuat paket monetisasi, dan ID paket tarif ditampilkan saat Anda membuat paket tarif).

Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

Berikut adalah contoh respons:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

Melihat semua paket tarif aktif untuk developer menggunakan API

Untuk melihat semua paket tarif aktif untuk developer, kirim permintaan GET ke /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, dengan {developer_id} adalah alamat email developer.

Anda dapat meneruskan parameter kueri berikut untuk memfilter hasil:

Parameter Kueri Deskripsi
all Flag yang menentukan apakah akan menampilkan semua paket API. Jika disetel ke false, jumlah paket API yang ditampilkan per halaman ditentukan oleh parameter kueri size. Default-nya adalah false.
size Jumlah paket API yang ditampilkan per halaman. Defaultnya adalah 20. Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.
page Nomor halaman yang ingin Anda tampilkan (jika konten dipaginasi). Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.

Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

Berikut adalah contoh respons:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

Melihat paket tarif yang diterima untuk developer menggunakan API

Untuk melihat paket tarif aktif bagi developer, kirim permintaan GET ke /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}, dengan {developer_id} adalah alamat email developer, dan {developer_rateplan_id} adalah ID paket tarif yang diterima yang ditampilkan dalam respons saat Anda menerima paket tarif yang dipublikasikan.

Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

Berikut adalah contoh respons:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

Melihat paket tarif yang diterima untuk developer yang berisi produk API menggunakan API

Untuk melihat paket tarif yang diterima untuk developer yang berisi produk API, kirim permintaan GET ke /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, dengan {developer_id} adalah ID developer dan /{product_id} adalah ID produk.

Secara default, hanya paket tarif publik yang ditampilkan dalam hasil. Untuk menampilkan paket tarif khusus, tetapkan parameter kueri showPrivate ke true (misalnya, ?showPrivate=true).

Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

Melihat semua paket tarif yang diterima oleh developer menggunakan API

Untuk melihat paket tarif yang telah disetujui oleh developer, kirim permintaan GET ke /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, dengan {developer_id} adalah ID developer.

Anda dapat meneruskan parameter kueri berikut untuk memfilter hasil:

Parameter Kueri Deskripsi
all Flag yang menentukan apakah akan menampilkan semua paket API. Jika disetel ke false, jumlah paket API yang ditampilkan per halaman ditentukan oleh parameter kueri size. Default-nya adalah false.
size Jumlah paket API yang ditampilkan per halaman. Defaultnya adalah 20. Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.
page Nomor halaman yang ingin Anda tampilkan (jika konten dipaginasi). Jika parameter kueri all ditetapkan ke true, parameter ini akan diabaikan.

Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

Berikut adalah contoh respons:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

Menghapus draf paket tarif menggunakan API

Untuk menghapus draf paket tarif, kirimkan permintaan DELETE ke /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, dengan {plan_Id} adalah identifikasi paket tarif yang akan dihapus, dan {package_id} adalah identifikasi paket API untuk paket tarif. Contoh:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Properti konfigurasi untuk paket tarif

Saat membuat paket tarif menggunakan API, Anda dapat menentukan setelan konfigurasi berikut.

Nama Deskripsi Default Wajib?
advance

Hanya berlaku untuk biaya berulang. Tanda yang menentukan apakah biaya berulang ditagih di muka atau tidak. Nilai yang valid mencakup:

  • true - Biaya berulang ditagih di muka. Misalnya, jika periode adalah 1 bulan, biaya berulang ditagihkan pada invoice yang dibuat saat bulan penagihan sebelumnya berakhir.
  • false - Biaya berulang ditagih di akhir periode. Misalnya, jika periode adalah 1 bulan, biaya berulang ditagih pada invoice saat akhir bulan penagihan saat ini. Ini adalah defaultnya.
false Tidak
contractDuration

Durasi kontrak untuk paket bersama dengan contractDurationType. Misalnya, untuk menentukan durasi kontrak 6 bulan, tetapkan contractDuration ke 6 dan contractDurationType ke MONTH.

T/A Tidak
contractDurationType

Durasi kontrak untuk paket bersama contractDuration. Nilai yang valid mencakup:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
T/A Tidak
currency

Mata uang yang digunakan untuk paket tarif. Tentukan kode ISO 4217 untuk mata uang, seperti usd untuk dolar Amerika Serikat atau chf untuk franc Swiss.

T/A Ya
description

Deskripsi paket tarif.

T/A Ya
developer

ID developer (alamat email). Tentukan hanya untuk paket tarif developer.

T/A Tidak
developerCategory

ID kategori developer. Hanya tentukan untuk paket tarif kategori developer.

T/A Tidak
displayName

Nama tampilan yang mudah digunakan untuk paket tarif.

T/A Ya
earlyTerminationFee

Biaya satu kali yang ditagih jika developer mengakhiri paket sebelum jangka waktu perpanjangan.

T/A Tidak
endDate

Tanggal berakhirnya paket. Developer tidak dapat melihat paket tarif setelah tanggal ini. Jika Anda tidak ingin paket tarif berakhir pada tanggal tertentu, tentukan nilai null untuk endDate.

Paket tarif akan berlaku hingga akhir hari pada tanggal yang ditentukan. Misalnya, jika Anda ingin mengakhiri paket tarif pada 1 Desember 2016, Anda harus menetapkan nilai endDate ke 2016-11-30. Dalam kasus ini, paket tarif akan berakhir pada akhir hari 30 November 2016; semua permintaan pada 1 Desember 2016 akan diblokir.

NOTE: Saat melihat paket tarif menggunakan API, stempel waktu endDate ditentukan sebagai YYYY-MM-DD 00:00:00, yang mungkin menyesatkan.

T/A Tidak
freemiumDuration

Jangka waktu untuk periode freemium bersama dengan freemiumDurationType. Misalnya, untuk menentukan bahwa periode freemium adalah 30 hari, tetapkan freemiumDuration ke 30 dan freemiumDurationType ke DAY.

T/A Tidak
freemiumDurationType

Jangka waktu untuk periode freemium bersama dengan freemiumDuration. Nilai yang valid mencakup:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
T/A Tidak
freemiumUnit

Jumlah freemium. Nilai dapat berupa jumlah transaksi atau jumlah unit yang terkait dengan atribut kustom yang dicatat dalam kebijakan pencatatan transaksi.

T/A Tidak
frequencyDuration

Hanya berlaku untuk biaya berulang. Periode waktu antara penagihan biaya berulang bersama dengan frequencyDurationType. Misalnya, untuk menentukan bahwa jangka waktu antara pengenaan biaya adalah 30 hari, tetapkan frequencyDuration ke 30 dan frequencyDurationType ke DAY.

T/A Tidak
frequencyDurationType Hanya berlaku untuk biaya berulang. Periode waktu antara penagihan biaya berulang bersama dengan frequencyDuration. Nilai yang valid mencakup:
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
T/A Tidak
isPrivate Flag yang menentukan apakah paket tarif bersifat publik atau pribadi. Nilai defaultnya adalah false (publik). Untuk mengetahui informasi selengkapnya, lihat Paket tarif publik versus tarif khusus. T/A Tidak
monetizationPackage

ID paket produk API untuk paket tarif.

T/A Tidak
name

Nama paket tarif.

T/A Ya
organization

ID organisasi untuk paket tarif.

T/A Ya
paymentDueDays

Hanya berlaku untuk biaya berulang. Jumlah hari hingga biaya jatuh tempo. Misalnya, tetapkan nilai ke 30 untuk menunjukkan bahwa biaya harus dibayar dalam 30 hari.

T/A Tidak
proRate

Hanya berlaku untuk biaya berulang. Flag yang menentukan apakah biaya berulang dihitung secara prorata atau tidak saat developer memulai atau mengakhiri paket di tengah bulan. Nilai yang valid mencakup:

  • true - Biaya awal dihitung secara proporsional berdasarkan jumlah hari hingga akhir periode (atau jumlah hari yang digunakan dalam periode tersebut).
  • false - Developer dikenai biaya awal penuh terlepas dari kapan developer memulai (atau mengakhiri) paket. Ini adalah defaultnya.
false Tidak
published

Flag yang menentukan apakah paket tarif harus dipublikasikan agar dapat dilihat oleh developer atau tidak. Nilai yang valid mencakup:

  • true - Publikasikan paket tarif.
  • false - Jangan memublikasikan paket tarif.
T/A Ya
ratePlanDetails

Detail paket tarif (lihat Properti konfigurasi untuk detail paket tarif).

T/A Ya
recurringFee

Biaya yang ditagihkan kepada developer secara berkelanjutan hingga developer mengakhiri paket.

T/A Tidak
recurringStartUnit

Hanya valid jika recurringType ditetapkan ke CALENDAR. Hari dalam bulan untuk menagih biaya berulang. Misalnya, jika biaya berulang ditagih setiap bulan dan recurringStartUnit disetel ke 1, biaya berulang ditagih pada hari pertama setiap bulan.

T/A Tidak
recurringType

Jadwalkan biaya berulang. Nilai yang valid mencakup:

  • CALENDAR - Dijadwalkan berdasarkan kalender.
  • CUSTOM - Dijadwalkan berdasarkan setelan tanggal kustom.
T/A Tidak
setUpFee

Biaya satu kali yang ditagih kepada setiap developer pada tanggal mulai paket (yaitu, tanggal saat developer membeli paket).

T/A Tidak
startDate

Tanggal dimulainya paket. Developer dapat melihat paket tarif mulai tanggal ini.

T/A Ya
type

Jenis paket tarif. Tentukan salah satu dari berikut ini:

  • STANDARD. Berlaku untuk semua developer.
  • DEVELOPER_CATEGORY. Berlaku untuk semua developer dalam kategori yang dipilih.
  • DEVELOPER. Berlaku untuk developer atau perusahaan tertentu.
T/A Ya

Properti konfigurasi untuk detail paket tarif

Anda dapat menentukan salah satu properti konfigurasi berikut sebagai bagian dari array ratePlanDetails saat membuat paket tarif.

Nama Deskripsi Default Wajib?
aggregateFreemiumCounters

Flag yang menentukan apakah penghitung gabungan diaktifkan atau tidak untuk menentukan apakah penggunaan produk API berada dalam rentang gratis. Penghitung gabungan harus diaktifkan untuk menyiapkan paket freemium untuk produk. Nilai yang valid mencakup:

  • true - Aktifkan penghitung gabungan.
  • false - Jangan aktifkan penghitung gabungan.
T/A Tidak
aggregateStandardCounters

Flag yang menentukan apakah penghitung gabungan digunakan untuk menentukan rentang penggunaan (seperti rentang volume untuk paket kartu tarif). Nilainya dapat berupa salah satu dari berikut:

  • true - Menggunakan penghitung gabungan.
  • false - Jangan gunakan penghitung gabungan.
T/A Tidak
aggregateTransactions

NOTE: Saat ini, properti ini tidak digunakan untuk monetisasi dan dapat diabaikan.

true Tidak
currency

Mata uang.

T/A Tidak
duration

Periode waktu untuk frekuensi penghitungan, bersama dengan durationType, dengan nilai duration yang diizinkan adalah 1-24.

Misalnya, tetapkan duration ke 2 dan durationType ke MONTH untuk menentukan frekuensi penghitungan 2 bulan.

T/A Tidak
durationType

Jangka waktu untuk frekuensi penghitungan, bersama dengan duration. Satu-satunya nilai yang valid adalah MONTH.

Lihat duration untuk contoh penggunaan.

T/A Tidak
freemiumDuration

Jangka waktu untuk periode freemium untuk setiap produk API bersama dengan freemiumDurationType. Misalnya, untuk menentukan bahwa periode freemium untuk produk API adalah 30 hari, tetapkan freemiumDuration ke 30 dan freemiumDurationType ke DAY.

T/A Tidak
freemiumDurationType

Jangka waktu untuk periode freemium untuk setiap produk API bersama dengan freemiumDuration. Nilai yang valid mencakup:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

Misalnya, untuk menentukan bahwa periode freemium untuk produk API adalah 30 hari, tetapkan freemiumDuration ke 30 dan freemiumDurationType ke DAY.

T/A Tidak
freemiumUnit

Jumlah freemium untuk produk API. Nilai dapat berupa jumlah transaksi atau jumlah unit yang terkait dengan atribut kustom yang dicatat dalam kebijakan pencatatan transaksi.

T/A Tidak
meteringType

Model penagihan untuk paket kartu tarif. Nilai yang valid mencakup:

  • UNIT - Model pengisian daya tarif tetap.
  • VOLUME - Model pengisian daya dengan rentang volume.
  • STAIR_STEP - Model pengisian daya yang disertakan.
  • DEV_SPECIFIC - Model pengisian daya notifikasi yang dapat disesuaikan. Tidak berlaku untuk model pendapatan lainnya.
T/A ya
organization

ID Organisasi

T/A Tidak
paymentDueDays

Batas waktu pembayaran untuk developer pascabayar. Misalnya, tetapkan nilai ke 30 untuk menunjukkan bahwa pembayaran jatuh tempo dalam 30 hari.

T/A Tidak
product

Informasi produk API, seperti ID.

T/A Tidak
ratePlanRates

Detail tarif paket tarif, seperti jenis paket tarif (REVSHARE atau RATECARD), tarif untuk paket kartu tarif, pembagian keuntungan untuk paket pembagian keuntungan, dan rentang (unit awal dan unit akhir yang berlaku untuk tarif paket tarif).

T/A Ya
ratingParameter

Dasar untuk paket tarif. Paket tarif didasarkan pada transaksi atau atribut kustom. Nilai yang valid mencakup:

  • VOLUME - Paket tarif didasarkan pada volume transaksi.
  • custom_attribute - Nama atribut kustom yang ditentukan dalam kebijakan perekaman transaksi untuk produk API dan hanya berlaku untuk paket kartu tarif. Nama atribut kustom tidak dapat ditentukan sebagai VOLUME.
VOLUME Ya
ratingParameterUnit

Unit yang berlaku untuk ratingParameter. Only required if ratingParameter ditetapkan ke atribut kustom (yaitu, tidak ditetapkan ke VOLUME).

T/A Ya
revenueType

Dasar bagi hasil dalam rencana bagi hasil. Nilai yang valid mencakup:

  • GROSS - Pembagian keuntungan didasarkan pada persentase harga kotor transaksi.
  • NET - Pembagian keuntungan didasarkan pada persentase harga bersih transaksi.
T/A Tidak
type

Jenis paket tarif. Nilai yang valid mencakup:

  • REVSHARE - Model pembagian keuntungan.
  • RATECARD - Model kartu tarif.
  • REVSHARE_RATECARD - Model pembagian keuntungan dan kartu tarif.
  • USAGE_TARGET - Model notifikasi yang dapat disesuaikan.

Untuk mengetahui informasi selengkapnya tentang jenis paket tarif, lihat Jenis paket tarif yang didukung.

T/A Ya