Anda melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Pengantar
Dalam rencana bagi hasil, penyedia API berbagi dengan developer persentase pendapatan yang dihasilkan dari setiap transaksi (berdasarkan harga bruto atau neto transaksi). Saat membuat rencana bagi hasil, Anda harus menunjukkan model berbagi, yang dapat berupa tetap atau fleksibel, dan dasar harga (seperti apakah bagi hasil didasarkan pada harga bruto atau neto transaksi). Anda menetapkan harga bruto atau neto untuk transaksi saat Anda membuat kebijakan perekaman transaksi.
Dalam model berbagi tetap, Anda berbagi dengan developer persentase tetap dari pendapatan yang dihasilkan dari setiap transaksi (berdasarkan harga bruto atau neto transaksi). Dalam model berbagi fleksibel, Anda berbagi dengan developer persentase pendapatan yang bervariasi. Bagi hasil bergantung pada pendapatan yang dihasilkan selama jangka waktu tertentu. Persentase yang digunakan dalam penghitungan bagi hasil dapat bervariasi berdasarkan jumlah pendapatan yang dihasilkan oleh transaksi.
Menentukan detail rencana bagi hasil menggunakan UI
Konfigurasi rencana bagi hasil, seperti yang dijelaskan di bawah.
Edge
Untuk mengonfigurasi rencana bagi hasil menggunakan UI Edge, saat membuat atau mengedit paket tarif, pilih jenis paket tarif Revenue Share atau Rate Card and Revenue Share dan di bagian Revenue share, konfigurasi informasi berikut:
| Kolom | Deskripsi |
| Model penghitungan | Pilih salah satu jenis harga berikut:
|
| Frekuensi penghitungan | Jangka waktu penghitungan volume transaksi (atau volume terkait atribut kustom). Pilih jumlah bulan (1-24 bulan). |
| Model berbagi | Pilih salah satu model bagi hasil berikut:
|
| Bagi hasil tetap | Untuk model berbagi tetap, tentukan persentase yang digunakan untuk menghitung bagi hasil. Masukkan angka desimal (dengan maksimal empat angka di belakang koma). Misalnya, jika Anda memasukkan 80,5555, bagi hasilnya adalah 80,5555%, yaitu, sebagai penyedia API, Anda membayar developer 80,5555% dari harga yang dikenakan untuk setiap transaksi. |
| Rentang bagi hasil | Untuk model berbagi fleksibel, satu atau beberapa rentang pendapatan transaksi (setiap rentang adalah "rentang pendapatan"). Setiap rentang pendapatan dapat diberi persentase bagi hasil. Transaksi diagregasi berdasarkan dasar agregasi untuk menghitung total pendapatan dan rentang pendapatan untuk transaksi. Persentase bagi hasil yang diterapkan ke setiap transaksi bergantung pada rentang pendapatannya. Tentukan batas atas rentang pertama, misalnya, hingga 1000 (batas bawah ditetapkan ke lebih besar dari 0). Klik +New untuk menambahkan rentang tambahan. Biarkan batas atas rentang akhir kosong untuk menunjukkan semua transaksi setelah pendapatan gabungan melebihi tingkat ini. Misalnya, jika Anda menentukan dua rentang pendapatan di bagian Rentang Pendapatan (>0-1000, dan 1000 ke atas), Anda dapat memasukkan 80,5555 untuk rentang pendapatan >0-1000, dan 90,5 untuk rentang pendapatan 1000 ke atas. Asumsikan juga mata uangnya dalam dolar AS. Kemudian, untuk transaksi yang menghasilkan pendapatan hingga $1000, bagi hasilnya adalah 80,5555% dari harga transaksi, dan untuk transaksi yang menghasilkan pendapatan lebih dari $1000, bagi hasilnya adalah 90,5% dari harga transaksi. |
Classic Edge (Private Cloud)
Untuk mengonfigurasi rencana bagi hasil menggunakan UI Classic Edge:
- Ikuti langkah-langkah untuk membuat paket tarif.
- Pilih Revenue Share di drop-down Rate Plan Type untuk mengonfigurasi model pendapatan.
- Jika paket API yang dipilih menyertakan beberapa produk API, pilih salah satu opsi berikut:
Catatan: Jika paket API hanya menyertakan satu produk API, Anda dapat melewati langkah ini.
- Product-Specific Plans untuk mengonfigurasi detail paket tarif untuk setiap produk API secara terpisah.
- Generic Plan for All Products untuk mengonfigurasi detail paket tarif untuk semua produk API.
- Klik Revenue Share untuk paket tarif umum atau untuk setiap paket tarif khusus produk API.
Catatan: Saat mengonfigurasi paket khusus produk API, Anda harus mengonfigurasi rencana bagi hasil untuk setiap produk API secara terpisah.

Jendela Revenue Share akan terbuka.

- Pilih salah satu model berbagi berikut:
- Tetap: Dalam model ini, penyedia API berbagi dengan developer persentase tetap dari pendapatan yang dihasilkan dari setiap transaksi (berdasarkan harga bruto atau neto transaksi).
- Fleksibel: Dalam model ini, penyedia API berbagi dengan developer persentase pendapatan yang bervariasi. Bagi hasil bergantung pada pendapatan yang dihasilkan selama jangka waktu tertentu. Persentase yang digunakan dalam penghitungan bagi hasil dapat bervariasi berdasarkan jumlah pendapatan yang dihasilkan oleh transaksi.
Untuk model berbagi tetap:
Jika Anda memilih model berbagi tetap, masukkan informasi berikut di bagian Harga pada jendela Generic Revenue Share:
Kolom Deskripsi Operator (atau Organisasi) Nama organisasi Anda. Kolom ini telah ditetapkan menggunakan nilai kolom Operator (atau Organisasi) di profil organisasi.
Negara Negara tempat organisasi Anda beroperasi. Kolom ini telah ditetapkan menggunakan nilai kolom Negara di profil organisasi.
Mata Uang Mata uang "dasar" atau akuntansi yang digunakan perusahaan Anda. Kolom ini telah ditetapkan menggunakan nilai kolom Mata Uang di profil organisasi.
Jenis Harga Dasar bagi hasil. Pilih Bruto atau Neto. Jika Anda memilih Bruto, bagi hasil didasarkan pada persentase harga bruto transaksi. Jika Anda memilih Neto, bagi hasil didasarkan pada persentase harga neto transaksi. Catatan: Anda menetapkan harga bruto atau neto untuk transaksi saat membuat kebijakan perekaman transaksi.
Bagi Hasil Tetap % Persentase yang digunakan untuk menghitung bagi hasil. Masukkan angka desimal (dengan maksimal empat angka di belakang koma). Misalnya, jika Anda memasukkan 80,5555, bagi hasilnya adalah 80,5555%, yaitu, sebagai penyedia API, Anda membayar developer 80,5555% dari harga yang dikenakan untuk setiap transaksi.
Untuk model berbagi fleksibel:
Jika Anda memilih model berbagi fleksibel, Anda akan melihat bahwa jendela Generic Revenue Share menampilkan kolom tambahan. Anda menggunakan kolom ini untuk menentukan dasar agregasi dan untuk menentukan "rentang pendapatan", yaitu rentang pendapatan yang dihasilkan transaksi yang dapat Anda terapkan persentase bagi hasil yang berbeda.

Masukkan informasi berikut di jendela Generic Revenue Share:
Kolom Deskripsi Dasar Agregasi Jangka waktu penggabungan pendapatan. Pendapatan gabungan digunakan untuk menghitung rentang pendapatan untuk setiap transaksi (dan persentase bagi hasil yang berlaku). Pilih jumlah bulan (antara 1 dan 12).
Rentang Pendapatan Satu atau beberapa rentang pendapatan transaksi (setiap rentang adalah "rentang pendapatan"). Setiap rentang pendapatan dapat diberi persentase bagi hasil (Anda menetapkan persentase ini di kolom Rentang Pendapatan pada bagian Harga). Transaksi diagregasi berdasarkan dasar agregasi untuk menghitung total pendapatan dan rentang pendapatan untuk transaksi. Persentase bagi hasil yang diterapkan ke setiap transaksi bergantung pada rentang pendapatannya.
Tentukan batas atas rentang pertama, misalnya, hingga 1000 (batas bawah limit ditetapkan ke lebih besar dari 0). Klik + untuk menambahkan rentang kedua, misalnya, lebih besar dari 1000 dan hingga 2000. Klik + untuk menambahkan lebih banyak rentang. Anda dapat membiarkan batas atas rentang akhir kosong untuk menunjukkan semua transaksi setelah pendapatan gabungan melebihi tingkat ini.

Harga Operator (atau Organisasi) Nama organisasi Anda. Kolom ini telah ditetapkan menggunakan nilai kolom Operator (atau Organisasi) di profil organisasi.
Negara Negara tempat organisasi Anda beroperasi. Kolom ini telah ditetapkan menggunakan nilai kolom Negara di profil organisasi.
Mata Uang Mata uang "dasar" atau akuntansi yang digunakan organisasi Anda. Kolom ini telah ditetapkan menggunakan nilai kolom Mata Uang di profil organisasi.
Jenis Harga Dasar bagi hasil. Pilih Bruto atau Neto. Jika Anda memilih Bruto, bagi hasil didasarkan pada persentase harga bruto transaksi. Jika Anda memilih Neto, bagi hasil didasarkan pada persentase harga neto transaksi. Catatan: Anda menetapkan harga bruto atau neto untuk transaksi saat membuat kebijakan perekaman transaksi.
Bagi Hasil % untuk Rentang Pendapatan Persentase yang digunakan untuk menghitung bagi hasil untuk transaksi di setiap rentang pendapatan. Anda menentukan persentase untuk setiap rentang. Masukkan angka desimal (dengan maksimal empat angka di belakang koma). Misalnya, jika Anda menentukan dua rentang pendapatan di bagian Rentang Pendapatan (>0-1000, dan 1000 ke atas), Anda dapat memasukkan 80,5555 untuk rentang pendapatan >0-1000, dan 90,5 untuk rentang pendapatan 1000 ke atas. Asumsikan juga mata uangnya dalam dolar AS. Kemudian, untuk transaksi yang menghasilkan pendapatan hingga $1000 , bagi hasilnya adalah 80,5555% dari harga transaksi, dan untuk transaksi yang menghasilkan pendapatan lebih dari $1000, bagi hasilnya adalah 90,5% dari harga transaksi.

- Klik Apply and Close untuk menyimpan detail bagi hasil dan kembali ke jendela Standard Rate Plan.
- Untuk paket tarif khusus produk API, konfigurasi detail paket tarif untuk produk API tambahan, sesuai kebutuhan.
Menentukan detail rencana bagi hasil menggunakan API
Anda menentukan detail rencana bagi hasil saat membuat paket tarif. Anda menentukan detail
di properti ratePlanDetails dalam isi permintaan dalam panggilan ke
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Apa yang Anda
tentukan di properti ratePlanDetails, bergantung pada model berbagi yang Anda pilih:
tetap atau fleksibel.
Menentukan detail rencana bagi hasil untuk model berbagi tetap
Untuk menerapkan model berbagi tetap, Anda menentukan hal berikut dalam detail paket tarif:
- Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi
(
VOLUME).VOLUMEadalah nilai default. - Jenis pengukuran (
UNIT) yang menunjukkan bahwa bagi hasil ditetapkan per unit (yaitu, tidak didasarkan pada volume transaksi, seperti dalam model berbagi fleksibel sharing model). - Jenis pendapatan (
GROSSatauNET). Hal ini menunjukkan apakah bagi hasil didasarkan pada harga bruto atau neto transaksi. - Periode jatuh tempo pembayaran (misalnya, 30 hari).
- ID organisasi Anda.
- Mata uang "dasar" atau akuntansi yang digunakan perusahaan Anda.
- Tarif paket tarif yang memberikan detail tentang cara penghitungan bagi hasil. Karena model berbagi didasarkan pada tarif tetap, Anda hanya menentukan satu tarif paket tarif.
Lihat Properti konfigurasi untuk detail paket tarif guna mengetahui daftar lengkap properti detail paket tarif.
Dalam tarif paket tarif, Anda menentukan:
- Jenis tarif paket tarif (
REVSHARE). - Persentase yang digunakan untuk menghitung bagi hasil. Misalnya, jika Anda menentukan 80,5555, bagi hasilnya adalah 80,5555%, yaitu, sebagai penyedia API, Anda membayar developer 80,5555% dari harga yang dikenakan untuk setiap transaksi (atau jika didasarkan pada atribut kustom seperti jumlah byte yang ditransmisikan dalam transaksi, Anda membayar developer 80,5555% dari harga yang dikenakan untuk mentransmisikan jumlah byte yang ditentukan).
- Unit awal aplikasi tarif (
0). Artinya, tarif diterapkan ke setiap transaksi, dimulai dengan transaksi pertama.
Lihat Properti konfigurasi untuk paket tarif guna mengetahui daftar lengkap properti paket tarif.
Misalnya, berikut ini membuat rencana bagi hasil dengan model berbagi tetap. Persentase bagi hasilnya adalah 80,5555%. Bagi hasil didasarkan pada harga neto a transaksi. Kontrak berlaku pada 15 September 2013, dan pembayaran jatuh tempo dalam 30 hari. (Detail terkait bagi hasil ditandai.)
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Fixed share plan",
"developer":null,
"developerCategory":null,
"advance": false,
"currency": {
"id": "usd"
},
"description": "Fixed share plan",
"displayName": "Fixed share plan",
"earlyTerminationFee": 10,
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": false,
"published": true,
"ratePlanDetails": [
{
"aggregateStandardCounters": true,
"currency": {
"id": "usd"
},
"duration": 1,
"durationType": "MONTH",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates": [
{
"revshare": 80.8555,
"startUnit": 0,
"type": "REVSHARE"
}
],
"ratingParameter": "VOLUME",
"revenueType": "NET",
"type": "REVSHARE"
}
],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"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" \
-u email:password
Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):
{ "advance" : false, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "description" : "Fixed share plan", "displayName" : "Fixed share plan", "earlyTerminationFee" : 10, "id" : "location_fixed_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Fixed share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : true, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b", "meteringType" : "UNIT", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "id" : "01c4d544-d907-423b-964e-4e2aed2816a3", "revshare" : 80.8555, "startUnit" : 0, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }
Menentukan detail rencana bagi hasil untuk model berbagi fleksibel
Dalam model berbagi fleksibel, Anda menentukan detail paket tarif yang menyertakan satu atau beberapa tarif paket tarif. Setiap tarif paket tarif mencakup rentang pendapatan transaksi (setiap rentang disebut "rentang pendapatan"). Anda menetapkan persentase bagi hasil untuk setiap rentang pendapatan.
Selain tarif paket tarif, Anda menentukan hal berikut dalam detail paket tarif:
- Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi
(
VOLUME).VOLUMEadalah nilai default. - Jenis pengukuran (
VOLUME) yang menunjukkan bahwa bagi hasil tidak didasarkan pada volume transaksi (yaitu, tidak tetap, seperti dalam model berbagi tetap). - Jenis pendapatan (
GROSSatauNET). Hal ini menunjukkan apakah bagi hasil didasarkan pada harga bruto atau neto transaksi. - Periode jatuh tempo pembayaran (misalnya, 30 hari).
- ID organisasi Anda.
- Mata uang "dasar" atau akuntansi yang digunakan perusahaan Anda.
- Durasi dan jenis durasi yang bersama-sama menentukan jangka waktu penggabungan pendapatan (ini juga disebut "dasar agregasi"). Transaksi diagregasi berdasarkan dasar agregasi (misalnya, 1 bulan) untuk menghitung total pendapatan dan rentang pendapatan yang berlaku. Persentase bagi hasil yang diterapkan ke setiap transaksi bergantung pada rentang pendapatan nya.
- Penghitung agregasi yang digunakan untuk menentukan rentang pendapatan yang berlaku.
Lihat Properti konfigurasi untuk detail paket tarif guna mengetahui daftar lengkap properti detail paket tarif.
Untuk setiap tarif paket tarif, Anda menentukan:
- Jenis tarif paket tarif untuk rentang pendapatan (
REVSHARE). - Persentase yang digunakan untuk menghitung bagi hasil untuk rentang pendapatan. Misalnya, jika Anda menentukan 80,5555, bagi hasil untuk rentang pendapatan adalah 80,5555%, yaitu, sebagai penyedia API Anda membayar developer 80,5555% dari harga yang dikenakan untuk setiap transaksi dalam rentang pendapatan tersebut.
- Unit awal dan akhir rentang pendapatan. Unit awal menentukan batas bawah
rentang pendapatan, dan unit akhir menentukan batas atas rentang pendapatan. Misalnya, jika Anda menentukan unit awal 0 dan unit akhir 1000, rentang pendapatan
mencakup pendapatan transaksi yang lebih besar dari 0 dan hingga 1000 dalam mata uang yang ditentukan. Jika mata uangnya adalah dolar AS, dasar agregasinya adalah 1 bulan, dan persentase untuk rentang pendapatan adalah 80,5555%, maka untuk transaksi yang menghasilkan pendapatan hingga $1000 dalam sebulan, bagi hasilnya adalah 80,5555% dari harga transaksi.
Jika Anda tidak menentukan unit akhir untuk rentang pendapatan akhir, persentase bagi hasil untuk rentang tersebut akan diterapkan ke semua transaksi setelah pendapatan gabungan melebihi unit awal untuk rentang tersebut. Misalnya, jika unit awal untuk rentang terakhir adalah 1000 (asumsikan dolar AS), dan Anda tidak menentukan unit akhir untuk rentang tersebut, persentase pendapatan untuk rentang tersebut akan diterapkan ke semua transaksi yang menghasilkan pendapatan di atas $1000 selama periode gabungan.
Lihat Properti konfigurasi untuk paket tarif guna mengetahui daftar lengkap properti paket tarif.
Misalnya, berikut ini membuat rencana bagi hasil dengan model berbagi fleksibel. Model ini menentukan dua rentang pendapatan. Rentang pertama mencakup pendapatan transaksi yang lebih besar dari hingga 1000 dolar AS. Rentang kedua mencakup pendapatan transaksi di atas 1000 dolar AS. Persentase bagi hasil nya adalah 80,5555% untuk rentang pendapatan pertama, dan 90,5% untuk rentang pendapatan kedua. Bagi hasil didasarkan pada harga neto transaksi. Dasar agregasinya adalah 1 bulan. Periode kontrak berlaku pada 15 September 2013, dan pembayaran jatuh tempo dalam 30 hari. (Detail terkait bagi hasil ditandai.)
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flexible share plan",
"developer":null,
"developerCategory":null,
"advance": "true",
"currency": {
"id": "usd"
},
"description": "Flexible share plan",
"displayName": "Flexible share plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id": "usd"
},
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates" : [ {
"endUnit" : 1000,
"revshare" : 80.5555,
"startUnit" : 0,
"type" : "REVSHARE"
}, {
"revshare" : 90.5,
"startUnit" : 1000,
"type" : "REVSHARE"
} ],
"ratingParameter" : "VOLUME",
"revenueType" : "NET",
"type" : "REVSHARE"
} ],
"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" \
-u email:password
Responsnya akan terlihat seperti ini (hanya sebagian respons yang ditampilkan):
{ "advance" : true, "currency" : { "id" : "usd", "name" : "USD", "organization" : { ... }, ... }, "description" : "Flexible share plan", "displayName" : "Flexible share plan", "earlyTerminationFee" : 10, "frequencyDuration" : 30, "frequencyDurationType" : "DAY", "id" : "location_flexible_share_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED" } ], "status" : "CREATED" }, "name" : "Flexible share plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : false, "ratePlanDetails" : [ { "aggregateFreemiumCounters" : true, "aggregateStandardCounters" : true, "currency" : { "id" : "usd", "name" : "USD", … "organization" : { ... }, ... }, "duration" : 1, "durationType" : "MONTH", "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c", "meteringType" : "VOLUME", "organization" : { ... }, "paymentDueDays" : "30", "ratePlanRates" : [ { "endUnit" : 1000, "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40", "revshare" : 80.5555, "startUnit" : 0, "type" : "REVSHARE" }, { "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed", "revshare" : 90.5, "startUnit" : 1000, "type" : "REVSHARE" } ], "ratingParameter" : "VOLUME", "revenueType" : "NET", "type" : "REVSHARE" } ], "recurringFee" : 10, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-09-15 00:00:00", "type" : "STANDARD" }