Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Pengantar
Dalam paket pembagian keuntungan, penyedia API berbagi persentase dari pendapatan yang dihasilkan dari setiap transaksi (berdasarkan harga kotor atau bersih transaksi). Kapan Anda membuat rencana pembagian keuntungan, Anda perlu menunjukkan model pembagian keuntungan, yang dapat diperbaiki atau fleksibel, dan harga (seperti apakah pembagian keuntungan didasarkan pada harga transaksi). Anda menetapkan harga kotor atau bersih untuk transaksi saat membuat kebijakan pencatatan transaksi.
Pada model berbagi tetap, Anda berbagi persentase tetap dari pendapatan dengan developer yang dihasilkan dari setiap transaksi (berdasarkan harga kotor atau bersih transaksi). Di kolom model berbagi fleksibel, Anda berbagi persentase variabel pendapatan dengan developer. Tujuan pembagian keuntungan bergantung pada pendapatan yang dihasilkan selama jangka waktu tertentu. Persentase yang digunakan dalam penghitungan pembagian keuntungan dapat bervariasi berdasarkan jumlah pendapatan yang dihasilkan oleh transaksi.
Menentukan detail paket pembagian keuntungan menggunakan UI
Konfigurasi paket pembagian keuntungan, seperti yang dijelaskan di bawah.
Edge
Untuk mengonfigurasi paket pembagian keuntungan menggunakan UI Edge, saat membuat atau mengedit paket tarif, pilih jenis paket tarif Pembagian Keuntungan atau Kartu Tarif dan Pembagian Keuntungan, dan di bagian Pembagian keuntungan, konfigurasikan informasi berikut:
| Kolom | Deskripsi |
| Model kalkulasi | Pilih salah satu jenis penetapan harga berikut:
|
| Frekuensi penghitungan | Periode waktu penghitungan volume transaksi (atau volume terkait atribut khusus). Pilih jumlah bulan (1-24 bulan). |
| Model berbagi | Pilih salah satu model pembagian keuntungan berikut:
|
| Pembagian keuntungan tetap | Untuk model berbagi tetap, menentukan persentase yang digunakan untuk menghitung pembagian keuntungan. Masukkan angka desimal (dengan maksimal empat angka di belakang koma). Misalnya, jika Anda memasukkan 80.5555, pembagian keuntungannya adalah 80,5555%, sehingga sebagai penyedia API, Anda membayar developer sebesar 80,5555% dari harga yang dikenakan untuk setiap transaksi. |
| Band yang memenuhi syarat pembagian keuntungan | Untuk model berbagi yang fleksibel, satu atau beberapa rentang pendapatan transaksi (setiap rentang disebut "band pendapatan"). Setiap kelompok pendapatan dapat diberi persentase pembagian keuntungan. Transaksi diagregasi berdasarkan gabungan untuk menghitung total pendapatan dan rentang pendapatan untuk transaksi. Persentase pembagian keuntungan yang diterapkan untuk setiap transaksi bergantung pada band pendapatannya. Tentukan batas atas band pertama, misalnya, hingga 1.000 (batas bawah preset ke nilai yang lebih besar dari 0). Klik +Baru untuk menambahkan tali lain. Biarkan batas atas rentang terakhir kosong untuk menunjukkan semua transaksi setelah pendapatan gabungan berada di atas level ini. Misalnya, jika Anda menentukan dua band pendapatan di bagian Band Pendapatan (>0-1.000, dan 1.000 ke atas), Anda dapat memasukkan 80.5555 untuk rentang pendapatan >0-1000, dan 90,5 untuk band pendapatan 1000 dan di atasnya. Juga asumsikan mata uang tersebut dalam dolar AS. Kemudian untuk transaksi yang menghasilkan pendapatan hingga $1.000, pembagian keuntungannya adalah 80,5555% dari harga transaksi, dan untuk transaksi yang menghasilkan pendapatan lebih dari $1.000, pembagian keuntungannya adalah 90,5% dari harga transaksi. |
Edge Klasik (Private Cloud)
Untuk mengonfigurasi rencana pembagian keuntungan menggunakan UI Classic Edge:
- Ikuti langkah-langkah untuk membuat paket tarif.
- Pilih Pembagian Keuntungan di drop-down Jenis Paket Tarif untuk mengonfigurasi model pendapatan.
- Jika paket API yang dipilih mencakup beberapa produk API, pilih salah satu opsi berikut:
Catatan: Jika paket API menyertakan satu produk API, Anda dapat melewati langkah ini.
- Paket Spesifik Per Produk guna mengonfigurasi detail paket tarif untuk setiap produk API satu per satu.
- Paket Umum untuk Semua Produk guna mengonfigurasi detail paket tarif untuk semua produk API.
- Klik Pembagian Keuntungan untuk paket tarif umum atau untuk setiap paket tarif khusus produk API.
Catatan: Saat mengonfigurasi paket khusus produk API, Anda harus mengonfigurasi paket pembagian keuntungan untuk setiap produk API satu per satu.
Jendela Pembagian Keuntungan akan terbuka.
- Pilih salah satu model berbagi berikut:
- Tetap: Dalam model ini, penyedia API berbagi persentase tetap dari pendapatan yang dihasilkan dari setiap transaksi (berdasarkan harga kotor atau bersih transaksi).
- Fleksibel: Dalam model ini, penyedia API berbagi variabel dengan developer persentase pendapatan. Pembagian keuntungan bergantung pada pendapatan yang dihasilkan selama periode tertentu waktu tertentu. Persentase yang digunakan dalam penghitungan pembagian keuntungan dapat bervariasi berdasarkan jumlahnya pendapatan yang dihasilkan oleh transaksi.
Untuk model berbagi tetap:
Jika Anda memilih model berbagi tetap, masukkan informasi berikut di bagian Harga di jendela Bagi Hasil Umum:
Kolom Deskripsi Operator (atau Organisasi) Nama organisasi Anda. Kolom ini telah ditetapkan sebelumnya menggunakan Operator (atau ) di profil organisasi.
Negara Negara operasional organisasi Anda. Bidang ini telah ditetapkan sebelumnya menggunakan Nilai kolom negara di profil organisasi.
Mata Uang "Dasar" atau mata uang akuntansi yang digunakan perusahaan Anda. Kolom ini sudah disetel sebelumnya menggunakan nilai kolom Mata uang di profil organisasi.
Jenis Harga Dasar pembagian keuntungan. Pilih Kotor atau Bersih. Jika Anda memilih Kotor, pembagian keuntungan didasarkan pada persentase dari harga kotor transaksi. Jika Anda pilih Net, pembagian keuntungan didasarkan pada persentase dari harga bersih transaksi. Catatan: Anda menetapkan harga kotor atau bersih untuk transaksi saat membuat kebijakan pencatatan transaksi.
% Pembagian Tetap Persentase yang digunakan untuk menghitung pembagian keuntungan. Masukkan angka desimal (dengan maksimal empat angka desimal). Misalnya, jika Anda memasukkan 80.5555, pembagian keuntungannya adalah 80,5555%, yaitu, sebagai penyedia API, Anda membayar pengembang sebesar 80,5555% dari harga dikenai biaya untuk setiap transaksi.
Untuk model berbagi yang fleksibel:
Jika memilih model pembagian fleksibel, Anda akan melihat bahwa jendela Bagi Hasil Umum menampilkan kolom tambahan. Anda menggunakan kolom ini untuk menentukan dasar agregasi dan menentukan "{i>revenue band<i}", yaitu rentang pendapatan yang dihasilkan dari transaksi yang menerapkan persentase pembagian keuntungan yang berbeda.
Masukkan informasi berikut di jendela Bagi Hasil Umum:
Kolom Deskripsi Dasar Agregasi Periode waktu saat pendapatan digabungkan. Pendapatan gabungan adalah digunakan untuk menghitung band pendapatan untuk setiap transaksi (dan pendapatan yang berlaku persentase pembagian). Pilih jumlah bulan (antara 1 dan 12).
Kelompok Pendapatan Satu atau beberapa rentang pendapatan transaksi (setiap rentang disebut "pita pendapatan"). Masing-masing band pendapatan dapat diberikan persentase pembagian keuntungan (Anda menetapkan persentase ini dalam kolom Revenue Bands di bagian Pricing.) Transaksi akan digabungkan selama dasar agregasi untuk menghitung total pendapatan dan rentang pendapatan untuk transaksi. Persentase pembagian keuntungan yang diterapkan ke setiap transaksi bergantung pada {i>band<i} pendapatan.
Tentukan batas atas pita pertama, misalnya, hingga 1.000 (semakin rendah ditetapkan ke lebih besar dari 0). Klik + untuk menambahkan tali kedua, misalnya, lebih dari 1000 dan hingga 2000. Klik + untuk menambahkan tali lainnya. Anda bisa membiarkan bagian atas batas band akhir kosong untuk menunjukkan semua transaksi setelah agregat tingkat pendapatan telah melampaui batas ini.
Harga Operator (atau Organisasi) Nama organisasi Anda. Kolom ini telah ditetapkan sebelumnya menggunakan Operator (atau ) di profil organisasi.
Negara Negara operasional organisasi Anda. Bidang ini telah ditetapkan sebelumnya menggunakan Nilai kolom negara di profil organisasi.
Mata Uang "Dasar" atau mata uang akuntansi yang digunakan organisasi Anda. Bidang ini adalah preset menggunakan nilai kolom Mata uang di profil organisasi.
Jenis Harga Dasar pembagian keuntungan. Pilih Kotor atau Bersih. Jika Anda memilih Kotor, pembagian keuntungan didasarkan pada persentase dari harga kotor transaksi. Jika Anda pilih Net, pembagian keuntungan didasarkan pada persentase dari harga bersih transaksi. Catatan: Anda menetapkan harga kotor atau bersih untuk transaksi saat membuat kebijakan pencatatan transaksi.
% Pembagian untuk Band Pendapatan Persentase yang digunakan untuk menghitung bagi hasil transaksi dalam setiap {i>band<i} pendapatan. Anda menentukan persentase untuk setiap band. Masukkan angka desimal (dengan ke empat angka desimal). Misalnya, jika Anda menentukan dua rentang pendapatan di kolom Pendapatan bagian band (>0-1000, dan 1000 dan lebih tinggi), Anda dapat memasukkan 80.5555 untuk Pita pendapatan >0-1.000, dan 90,5 untuk rentang pendapatan 1.000 ke atas. Juga asumsikan mata uangnya dalam dolar AS. Lalu untuk transaksi yang menghasilkan hingga $1.000 dalam pendapatan, bagi hasil adalah 80,5555% dari harga transaksi, dan untuk transaksi yang menghasilkan pendapatan lebih dari $1.000, pembagian keuntungannya adalah 90,5% harga transaksi.
- Klik Terapkan dan Tutup untuk menyimpan detail pembagian keuntungan dan kembali ke Tarif Standar Periode paket.
- Untuk paket tarif khusus produk API, konfigurasi detail paket tarif untuk produk API tambahan, jika diperlukan.
Menentukan detail paket pembagian keuntungan menggunakan API
Anda akan menentukan detail paket pembagian keuntungan saat membuat paket tarif. Anda yang menentukan detailnya
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 paket pembagian keuntungan untuk model pembagian tetap
Untuk menerapkan model berbagi tetap, Anda harus menentukan hal berikut dalam detail paket tarif:
- Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi
(
VOLUME).VOLUMEadalah defaultnya. - Jenis pengukuran (
UNIT) yang menunjukkan bahwa pembagian keuntungan bersifat tetap per unit (yaitu, tidak didasarkan pada volume transaksi, seperti halnya model berbagi). - Jenis pendapatan (
GROSSatauNET). Hal ini menunjukkan apakah pembagian keuntungan didasarkan pada harga kotor atau bersih dari transaksi. - Batas waktu pembayaran (misalnya, 30 hari).
- ID organisasi Anda.
- "Dasar" atau mata uang akuntansi yang digunakan perusahaan Anda.
- Tarif paket tarif yang memberikan detail tentang cara penghitungan pembagian keuntungan. 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 pembagian keuntungan. Misalnya, jika Anda menetapkan 80.5555, pembagian keuntungan adalah 80,5555%, yaitu, sebagai penyedia API, Anda membayar pengembang 80,5555% dari harga yang dikenakan untuk setiap transaksi (atau jika berdasarkan atribut khusus, seperti jumlah byte yang ditransmisikan dalam transaksi, Anda membayar pengembang sebesar 80,5555% dari harga yang dikenakan mengirimkan sejumlah byte yang ditentukan).
- Unit awal aplikasi tarif (
0). Ini berarti bahwa tarifnya diterapkan ke setiap transaksi, dimulai dengan transaksi pertama.
Lihat Properti konfigurasi untuk paket tarif untuk mengetahui daftar lengkap properti paket tarif.
Misalnya, contoh berikut membuat rencana pembagian keuntungan dengan model pembagian tetap. Tujuan maka persentase pembagian keuntungannya adalah 80,5555%. Bagi hasil didasarkan pada harga bersih transaksi. Kontrak ini berlaku mulai 15 September 2013 dan pembayaran akan jatuh tempo dalam waktu 30 hari. ( detail yang terkait dengan pembagian keuntungan 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
Respons 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 paket pembagian keuntungan untuk model pembagian fleksibel
Dalam model berbagi yang fleksibel, Anda menentukan detail paket tarif yang mencakup satu atau beberapa paket tarif tarif. Setiap tarif paket tarif mencakup berbagai pendapatan transaksi (setiap rentang disebut "pendapatan band"). Anda menetapkan persentase pembagian keuntungan untuk setiap band pendapatan.
Selain tarif paket tarif, Anda menetapkan hal berikut dalam detail paket tarif:
- Parameter rating yang menunjukkan bahwa paket tarif didasarkan pada transaksi
(
VOLUME).VOLUMEadalah defaultnya. - Jenis pengukuran (
VOLUME) yang menunjukkan bahwa pembagian keuntungan tidak didasarkan pada volume transaksi (yaitu, tidak tetap, seperti halnya untuk pembagian tetap ). - Jenis pendapatan (
GROSSatauNET). Hal ini menunjukkan apakah pembagian keuntungan didasarkan pada harga kotor atau bersih dari transaksi. - Batas waktu pembayaran (misalnya, 30 hari).
- ID organisasi Anda.
- "Dasar" atau mata uang akuntansi yang digunakan perusahaan Anda.
- Jenis durasi dan jenis durasi yang bersama-sama menentukan periode waktu saat pendapatan diagregasi (ini juga disebut "dasar agregasi"). Transaksi akan digabungkan selama berdasarkan agregasi (misalnya, 1 bulan) untuk menghitung total pendapatan dan {i>band<i} pendapatan. Persentase pembagian keuntungan yang diterapkan untuk setiap transaksi bergantung pada pendapatannya gelang.
- 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 pembagian keuntungan untuk band pendapatan. Misalnya, jika Anda menentukan 80.5555, pembagian keuntungan untuk band pendapatan adalah 80,5555%, yaitu, sebagai API penyedia layanan, Anda membayar pengembang 80,5555% dari harga yang dikenakan untuk setiap transaksi dalam {i>band<i} pendapatan.
- Unit awal dan akhir dari band pendapatan. Unit awal menentukan nilai
batas band pendapatan, dan unit akhir menentukan batas atas band pendapatan. Sebagai
misalnya, jika Anda menentukan unit awal 0 dan unit akhir 1000, rentang pendapatan
mencakup pendapatan transaksi yang lebih besar dari 0 dan hingga 1.000 dalam mata uang yang ditentukan. Jika
mata uangnya adalah dolar AS, dasar agregasinya adalah 1 bulan, dan persentase pendapatan
band ini adalah 80,5555%, maka untuk transaksi yang menghasilkan pendapatan hingga $1000 dalam sebulan,
bagi hasil adalah 80,5555% dari harga transaksi.
Jika Anda tidak menentukan unit akhir untuk rentang pendapatan akhir, persentase pembagian untuk pita tersebut diterapkan ke semua transaksi setelah pendapatan agregat melampaui unit awal untuk band tersebut. Misalnya, unit awal untuk pita terakhir adalah 1000. (asumsikan dolar AS), dan Anda tidak menentukan unit akhir untuk band tersebut, pendapatan persentase untuk band ini diterapkan untuk semua transaksi di atas $1.000 dari pendapatan periode agregat.
Lihat Properti konfigurasi untuk paket tarif untuk mengetahui daftar lengkap properti paket tarif.
Misalnya, kode berikut membuat rencana pembagian keuntungan dengan model pembagian fleksibel. Ini menentukan dua rentang pendapatan. Band pertama mencakup pendapatan transaksi yang lebih besar dari maksimal 1.000 dalam Dolar AS. Band kedua mencakup pendapatan transaksi lebih dari 1.000 dolar AS. Pendapatan persentase pembagian adalah 80,5555% untuk pita pendapatan pertama, dan 90,5% untuk pita pendapatan kedua. Bagi hasil didasarkan pada harga bersih transaksi. Dasar agregasi adalah 1 bulan. Periode kontrak berlaku mulai 15 September 2013 dan pembayaran akan jatuh tempo dalam waktu 30 hari. (Pendapatan detail yang terkait dengan pembagian 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
Respons 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" }