Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację
Apigee X. info
Wprowadzenie
W planie udziału w przychodach dostawca interfejsu API dzieli się z deweloperem procentem przychodów generowanych przez każdą transakcję (na podstawie ceny brutto lub netto transakcji). Podczas tworzenia planu udziału w przychodach musisz wskazać model udziału, który może być stały lub elastyczny, oraz podstawę cenową (np. czy udział w przychodach jest oparty na cenie brutto czy netto transakcji). Cenę brutto lub netto transakcji ustawiasz podczas tworzenia zasady rejestrowania transakcji.
W modelu udziału stałego dzielisz się z deweloperem stałym procentem przychodów generowanych przez każdą transakcję (na podstawie ceny brutto lub netto transakcji). W modelu udziału elastycznego dzielisz się z deweloperem zmiennym procentem przychodów. Udział w przychodach zależy od przychodów wygenerowanych w danym okresie. Procent używany do obliczania udziału w przychodach może się różnić w zależności od kwoty przychodów generowanych przez transakcje.
Określanie szczegółów planu udziału w przychodach za pomocą interfejsu
Skonfiguruj plany udziału w przychodach zgodnie z opisem poniżej.
Edge
Aby skonfigurować plan udziału w przychodach za pomocą interfejsu Edge, podczas tworzenia lub edycji abonamentu wybierz typ abonamentu Udział w przychodach lub Cennik i udział w przychodach i w sekcji Udział w przychodach skonfiguruj te informacje:
| Pole | Opis |
| Model obliczania | Wybierz jeden z tych typów cen:
|
| Częstotliwość obliczania | Okres, w którym obliczana jest liczba transakcji (lub liczba powiązana z atrybutem niestandardowym). Wybierz liczbę miesięcy (od 1 do 24). |
| Model udziału | Wybierz jeden z tych modeli udziału w przychodach:
|
| Stały udział w przychodach | W przypadku modelu udziału stałego określa procent używany do obliczania udziału w przychodach. Wpisz liczbę dziesiętną (z maksymalnie 4 miejscami po przecinku). Jeśli na przykład wpiszesz 80, 5555, udział w przychodach wyniesie 80,5555%, czyli jako dostawca interfejsu API zapłacisz deweloperowi 80, 5555% ceny pobieranej za każdą transakcję. |
| Zakresy udziału w przychodach | W przypadku modelu udziału elastycznego – co najmniej 1 zakres przychodów z transakcji (każdy zakres to „zakres przychodów”). Do każdego zakresu przychodów można przypisać procent udziału w przychodach. Transakcje są agregowane na podstawie agregacji, aby obliczyć łączne przychody i zakres przychodów z transakcji. Procent udziału w przychodach stosowany do każdej transakcji zależy od jej zakresu przychodów. Określ górny limit pierwszego zakresu, np. do 1000 (dolny limit jest ustawiony domyślnie na wartość większą niż 0). Aby dodać kolejne zakresy, kliknij +Nowy. Pozostaw puste pole górnego limitu ostatniego zakresu, aby wskazać wszystkie transakcje po przekroczeniu tego poziomu przez łączne przychody. Jeśli na przykład w sekcji Zakres przychodów określisz 2 zakresy przychodów (>0–1000 i 1000 i więcej), możesz wpisać 80,5555 w przypadku zakresu przychodów >0–1000 oraz 90,5 w przypadku zakresu przychodów 1000 i więcej. Załóżmy też, że walutą są dolary amerykańskie. W przypadku transakcji, które generują przychody do 1000 USD, udział w przychodach wynosi 80,5555% ceny transakcji, a w przypadku transakcji, które generują przychody powyżej 1000 USD, 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 tworzenia abonamentu.
- Aby skonfigurować model przychodów, w menu Abonament wybierz Udział w przychodach.
- Jeśli wybrany pakiet interfejsu API zawiera kilka usług API, wybierz jedną z tych opcji:
Uwaga: jeśli pakiet interfejsu API zawiera tylko 1 usługę API, możesz pominąć ten krok.
- Plany dotyczące konkretnych usług , aby skonfigurować szczegóły abonamentu dla każdej usługi API osobno.
- Ogólny plan dla wszystkich usług , aby skonfigurować szczegóły abonamentu dla wszystkich usług API.
- Kliknij Udział w przychodach w przypadku ogólnego abonamentu lub każdego abonamentu dotyczącego konkretnej usługi API.
Uwaga: podczas konfigurowania planów dotyczących konkretnych usług API musisz skonfigurować plan udziału w przychodach dla każdej usługi API osobno.
Otworzy się okno Udział w przychodach.
- Wybierz jeden z tych modeli udziału:
- Stały: w tym modelu dostawca interfejsu API dzieli się z deweloperem stałym procentem przychodów generowanych przez każdą transakcję (na podstawie ceny brutto lub netto transakcji).
- Elastyczny: w tym modelu dostawca interfejsu API dzieli się z deweloperem zmiennym procentem przychodów. Udział w przychodach zależy od przychodów wygenerowanych w danym okresie. Procent używany do obliczania udziału w przychodach może się różnić w zależności od kwoty przychodów generowanych przez transakcje.
W przypadku modelu udziału stałego:
Jeśli wybierzesz model udziału stałego, w sekcji Ceny w oknie Ogólny udział w przychodach wpisz te informacje:
Pole Opis Operator (lub organizacja) Nazwa Twojej organizacji. To pole jest wstępnie wypełnione wartością pola Operator (lub organizacja) w profilu organizacji.
Kraj Kraj, w którym Twoja organizacja prowadzi działalność. To pole jest wstępnie wypełnione wartością pola Kraj w profilu organizacji.
Waluta Waluta „podstawowa” lub księgowa używana przez Twoją firmę. To pole jest wstępnie wypełnione wartością pola Waluta w profilu organizacji.
Typ wyceny Podstawa udziału w przychodach. Wybierz Brutto lub Netto. Jeśli wybierzesz Brutto, udział w przychodach będzie obliczany na podstawie procentu ceny brutto transakcji. Jeśli wybierzesz Netto, udział w przychodach będzie obliczany na podstawie procentu ceny netto transakcji. Uwaga: cenę brutto lub netto transakcji ustawiasz podczas tworzenia zasady rejestrowania transakcji.
Stały udział % Procent używany do obliczania udziału w przychodach. Wpisz liczbę dziesiętną (z maksymalnie 4 miejscami po przecinku). Jeśli na przykład wpiszesz 80, 5555, udział w przychodach wyniesie 80,5555%, czyli jako dostawca interfejsu API zapłacisz deweloperowi 80, 5555% ceny pobieranej za każdą transakcję.
W przypadku modelu udziału elastycznego:
Jeśli wybierzesz model udziału elastycznego, zobaczysz, że w oknie Ogólny udział w przychodach wyświetlają się dodatkowe pola. Używasz tych pól, aby określić podstawę agregacji i określić "zakresy przychodów", czyli zakresy przychodów z transakcji, do których możesz stosować różne procenty udziału w przychodach.
W oknie Ogólny udział w przychodach wpisz te informacje:
Pole Opis Podstawa agregacji Okres, w którym przychody są agregowane. Zagregowane przychody są używane do obliczania zakresu przychodów dla każdej transakcji (i odpowiedniego procentu udziału w przychodach). Wybierz liczbę miesięcy (od 1 do 12).
Zakresy przychodów Co najmniej 1 zakres przychodów z transakcji (każdy zakres to „zakres przychodów”). Do każdego zakresu przychodów można przypisać procent udziału w przychodach (ustawiasz go w polu Zakresy przychodów w sekcji Ceny). Transakcje są agregowane na podstawie agregacji, aby obliczyć łączne przychody i zakres przychodów z transakcji. Procent udziału w przychodach stosowany do każdej transakcji zależy od jej zakresu przychodów.
Określ górny limit pierwszego zakresu, np. do 1000 (dolny limit jest ustawiony domyślnie na wartość większą niż 0). Aby dodać drugi zakres, np. większy niż 1000 i do 2000, kliknij +. Aby dodać więcej zakresów, kliknij +. Możesz pozostawić puste pole górnego limitu ostatniego zakresu, aby wskazać wszystkie transakcje po przekroczeniu tego poziomu przez łączne przychody.
Ceny Operator (lub organizacja) Nazwa Twojej organizacji. To pole jest wstępnie wypełnione wartością pola Operator (lub organizacja) w profilu organizacji.
Kraj Kraj, w którym Twoja organizacja prowadzi działalność. To pole jest wstępnie wypełnione wartością pola Kraj w profilu organizacji.
Waluta Waluta „podstawowa” lub księgowa używana przez Twoją organizację. To pole jest wstępnie wypełnione wartością pola Waluta w profilu organizacji.
Typ wyceny Podstawa udziału w przychodach. Wybierz Brutto lub Netto. Jeśli wybierzesz Brutto, udział w przychodach będzie obliczany na podstawie procentu ceny brutto transakcji. Jeśli wybierzesz Netto, udział w przychodach będzie obliczany na podstawie procentu ceny netto transakcji. Uwaga: cenę brutto lub netto transakcji ustawiasz podczas tworzenia zasady rejestrowania transakcji.
Udział % w zakresach przychodów Procent używany do obliczania udziału w przychodach w przypadku transakcji w każdym zakresie przychodów. Dla każdego zakresu określasz procent. Wpisz liczbę dziesiętną (z maksymalnie 4 miejscami po przecinku). Jeśli na przykład w sekcji Zakres przychodów określisz 2 zakresy przychodów (>0–1000 i 1000 i więcej), możesz wpisać 80,5555 w przypadku zakresu przychodów >0–1000 oraz 90,5 w przypadku zakresu przychodów 1000 i więcej. Załóżmy też, że walutą są dolary amerykańskie. W przypadku transakcji, które generują przychody do 1000 USD w przychodach, udział w przychodach wynosi 80,5555% ceny transakcji, a w przypadku transakcji, które generują przychody powyżej 1000 USD, udział w przychodach wynosi 90,5% ceny transakcji.
- Aby zapisać szczegóły udziału w przychodach i wrócić do okna Standardowy abonament, kliknij Zastosuj i zamknij.
- W przypadku abonamentów dotyczących konkretnych usług API skonfiguruj szczegóły abonamentu dla dodatkowych usług API.
Określanie szczegółów planu udziału w przychodach za pomocą interfejsu API
Szczegóły planu udziału w przychodach określasz podczas tworzenia abonamentu. Szczegóły określasz
we właściwości ratePlanDetails w treści żądania w wywołaniu
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans. To, co
określisz we właściwości ratePlanDetails, zależy od wybranego modelu udziału:
stałego lub elastycznego.
Określanie szczegółów planu udziału w przychodach w przypadku modelu udziału stałego
Aby wdrożyć model udziału stałego, w szczegółach abonamentu określ te informacje:
- Parametr oceny, który wskazuje, że abonament jest oparty na transakcjach
(
VOLUME).VOLUMEjest wartością domyślną. - Typ pomiaru (
UNIT), który wskazuje, że udział w przychodach jest stały na jednostkę (czyli nie jest oparty na liczbie transakcji, jak w przypadku modelu udziału elastycznego). - Typ przychodów (
GROSSlubNET). Wskazuje, czy udział w przychodach jest oparty na cenie brutto czy netto transakcji. - Okres płatności (np. 30 dni).
- Identyfikator Twojej organizacji.
- Waluta „podstawowa” lub księgowa używana przez Twoją firmę.
- Stawka abonamentu, która zawiera informacje o sposobie obliczania udziału w przychodach. Ponieważ model udziału jest oparty na stałej stawce, określasz tylko 1 stawkę abonamentu.
Pełną listę właściwości szczegółów abonamentu znajdziesz w artykule Właściwości konfiguracji szczegółów abonamentu.
W stawce abonamentu określasz:
- Typ stawki abonamentu (
REVSHARE). - Procent używany do obliczania udziału w przychodach. Jeśli na przykład określisz 80,5555, udział w przychodach wyniesie 80,5555%, czyli jako dostawca interfejsu API zapłacisz deweloperowi 80,5555% ceny pobieranej za każdą transakcję (lub jeśli jest to oparte na atrybucie niestandardowym, np. liczbie bajtów przesłanych w transakcji, zapłacisz deweloperowi 80,5555% ceny pobieranej za przesłanie określonej liczby bajtów).
- Jednostkę początkową zastosowania stawki (
0). Oznacza to, że stawka jest stosowana do każdej transakcji, począwszy od pierwszej.
Pełną listę właściwości abonamentu znajdziesz w artykule Właściwości konfiguracji abonamentów.
Na przykład ten kod tworzy plan udziału w przychodach z modelem udziału stałego. 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 r., a płatność jest należna w ciągu 30 dni. (Szczegóły dotyczące udziału w przychodach są wyróżnione).
$ 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 (pokazana jest tylko część odpowiedzi):
{ "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 w przypadku modelu udziału elastycznego
W modelu udziału elastycznego określasz szczegóły abonamentu, które obejmują co najmniej 1 stawkę abonamentu. Każda stawka abonamentu obejmuje zakres przychodów z transakcji (każdy zakres nazywa się „zakresem przychodów”). Do każdego zakresu przychodów przypisujesz procent udziału w przychodach.
Oprócz stawek abonamentu w szczegółach abonamentu określasz te informacje:
- Parametr oceny, który wskazuje, że abonament jest oparty na transakcjach
(
VOLUME).VOLUMEjest wartością domyślną. - Typ pomiaru (
VOLUME), który wskazuje, że udział w przychodach nie jest oparty na liczbie transakcji (czyli nie jest stały, jak w przypadku modelu udziału stałego ). - Typ przychodów (
GROSSlubNET). Wskazuje, czy udział w przychodach jest oparty na cenie brutto czy netto transakcji. - Okres płatności (np. 30 dni).
- Identyfikator Twojej organizacji.
- Waluta „podstawowa” lub księgowa używana przez Twoją firmę.
- Czas trwania i typ czasu trwania, które razem określają okres, w którym przychody są agregowane (nazywa się to też "podstawą agregacji"). Transakcje są agregowane na podstawie agregacji (np. 1 miesiąc), aby obliczyć łączne przychody i odpowiedni zakres przychodów. Procent udziału w przychodach stosowany do każdej transakcji zależy od jej zakresu przychodów.
- Liczniki agregacji, które służą do określania odpowiedniego zakresu przychodów.
Pełną listę właściwości szczegółów abonamentu znajdziesz w artykule Właściwości konfiguracji szczegółów abonamentu.
W przypadku każdej stawki abonamentu określasz:
- Typ stawki abonamentu dla zakresu przychodów (
REVSHARE). - Procent używany do obliczania udziału w przychodach w przypadku zakresu przychodów. Jeśli na przykład określisz 80, 5555, udział w przychodach w przypadku zakresu przychodów wyniesie 80,5555%, czyli jako dostawca interfejsu API zapłacisz deweloperowi 80, 5555% ceny pobieranej za każdą transakcję w tym zakresie przychodów.
- Jednostkę początkową i końcową zakresu przychodów. Jednostka początkowa określa dolny
limit zakresu przychodów, a jednostka końcowa – górny limit zakresu przychodów. Jeśli
na przykład określisz jednostkę początkową 0 i jednostkę końcową 1000, zakres przychodów
obejmuje przychody z transakcji większe niż 0 i do 1000 w określonej walucie. Jeśli walutą są dolary amerykańskie, podstawa agregacji to 1 miesiąc, a procent dla zakresu przychodów wynosi 80,5555%, to w przypadku transakcji, które generują przychody do 1000 USD w miesiącu, udział w przychodach wynosi 80,5555% ceny transakcji.
Jeśli nie określisz jednostki końcowej dla ostatniego zakresu przychodów, procent udziału w tym zakresie będzie stosowany do wszystkich transakcji po przekroczeniu przez łączne przychody jednostki początkowej tego zakresu. Jeśli na przykład jednostka początkowa ostatniego zakresu to 1000 (załóżmy, że dolary amerykańskie), a nie określisz jednostki końcowej dla tego zakresu, procent przychodów w tym zakresie będzie stosowany do wszystkich transakcji powyżej 1000 USD przychodów w okresie agregacji.
Pełną listę właściwości abonamentu znajdziesz w artykule Właściwości konfiguracji abonamentów.
Na przykład ten kod tworzy plan udziału w przychodach z modelem udziału elastycznego. Określa 2 zakresy przychodów. Pierwszy zakres obejmuje przychody z transakcji większe niż 0 i do 1000 dolarów amerykańskich. Drugi zakres obejmuje przychody z transakcji powyżej 1000 dolarów amerykańskich. Procent udziału w przychodach wynosi 80,5555% w przypadku pierwszego zakresu przychodów i 90,5% w przypadku drugiego zakresu przychodów. Udział w przychodach jest oparty na cenie netto transakcji. Podstawa agregacji to 1 miesiąc. Okres obowiązywania umowy to 15 września 2013 r., a płatność jest należna w ciągu 30 dni. (Szczegóły dotyczące udziału w przychodach 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 (pokazana jest tylko część odpowiedzi):
{ "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" }