Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Wprowadzenie
W planie udziału w przychodach dostawca interfejsu API udostępnia deweloperowi procent przychodów wygenerowanych z każdej transakcji (na podstawie ceny brutto lub netto transakcji). Kiedy tworzysz plan udziału w przychodach, musisz określić model udziału, lub elastyczność, oraz podstawę cenową (np. czy udział w przychodach jest oparty na wartości brutto czy netto cenę transakcji). Cenę brutto lub netto określasz podczas tworzenia zasady rejestrowania transakcji.
W modelu stałego udziału deweloperowi dzielisz się z deweloperem stałym procentem przychodów generowanych z każdej transakcji (na podstawie ceny brutto lub netto transakcji). W elastycznym modelem udostępniania, dzielisz się z deweloperem zmiennym procentem przychodów. udział w przychodach zależy od przychodów wygenerowanych w danym okresie. Procent wykorzystania w Udział w przychodach może się różnić w zależności od kwoty przychodów wygenerowanych przez transakcje.
Określanie szczegółów planu udziału w przychodach za pomocą interfejs
Skonfiguruj plany udziału w przychodach w sposób opisany poniżej.
Edge
Aby skonfigurować plan udziału w przychodach za pomocą interfejsu Edge podczas tworzenia lub edytowania plan stawek wybierz typ planu Udział w przychodach lub Arkusz stawek i udział w przychodach oraz w sekcji Udział w przychodach skonfiguruj te informacje:
| Pole | Opis |
| Model obliczeniowy | Wybierz jeden z tych typów cen:
|
| Częstotliwość obliczania | Okres, w którym obliczana jest liczba transakcji (lub liczba związana z atrybutami niestandardowymi). Wybierz liczbę miesięcy (1–24 miesiące). |
| Model udostępniania | Wybierz jeden z tych modeli udziału w przychodach:
|
| Stały udział w przychodach | W przypadku modelu stałego udziału określa wartość procentową używaną do obliczenia udziału w przychodach. Wpisz liczbę dziesiętną (z maksymalnie czterema miejscami po przecinku). Jeśli na przykład wpiszesz 80.5555, udział w przychodach wyniesie 80, 5555%, co oznacza, że jako dostawca interfejsu API płacisz deweloperowi 80, 5555% ceny pobieranej za każdą transakcję. |
| Zakresy udziału w przychodach | W przypadku elastycznego modelu udostępniania jeden lub więcej zakresów przychodów z transakcji (każdy zakres to „przedział przychodów”). Każdemu zakresowi przychodów można przypisać wartość procentową udziału w przychodach. Transakcje są agregowane według zasady agregacji, aby obliczyć łączne przychody i przedział przychodów transakcji. Procentowy udział w przychodach stosowany w przypadku każdej transakcji zależy od jego zakresu przychodów. Określ górny limit pierwszego zakresu, na przykład 1000 (dolny limit jest wstępnie ustawiony na wartość większą niż 0). Kliknij +Nowe, aby dodać kolejne opaski. Pozostaw górny limit ostatniego zakresu pusty, aby wskazać wszystkie transakcje po przekroczeniu tego poziomu łącznych przychodów. Jeśli na przykład w sekcji Zakres przychodów określisz dwa zakresy przychodów (>0–1000 oraz 1000 i więcej), możesz wpisać 80,5555 dla zakresu >0–1000 i 90,5 dla zakresu 1000 i wyższego. Załóżmy też, że walutą jest dolar amerykański. Z kolei w przypadku transakcji, które generują przychody do 1000 USD, udział w przychodach wynosi 80,5555% ceny transakcji. Natomiast w przypadku transakcji, które generują ponad 1000 USD przychodów, udział w przychodach wynosi 90,5% ceny transakcji. |
Classic Edge (Private Cloud)
Aby skonfigurować plany udziału w przychodach za pomocą interfejsu Classic Edge:
- Postępuj zgodnie z instrukcjami, aby utworzyć plan stawek.
- Aby skonfigurować model rozliczeniowy, z menu Typ planu stawek wybierz Udział w przychodach.
- Jeśli wybrany pakiet interfejsów API zawiera wiele usług API, wybierz jedną z tych opcji:
Uwaga: jeśli pakiet interfejsów API zawiera jedną usługę API, możesz pominąć ten krok.
- Abonamenty na poziomie usługi umożliwiają skonfigurowanie szczegółów abonamentu dla każdej usługi API z osobna.
- Abonament ogólny dla wszystkich usług umożliwia skonfigurowanie szczegółów abonamentu dla wszystkich usług API.
- Kliknij Udział w przychodach dla ogólnego planu stawek lub dla każdego abonamentu interfejsu API w przypadku poszczególnych usług.
Uwaga: podczas konfigurowania abonamentów dla poszczególnych usług API musisz skonfigurować plan udziału w przychodach. dla każdej usługi API.
Otworzy się okno Udział w przychodach.
- Wybierz jeden z tych modeli udostępniania:
- Stały: w tym modelu dostawca interfejsu API udostępnia deweloperowi stały odsetek przychodów wygenerowanych z każdej transakcji (na podstawie ceny brutto lub netto danej transakcji transakcji).
- Elastyczność: w tym modelu dostawca interfejsu API udostępnia deweloperowi zmienną procent przychodów. Udział w przychodach zależy od przychodów wygenerowanych w danym okresie czasu. Wartość procentowa używana w obliczaniu udziału w przychodach może się różnić w zależności od kwoty przychodów generowanych przez transakcje.
W przypadku modelu udostępniania stałego:
Jeśli wybierzesz model udostępniania stałego, podaj te informacje w sekcji Ceny w oknie Ogólny udział w przychodach:
Pole Opis Operator (lub organizacja) Nazwa Twojej organizacji. To pole jest wstępnie skonfigurowane za pomocą operatora (lub Organization) pola w profilu organizacji.
Kraj Kraj, w którym prowadzisz działalność. To pole jest wstępnie skonfigurowane za pomocą Wartość pola kraju w profilu organizacji.
Waluta Baza lub waluty księgowej używanej przez firmę. To pole jest gotowe korzystając z wartości pola Waluta w profilu organizacji.
Typ wyceny Podstawa udziału w przychodach. Wybierz Brutto lub Netto. Jeśli wybierzesz opcję Brutto, udział w przychodach to procent ceny brutto transakcji. Jeśli wybierz Netto, udział w przychodach jest obliczany na podstawie procentu ceny netto danej transakcji. Uwaga: cenę brutto lub netto dla transakcji określasz podczas tworzenia zasady rejestrowania transakcji.
Stały udział procentowy Wartość procentowa służąca do obliczenia udziału w przychodach. Wpisz liczbę dziesiętną (z do czterech miejsc po przecinku). Jeśli na przykład wpiszesz 80.5555, udział w przychodach będzie wynosić 80,5555%, co oznacza, że jako dostawca interfejsu API płacisz deweloperowi 80,5555% ceny pobieranej za każdą transakcję.
Elastyczny model udostępniania:
Jeśli wybierzesz elastyczny model udostępniania, zobaczysz, że okno Ogólny udział w przychodach wyświetla dodatkowe pola. Za pomocą tych pól możesz określić podstawę agregacji oraz Określ „przedziały przychodów”, czyli zakresy przychodów generowanych przez transakcje, dla których mają różne wartości procentowe udziału w przychodach.
W oknie Ogólny udział w przychodach wpisz następujące informacje:
Pole Opis Podstawa agregacji Okres, za który przychody są łączone. Łączne przychody wynoszą służy do obliczenia zakresu przychodów dla każdej transakcji (oraz odpowiednich przychodów procent udziału). Wybierz liczbę miesięcy (od 1 do 12).
Zakresy przychodów Co najmniej jeden zakres przychodów z transakcji (każdy z nich to „przedział przychodów”). Każdy dla przedziału przychodów można przypisać wartość procentową udziału w przychodach (ustawiasz ją w w polu Przedziały przychodów w sekcji Ceny). Transakcje są agregowane od podstawę agregacji, aby obliczyć łączne przychody oraz przedział przychodów dla transakcji. Procentowy udział w przychodach stosowany w przypadku każdej transakcji zależy od w zakresie przychodów.
Określ górny limit pierwszego pasma, na przykład do 1000 (dolny limit jest wstępnie ustawiony na wartość większą niż 0). Kliknij +, aby dodać drugą opaskę, np. między 1000 a 2000. Aby dodać więcej pasków, kliknij +. Górną stronę limitu ostatniego zakresu pustego, aby wskazać wszystkie transakcje po danych zbiorczych że przychody przekroczyły ten poziom.
Ceny Operator (lub organizacja) Nazwa Twojej organizacji. To pole jest wstępnie skonfigurowane za pomocą operatora (lub Organization) pola w profilu organizacji.
Kraj Kraj, w którym prowadzisz działalność. To pole jest wstępnie skonfigurowane za pomocą Wartość pola kraju w profilu organizacji.
Waluta Baza czy waluty rozliczeniowej używanej przez organizację. To pole jest korzystając z wartości pola Waluta w profilu organizacji.
Typ wyceny Podstawa udziału w przychodach. Wybierz Brutto lub Netto. Jeśli wybierzesz opcję Brutto, udział w przychodach to procent ceny brutto transakcji. Jeśli wybierz Netto, udział w przychodach jest obliczany na podstawie procentu ceny netto danej transakcji. Uwaga: cenę brutto lub netto dla transakcji określasz podczas tworzenia zasady rejestrowania transakcji.
Procent udziału dla różnych pasm przychodów Procent użyty do obliczenia udziału w przychodach z transakcji w każdej w zakresie przychodów. Dla każdego pasma określasz wartość procentową. Wpisz liczbę dziesiętną (ze znakiem plusa) do czterech miejsc po przecinku). Jeśli na przykład w kolumnie Przychody określisz dwa przedziały przychodów, Sekcja pasma (>0-1000 i 1000 i większe) możesz wpisać 80,5555 dla > 0–1000 i 90, 5 dla przedziału 1000 i wyższego. Zakładaj też walutą jest dolar amerykański. Potem transakcje o wartości do 1000 USD udziału w przychodach wynosi 80, 5555% ceny transakcji, a w przypadku transakcji, które wygenerowały przychody powyżej 1000 USD, udział w przychodach wynosi 90,5% cenę transakcji.
- Kliknij Zastosuj i zamknij, aby zapisać szczegóły udziału w przychodach i powrócić do stawki standardowej. Okno planu.
- W przypadku abonamentów usług interfejsu API skonfiguruj szczegóły abonamentu dodatkowych usług API zgodnie z wymaganiami.
Określanie szczegółów planu udziału w przychodach za pomocą interfejsu API
Szczegóły planu udziału w przychodach określasz podczas jego tworzenia. Ty określasz szczegóły
we właściwości ratePlanDetails w treści żądania w wywołaniu funkcji
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans Co Ty
określone we właściwości ratePlanDetails, w zależności od wybranego modelu udostępniania:
stałą lub elastyczną.
Określanie szczegółów planu udziału w przychodach dla modelu stałego udziału
Aby wdrożyć model stałego udostępniania, musisz określić w szczegółach abonamentu te te elementy:
- Parametr oceny, który wskazuje, że plan stawek jest oparty na transakcjach
(
VOLUME). Domyślna wartość toVOLUME. - Typ pomiaru (
UNIT), który wskazuje, że udział w przychodach jest stały na jednostkę. (czyli nie zależą one od liczby transakcji, jak w przypadku elastycznego modelu modelu udostępniania). - Typ przychodów (
GROSSlubNET). Wskazuje, czy udział w przychodach jest obliczany na podstawie ceny brutto lub netto transakcji. - termin płatności (np. 30 dni);
- Identyfikator Twojej organizacji.
- Baza lub waluty księgowej używanej przez firmę.
- Stawka według planu stawek, która zawiera szczegółowe informacje o sposobie obliczania udziału w przychodach. Ponieważ model udostępniania opiera się na stałej stawce, możesz określić tylko jedną stawkę w ramach planu stawek.
Pełną listę właściwości szczegółów planu stawek znajdziesz w sekcji Właściwości konfiguracji abonamentu.
W stawce planu stawek podajesz:
- Typ stawki abonamentu (
REVSHARE). - Wartość procentowa służąca do obliczenia udziału w przychodach. Jeśli na przykład wpiszesz 80.5555, udział w przychodach wynosi 80,5555%, co oznacza, że jako dostawca interfejsu API płacisz deweloperowi 80,5555% cenę naliczaną za każdą transakcję (lub w przypadku wybrania na podstawie atrybutu niestandardowego, takiego jak liczba bajtów przesłanych w transakcji, płacisz deweloperowi 80,5555% ceny pobieranej za przesyłając określoną liczbę bajtów).
- Początkowa jednostka stawki (
0). Oznacza to, że stawka stosowane w każdej transakcji, zaczynając od pierwszej transakcji.
Pełną listę właściwości planu stawek znajdziesz w sekcji Właściwości konfiguracji planów stawek.
Przykład poniżej pozwala utworzyć plan udziału w przychodach z modelem stałego udostępniania. procent udziału w przychodach wynosi 80,5555%. Udział w przychodach jest oparty na cenie netto transakcji. Umowa obowiązuje od 15 września 2013 roku. Termin płatności upływa za 30 dni. (Parametr są wyróżnione szczegóły dotyczące udziału w przychodach).
$ 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
Odpowiedź powinna wyglądać tak (widoczna jest tylko jej część):
{ "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" }
Określanie szczegółów planu udziału w przychodach dla elastycznego modelu udostępniania
W modelu elastycznego udostępniania danych określasz szczegóły abonamentu, które obejmują co najmniej 1 abonament stawki. Każda stawka w planie stawek obejmuje zakres przychodów z transakcji (każdy zakres to „przychody” ”). Do każdego zakresu przychodów przypisujesz procent udziału w przychodach.
Oprócz stawek w planie stawek w szczegółach abonamentu podajesz te informacje:
- Parametr oceny, który wskazuje, że plan stawek jest oparty na transakcjach
(
VOLUME). Domyślna wartość toVOLUME. - Typ pomiaru (
VOLUME), który wskazuje, że udział w przychodach nie jest oparty na liczby transakcji (czyli nie jest ustalany na stałe, jak w przypadku stałego udostępniania ). - Typ przychodów (
GROSSlubNET). Wskazuje, czy udział w przychodach jest obliczany na podstawie ceny brutto lub netto transakcji. - termin płatności (np. 30 dni);
- Identyfikator Twojej organizacji.
- Baza lub waluty księgowej używanej przez firmę.
- Typ czasu trwania i czasu trwania, które wspólnie określają okres, w którym przychody zagregowane (nazywane też „podstawą agregacji”). Transakcje są agregowane od podstawa agregacji (np. 1 miesiąc), aby obliczyć łączne przychody oraz odpowiednie w zakresie przychodów. Procentowy udział w przychodach stosowany w przypadku każdej transakcji zależy od przychodów opaski.
- Liczniki agregacji, które służą do określania odpowiedniego przedziału przychodów.
Pełną listę właściwości szczegółów planu stawek znajdziesz w sekcji Właściwości konfiguracji abonamentu.
W przypadku każdej stawki abonamentu określasz:
- Typ stawki abonamentu w zakresie przychodów (
REVSHARE). - Wartość procentowa służąca do obliczenia udziału w przychodach dla danego zakresu przychodów. Na przykład, jeśli Jeśli wpiszesz 80,5555, udział w przychodach w przedziale przychodów wynosi 80,5555%, co oznacza, że w przypadku interfejsu API dewelopera, płacisz 80,5555% ceny pobieranej za każdą transakcję w zakresie przychodów.
- Początkowa i końcowa jednostka zakresu przychodów. Jednostka początkowa określa niższą
dla zakresu przychodów, a jednostka końcowa określa górny limit. Dla:
Jeśli na przykład określisz jednostkę początkową równą 0, a jednostkę końcową równą 1000, zakres przychodów
obejmuje przychody z transakcji od 0 do 1000 w określonej walucie. Jeśli
waluta to dolar amerykański, podstawa agregacji to 1 miesiąc, a procent przychodów –
wynosi 80,5555%, natomiast dla transakcji, które generują miesięczne przychody do 1000 USD,
udziału w przychodach wynosi 80,5555% ceny transakcji.
Jeśli nie określisz jednostki końcowej dla końcowego zakresu przychodów, wartość procentowa udziału jest stosowany do wszystkich transakcji, gdy łączne przychody przekroczą jednostki początkowej dla danego pasma. Na przykład, jeśli jednostka początkowa ostatniego pasma to 1000. (przyjmując dolary amerykańskie) i nie podasz jednostki końcowej dla tego zakresu, przychodów odsetek dla zakresu jest stosowany do wszystkich transakcji powyżej 1000 USD przychodów w okresie zagregowany okres.
Pełną listę właściwości planu stawek znajdziesz w sekcji Właściwości konfiguracji planów stawek.
Poniższy przykład pokazuje plan udziału w przychodach z elastycznym modelem udostępniania. it określa 2 zakresy przychodów. Pierwszy zespół pokrywa przychody z transakcji większe niż do 1000. w dolarach amerykańskich. Drugi zakres pokrywa przychody z transakcji w wysokości ponad 1000 USD. Przychody w przypadku pierwszego zakresu przychodów wynosi 80,5555%, a drugiego – 90,5%. Udział w przychodach jest obliczany na podstawie ceny netto transakcji. Podstawą agregacji jest 1 miesiąc. Umowa obowiązuje od 15 września 2013 roku. Termin płatności upływa za 30 dni. (Przychód są wyróżnione).
$ 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
Odpowiedź powinna wyglądać tak (widoczna jest tylko jej część):
{ "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" }