Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info
Wprowadzenie
W przypadku planu opartego na arkuszu stawek deweloper ponosi opłatę za każdą transakcję. W przypadku tego typu planu musisz podać dodatkowe informacje, takie jak model ładowania i cena tego modelu.
Opcjonalnie możesz określić pakiet freemium dla poszczególnych produktów (a nie dla pakietu interfejsów API) – możesz to zrobić tylko w przypadku pakietu dotyczącego konkretnego produktu.
Kiedy pobierane są opłaty cykliczne i resetowane są pakiety?
Plany taryfowe mogą obejmować opłaty cykliczne, a także pakiety interfejsów API (plany oparte na ilości i pakiety), w przypadku których opłaty są naliczane w określonych momentach, a plany pakietów są resetowane do zera. W tabeli poniżej opisano, kiedy są naliczane opłaty cykliczne i resetowane liczby pakietów. Jeśli aplikacje dewelopera nie mogą wykonywać kolejnych wywołań interfejsu API, ponieważ osiągnęły określony limit transakcji, w tych momentach liczniki wywołań interfejsu API są resetowane do zera i aplikacje mogą ponownie wykonywać wywołania.
| Jeśli pakiet ma… | ...this happens |
|---|---|
|
Opłata cykliczna i abonament są resetowane pierwszego dnia miesiąca (domyślnie). Aby utworzyć miesięczny cykl powtarzania w określonym dniu, utwórz plan cenowy za pomocą interfejsu API do zarządzania i wskaż dzień za pomocą właściwości |
|
Opłata cykliczna i resetowanie pakietu następuje co 7 dni od daty rozpoczęcia planu stawek dewelopera. |
|
Opłata cykliczna i resetowanie pakietu następuje co X dni od daty rozpoczęcia planu cenowego dewelopera. |
|
Plany pakietowe są resetowane na podstawie kryterium agregacji zdefiniowanego w cenniku. Jeśli na przykład deweloper rozpocznie korzystanie z planu taryfowego 19 dnia miesiąca, a podstawą agregacji jest 1 miesiąc, wykorzystanie pakietu będzie resetowane co miesiąc 19 dnia. Pamiętaj, że dzień miesiąca może nie zawsze być taki sam. Jeśli na przykład plan taryfowy rozpoczyna się 31 grudnia, data resetowania w lutym w roku nieprzestępnym przypada na 28 dzień tego miesiąca, ponieważ luty ma tylko 28 dni. 28 dzień miesiąca pozostanie dniem resetowania na zawsze. |
Konfigurowanie planów arkusza stawek za pomocą interfejsu
Skonfiguruj abonamenty w arkuszu stawek zgodnie z opisem poniżej.
Edge
Aby skonfigurować plan arkusza stawek, podczas tworzenia lub edytowania planu stawek wybierz typ planu stawek Arkusz stawek lub Arkusz stawek i udział w przychodach, a w sekcji Arkusz stawek wybierz jeden z tych modeli naliczania opłat:
| Model ładowania | Opis |
| Stała opłata | Deweloper płaci stałą stawkę za każdą transakcję. |
| Wolumin z zakresami | Deweloper płaci stawkę zmienną w zależności od liczby transakcji. |
| Pakiety | Deweloper płaci z góry określoną kwotę za każdy pakiet transakcji. Deweloper płaci ustaloną kwotę niezależnie od tego, czy pakiet zostanie w pełni wykorzystany.
Uwaga: ta opcja nie jest dostępna, gdy wybierzesz opcję Cennik i udział w przychodach. |
Następnie skonfiguruj poniższe informacje na podstawie wybranego modelu rozliczeń.
| Model ładowania | Pole | Opis |
| Wszystkie | 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). |
| Stała opłata | Płaska stawka | Stawka pobierana za każdą transakcję. Wpisz liczbę dziesiętną (z maksymalnie 4 miejscami po przecinku).
Uwaga: liczbę miejsc po przecinku, które można określić w przypadku naliczanej stawki, możesz skonfigurować za pomocą interfejsu API (nie interfejsu). Więcej informacji znajdziesz w artykule Konfigurowanie liczby miejsc dziesiętnych w przypadku stawek planu cenowego. Jeśli np. wpiszesz 0,10, a walutą są dolary amerykańskie, deweloper będzie obciążany kwotą 0,10 USD za każdą transakcję (lub jeśli opłata jest naliczana na podstawie atrybutu niestandardowego, np. liczby bajtów przesłanych w transakcji, deweloper będzie obciążany kwotą 0,10 USD za przesłanie określonej liczby bajtów). |
| Wolumin z zakresami | Pasma wolumenu | Co najmniej jeden zakres wolumenu transakcji (lub wolumenu opartego na atrybutach klienta) (każdy zakres to „przedział wolumenu”) w przypadku modelu opłat opartego na przedziałach wolumenu. Każdemu przedziałowi wolumenu można przypisać stawkę. Stawka jest stosowana do wszystkich transakcji w odpowiednim przedziale wolumenu. Określ górny limit pierwszego zakresu, np. do 1000 zł (dolny limit jest wstępnie ustawiony na wartość większą niż 0).
Aby dodać kolejne pasma, kliknij + Nowe. Pozostaw górny limit ostatniego przedziału pusty, aby wskazać wszystkie transakcje powyżej tego poziomu. Uwaga: liczbę miejsc po przecinku, które można określić w przypadku naliczanej stawki, możesz skonfigurować za pomocą interfejsu API (nie interfejsu). Więcej informacji znajdziesz w artykule Konfigurowanie liczby miejsc dziesiętnych w przypadku stawek planu cenowego. Jeśli na przykład w sekcji „Zakres wolumenu” określisz 2 zakresy wolumenu (>0–1000 i 1000 i więcej), możesz wpisać 0,15 dla zakresu wolumenu >0–1000 i 0,10 dla zakresu wolumenu 1000 i więcej. Jeśli wybraną walutą są dolary amerykańskie, stawka za pierwsze 1000 transakcji wynosi 0,15 USD za transakcję, a za ponad 1000 transakcji – 0,10 USD za transakcję. |
| Pakiety | Ceny pakietów interfejsów API | Liczba transakcji w pakiecie (lub liczba związana z atrybutem niestandardowym, np. łączna liczba bajtów przesłanych w pakiecie). Każdemu pakietowi można przypisać cenę. Cena dotyczy całego pakietu. Określ górny limit pierwszego pakietu, np. do 1000 (dolny limit jest ustawiony wstępnie na wartość większą niż 0).
Aby dodać kolejne pakiety, kliknij + Nowy. W przypadku ostatniego pakietu musisz określić górny limit, chyba że chcesz pobierać od dewelopera stałą kwotę za nieograniczoną liczbę transakcji w tym pakiecie. Uwaga: liczbę miejsc po przecinku, które można określić w przypadku naliczanej stawki, możesz skonfigurować za pomocą interfejsu API (nie interfejsu). Więcej informacji znajdziesz w artykule Konfigurowanie liczby miejsc dziesiętnych w przypadku stawek planu cenowego. Jeśli np. w sekcji Rozmiar pakietu określisz 2 pakiety (większy niż 0 – do 1000 i większy niż 1000 – do 2000), możesz wpisać 50 w przypadku pakietu większego niż 0 – do 1000 i 40 w przypadku pakietu większego niż 1000 – do 2000. Jeśli wybraną walutą są dolary amerykańskie, cena pierwszego pakietu wynosi 50 USD, a drugiego – 40 USD. Deweloper płaci obowiązującą cenę pakietu niezależnie od tego, ile transakcji wykorzysta w ramach pakietu (tzn. deweloper płaci cenę pakietu, gdy tylko zostanie zrealizowana pierwsza transakcja w pakiecie). |
Jeśli zdefiniowano atrybuty niestandardowe dla produktu API, możesz skonfigurować niestandardowy parametr oceny, aby obciążać dewelopera aplikacji na podstawie atrybutu niestandardowego w ramach każdej transakcji. Jeśli na przykład skonfigurujesz plan, w którym obciążasz dewelopera opłatą za każdą transakcję, możesz ustawić stawkę dla tego planu na podstawie atrybutu niestandardowego, np. liczby bajtów przesyłanych na backendzie, która może się różnić w zależności od transakcji.
W takim przypadku kliknij Użyj niestandardowego parametru oceny i wybierz z listy atrybut niestandardowy. Więcej informacji znajdziesz w artykule Konfigurowanie planu cenowego z atrybutami niestandardowymi.
Classic Edge (chmura prywatna)
Aby skonfigurować plany cennika za pomocą klasycznego interfejsu Edge:
- Postępuj zgodnie z instrukcjami tworzenia planu cenowego.
- W menu „Typ planu cenowego” wybierz Cennik, aby skonfigurować model przychodów.
- Jeśli wybrany pakiet interfejsów API zawiera wiele produktów interfejsu API, wybierz jedną z tych opcji:
Uwaga: jeśli pakiet API zawiera jeden produkt API, możesz pominąć ten krok.
- Plany dotyczące konkretnych usług, aby skonfigurować szczegóły planu taryfowego dla każdej usługi API z osobna.
- Ogólny plan dla wszystkich usług, aby skonfigurować szczegóły planu taryfowego dla wszystkich usług API.
- Kliknij Cennik w przypadku ogólnego planu taryfowego lub każdego planu taryfowego dotyczącego konkretnej usługi API.
Uwaga: podczas konfigurowania planów dotyczących konkretnych usług API musisz skonfigurować plan cennika dla każdej usługi API z osobna.

Otworzy się okno Arkusz stawek.

- Skonfiguruj plan freemium dla usługi API. Plan freemium oferuje deweloperom bezpłatne korzystanie z usługi API przez określony czas lub w określonym zakresie.
Podaj te informacje:
Pole Opis Produkt freemium? Zakres bezpłatnego okresu. Wybierz jeden z tych przycisków:
- Według ilości. Okres bezpłatny jest określany na podstawie ilości podanej w polu Volume (Ilość).
- według czasu trwania, Okres opłaty jest oparty na przedziale czasu określonym w polu Freemium Duration (Okres Freemium).
- w zależności od tego, co nastąpi wcześniej. Okres bezpłatny kończy się po osiągnięciu ilości w polu Objętość lub interwału czasowego w polu Czas trwania freemium (w zależności od tego, co nastąpi wcześniej).
- Nie. To nie jest abonament freemium. Jest to ustawienie domyślne.
Freemium Volume Liczba transakcji (lub liczba dotycząca atrybutu niestandardowego zarejestrowanego w zasadach rejestrowania transakcji), za które deweloperzy nie ponoszą opłat. Wielkość jest mierzona w przypadku usługi API. Wpisz numer woluminu, np. 5000. Oznacza to, że gdy deweloperzy rozpoczną korzystanie z abonamentu, nie zostaną obciążeni opłatą za pierwsze 5000 transakcji (ani za pierwsze 5000 użyć elementu związanego z atrybutem niestandardowym). To pole jest dostępne tylko wtedy, gdy w polu „Produkt freemium?” wybierzesz opcję „Według ilości” lub „W zależności od tego, co nastąpi pierwsze”.
Czas trwania wersji freemium Przedział czasu, w którym deweloperzy nie są obciążani opłatami. Wpisz liczbę i wybierz okres, np. 1 miesiąc. Oznacza to, że deweloperzy nie ponoszą opłat przez 1 miesiąc. To pole jest włączone tylko wtedy, gdy w polu „Produkt freemium?” wybierzesz opcję „Według czasu trwania” lub „W zależności od tego, co nastąpi pierwsze”.
- Wybierz jeden z tych modeli ładowania:
- Stała opłata. W tym modelu deweloper płaci stałą stawkę za każdą transakcję.
- Głośność z pałąkiem. W tym modelu deweloper płaci stawkę zmienną w zależności od liczby transakcji.
- pakiety, W tym modelu deweloper płaci z góry określoną kwotę za każdy pakiet transakcji. Deweloper płaci ustaloną kwotę niezależnie od tego, czy pakiet zostanie w całości wykorzystany.
W przypadku modelu stawek stałych: w sekcji Ceny w oknie Ogólny arkusz stawek 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 działa Twoja organizacja. To pole jest wstępnie wypełnione wartością pola Kraj w profilu organizacji.
Stała opłata Stawka pobierana za każdą transakcję. Wpisz liczbę dziesiętną (z maksymalnie 4 miejscami po przecinku).
Uwaga: liczbę miejsc po przecinku, które można określić w przypadku naliczanej stawki, możesz skonfigurować za pomocą interfejsu API (nie interfejsu). Więcej informacji znajdziesz w sekcji Konfigurowanie liczby miejsc dziesiętnych w przypadku stawek w ramach planu cenowego.
Jeśli na przykład wpiszesz 0,10, a walutą są dolary amerykańskie, deweloper zostanie obciążony kwotą 0,10 USD za każdą transakcję (lub jeśli opłata jest naliczana na podstawie atrybutu niestandardowego, np. liczby bajtów przesłanych w transakcji, deweloper zostanie obciążony kwotą 0,10 USD za przesłanie określonej liczby bajtów).
W przypadku modelu opartego na przedziałach wolumenu: w oknie Ogólny cennik wyświetlają się dodatkowe pola, w których możesz określić podstawę agregacji i „przedziały wolumenu”, czyli zakresy wolumenu transakcji, dla których możesz zastosować różne stawki.
Ten typ planu jest zwykle skonfigurowany tak, aby zachęcać deweloperów do generowania większych wolumenów przez oferowanie zniżonych stawek w przypadku wyższych przedziałów wolumenu.

W oknie Ogólny arkusz stawek wpisz te informacje:
Pole Opis Podstawa agregacji Okres, w którym agregowana jest liczba transakcji (lub liczba powiązana z atrybutem niestandardowym). Zagregowana liczba transakcji służy do określania przedziału liczby transakcji i stawki, którą należy zastosować do każdej transakcji. Wybierz liczbę miesięcy (1–12).
Szczegółowe informacje o tym, kiedy pakiety są resetowane, znajdziesz w artykule Kiedy są naliczane opłaty cykliczne i resetowane pakiety?
Pasma głośności Jeden lub więcej zakresów wolumenu transakcji (lub wolumenu opartego na atrybutach klienta) (każdy zakres to „przedział wolumenu”). Każdemu przedziałowi ilościowemu można przypisać stawkę (ustawiasz ją w polu Przedziały ilościowe w sekcji Ceny). Stawka jest stosowana do wszystkich transakcji w odpowiednim przedziale wolumenu. Określ górny limit pierwszego przedziału, np. do 1000 zł (dolny limit jest wstępnie ustawiony na wartość większą niż 0). Aby dodać drugi zakres, np. większy niż 1000 – do 2000, kliknij +. Kliknij +, aby dodać więcej pasm. Możesz pozostawić górny limit ostatniego przedziału pusty, aby wskazać wszystkie transakcje powyżej tego poziomu.

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 działa Twoja organizacja. To pole jest wstępnie wypełnione wartością pola Kraj w profilu organizacji.
Waluta „Podstawowa” lub księgowa waluta używana przez Twoją organizację. To pole jest wstępnie wypełnione wartością pola Waluta w profilu organizacji, ale można je tutaj zmienić.
Pasma wolumenu Stawka dla przedziału ilościowego. Określasz stawkę dla każdego przedziału woluminu. Wpisz liczbę dziesiętną dla każdego pasma (z maksymalnie 4 miejscami po przecinku).
Uwaga: liczbę miejsc po przecinku, które można określić w przypadku stawki za przedział wolumenu, możesz skonfigurować za pomocą interfejsu API (nie interfejsu). Więcej informacji znajdziesz w sekcji Konfigurowanie liczby miejsc dziesiętnych w przypadku stawek w ramach planu cenowego.
Jeśli na przykład w sekcji „Zakres wolumenu” określisz 2 zakresy wolumenu (>0–1000 i 1000 i więcej), możesz wpisać 0,15 dla zakresu wolumenu >0–1000 i 0,10 dla zakresu wolumenu 1000 i więcej. Jeśli wybraną walutą są dolary amerykańskie, stawka za pierwsze 1000 transakcji wynosi 0,15 USD za transakcję, a za ponad 1000 transakcji – 0,10 USD za transakcję.

W przypadku modelu pakietowego: w oknie Ogólna karta stawek wyświetlane są dodatkowe pola, które służą do określania podstawy agregacji (okresu, w którym deweloper może korzystać z pakietu transakcji) oraz informacji związanych z pakietem, takich jak jego rozmiar.

W oknie Ogólny arkusz stawek wpisz te informacje:
Pole Opis Podstawa agregacji Okres, w którym deweloper może używać pakietu transakcji (lub pakietu niestandardowego opartego na atrybutach). Wybierz liczbę miesięcy (od 1 do 12). Po tym okresie subskrypcja wygasa i deweloper musi ponownie kupić subskrypcję (i pakiety).
Szczegółowe informacje o tym, kiedy pakiety są resetowane, znajdziesz w artykule Kiedy są naliczane opłaty cykliczne i resetowane pakiety?
Rozmiar pakietu Liczba transakcji w pakiecie (lub liczba powiązana z atrybutem niestandardowym, np. łączna liczba bajtów przesłanych w pakiecie). Każdemu pakietowi można przypisać cenę (ustawiasz ją w polu Rozmiar pakietu w sekcji Ceny). Cena dotyczy całego pakietu. Określ górny limit pierwszego pakietu, np. do 1000 (dolny limit jest ustawiony wstępnie na wartość większą niż 0). Kliknij +, aby dodać drugi pakiet, np. większy niż 1000 zł i nie większy niż 2000 zł. Kliknij +, aby dodać więcej pakietów. W przypadku ostatniego pakietu musisz określić górny limit, chyba że chcesz pobierać od dewelopera stałą kwotę za nieograniczoną liczbę transakcji w tym pakiecie.

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 działa Twoja organizacja. To pole jest wstępnie wypełnione wartością pola Kraj w profilu organizacji.
Waluta „Podstawowa” lub księgowa waluta używana przez Twoją organizację. To pole jest wstępnie wypełnione wartością pola Waluta w profilu organizacji, ale można je tutaj zmienić.
Rozmiar pakietu (cena) Cena pakietu. Dla każdego pakietu określasz cenę. Wpisz liczbę dziesiętną (z maksymalnie 4 miejscami po przecinku).
Uwaga: liczbę miejsc po przecinku, które można określić w przypadku stawki za pakiet, możesz skonfigurować za pomocą interfejsu API (nie interfejsu). Więcej informacji znajdziesz w sekcji Konfigurowanie liczby miejsc dziesiętnych w przypadku stawek w ramach planu cenowego.
Jeśli np. w sekcji Rozmiar pakietu określisz 2 pakiety (większy niż 0 – do 1000 i większy niż 1000 – do 2000), możesz wpisać 50 w przypadku pakietu większego niż 0 – do 1000 i 40 w przypadku pakietu większego niż 1000 – do 2000. Jeśli wybraną walutą są dolary amerykańskie, cena pierwszego pakietu wynosi 50 USD, a drugiego – 40 USD. Deweloperowi zostanie naliczona odpowiednia cena pakietu niezależnie od tego, ile transakcji wykorzysta w ramach pakietu (czyli deweloperowi zostanie naliczona cena pakietu, gdy tylko pierwsza transakcja w pakiecie zostanie zrealizowana).

- Kliknij Zastosuj i zamknij, aby zapisać szczegóły cennika i wrócić do okna Standardowy plan cenowy.
- W przypadku planów taryfowych dotyczących konkretnych usług API skonfiguruj szczegóły planu taryfowego dla dodatkowych usług API, jeśli jest to wymagane.
Konfigurowanie planu cennika za pomocą interfejsu API
Skonfiguruj szczegóły planu cennika za pomocą interfejsu API zgodnie z opisem w sekcjach poniżej.
Określanie szczegółów planu cennika za pomocą interfejsu API
Podczas tworzenia planu cenowego określasz szczegóły planu cennika. 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 rozliczeń: stałej opłaty, przedziałów ilościowych lub pakietów.
Określanie modelu ładowania z opłatą stałą
Aby wdrożyć model opłat stałych, w szczegółach planu cenowego musisz określić te wartości:
- Parametr oceny, który wskazuje, że plan cenowy jest oparty na transakcjach (
VOLUME) lub na atrybucie niestandardowym (np.MINT_CUSTOM_ATTRIBUTE_1). Domyślną wartością jestVOLUME. - Rodzaj pomiaru (
UNIT) wskazujący, że stawka jest stała za jednostkę (tzn. nie zależy od liczby transakcji, jak w przypadku modelu rozliczeń opartego na przedziałach ilościowych lub pakietach). - Okres płatności (np. 30 dni).
- Identyfikator organizacji.
- „Podstawowa” lub księgowa waluta używana przez Twoją firmę.
- Stawka planu taryfowego, która zawiera szczegółowe informacje o sposobie obliczania stawki. Ponieważ model rozliczeń opiera się na stałej stawce, określasz tylko jedną stawkę planu taryfowego.
W cenie pakietu cenowego określasz:
- Typ stawki abonamentu (
RATECARD). - Cena abonamentu. Jeśli np. podasz wartość 0,10, a walutą są dolary amerykańskie, deweloper zostanie obciążony kwotą 0,10 USD za każdą transakcję (lub jeśli opłata jest naliczana na podstawie atrybutu niestandardowego, np. liczby bajtów przesłanych w transakcji, deweloper zostanie obciążony kwotą 0,10 USD za przesłanie określonej liczby bajtów).
- Jednostka początkowa zastosowania stawki (
0). Oznacza to, że stawka jest stosowana do każdej transakcji, począwszy od pierwszej.
Pełną listę opcji szczegółów planu cenowego znajdziesz w artykule Ustawienia konfiguracji szczegółów planu cenowego.
Na przykład ten kod tworzy plan arkusza stawek ze stałym modelem naliczania opłat. Stawka wynosi 0,10 USD za każdą transakcję. Płatność jest należna w ciągu 30 dni. (Szczegóły związane z arkuszem stawek są wyróżnione).
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"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": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"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" \
-u email:password
Określanie modelu ładowania opartego na przedziałach woluminów
W modelu z przedziałami ilościowymi określasz szczegóły planu cenowego, które obejmują co najmniej 1 stawkę planu cenowego. Każda stawka dotyczy „przedziału ilościowego”, czyli zakresu ilości transakcji (lub zakresu opartego na atrybucie niestandardowym, np. liczbie przesyłanych bajtów). Ten typ planu jest zwykle skonfigurowany tak, aby zachęcać deweloperów do generowania większych wolumenów przez oferowanie zniżek w przypadku większych zakresów wolumenów.
Oprócz stawek abonamentu w szczegółach abonamentu określasz te informacje:
- Parametr oceny, który wskazuje, że plan cenowy jest oparty na transakcjach (
VOLUME) lub na atrybucie niestandardowym (np.CUSTOM_ATTRIBUTE_1). Domyślną wartością jestVOLUME. - Typ pomiaru (
VOLUME), który wskazuje, że stawka jest oparta na liczbie transakcji (czyli nie jest stałą stawką za transakcję, jak w przypadku modelu rozliczeń ze stałą stawką). - Okres płatności (np. 30 dni).
- Identyfikator organizacji.
- „Podstawowa” lub księgowa waluta używana przez Twoją firmę.
- Czas trwania i typ czasu trwania, które razem określają okres, w którym agregowana jest liczba transakcji (lub liczba powiązana z atrybutem niestandardowym). Jest to też nazywane „podstawą agregacji”. Liczba transakcji jest sumowana na podstawie okresu agregacji (np. 1 miesiąca), aby określić odpowiedni przedział liczby transakcji.
- Liczniki agregacji, które służą do określania odpowiedniego przedziału wolumenu.
W przypadku każdej stawki w ramach planu cenowego określasz:
- Typ stawki abonamentu (
RATECARD). - Cena abonamentu. Jeśli na przykład podasz wartość 0,10, a walutą są dolary amerykańskie, deweloper zostanie obciążony kwotą 0,15 USD za każdą transakcję (lub jeśli opłata jest naliczana na podstawie atrybutu niestandardowego, np. liczby bajtów przesłanych w transakcji, deweloper zostanie obciążony kwotą 0,15 USD za przesłanie określonej liczby bajtów).
- Jednostka początkowa i końcowa pasma głośności. Jednostka początkowa określa dolny limit zakresu woluminu, a jednostka końcowa – górny limit zakresu woluminu. Jeśli na przykład określisz jednostkę początkową jako 0, a jednostkę końcową jako 1000, pasmo wolumenu obejmie do 1000 transakcji w okresie agregacji. Jeśli walutą są dolary amerykańskie, okres agregacji wynosi 1 miesiąc, a stawka za pierwsze 1000 transakcji to 0,15, deweloper płaci 0,15 USD za transakcję w przypadku maksymalnie 1000 transakcji w miesiącu.
Szczegółowe informacje o tym, kiedy pakiety są resetowane, znajdziesz w artykule Kiedy pobierane są opłaty cykliczne i resetowane pakiety?
Jeśli nie określisz jednostki końcowej dla ostatniego przedziału wolumenu, stawka dla tego przedziału będzie stosowana do wszystkich transakcji po przekroczeniu jednostki początkowej dla tego przedziału. Jeśli np. jednostka początkowa ostatniego przedziału to 1000, a nie określisz jednostki końcowej dla tego przedziału, stawka dla tego przedziału będzie stosowana do wszystkich transakcji po 1000 transakcji w okresie agregacji.
Pełną listę opcji szczegółów planu cenowego znajdziesz w artykule Ustawienia konfiguracji szczegółów planu cenowego.
Na przykład poniższy kod tworzy abonament z arkuszem stawek i modelem rozliczeń opartym na przedziałach ilościowych. W przypadku pierwszych 1000 transakcji stawka wynosi 0,15 USD, a w przypadku wszystkich transakcji powyżej 1000 – 0,10 USD. Podstawą agregacji jest 1 miesiąc. Płatność jest należna w ciągu 30 dni. (Szczegóły arkusza stawek są wyróżnione).
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Volume banded rate card plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Volume banded rate card plan",
"displayName" : "Volume banded rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.15",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "1000"
}
],
"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" \
-u email:password
Określanie modelu ładowania w pakiecie
W modelu opłat pakietowych deweloper płaci (z góry) za „pakiet” transakcji (lub za pakiet oparty na atrybucie niestandardowym, takim jak liczba przesłanych bajtów). Określasz stawkę za każdy pakiet i podstawę agregacji, czyli okres, w którym deweloper może korzystać z pakietu.
Załóżmy na przykład, że masz 2 pakiety, z których pierwszy obejmuje od 1 do 1000 transakcji, a drugi od 1001 do 2000 transakcji. Stawka wynosi 50 USD za pierwszy pakiet i 40 USD za drugi, a podstawą agregacji jest 1. Jeśli deweloper kupi plan cennikowy dla pierwszego pakietu, zapłaci 50 USD (z góry) za 1000 transakcji w miesiącu. Deweloper płaci ustaloną kwotę niezależnie od tego, czy pakiet zostanie w całości wykorzystany. Po zakończeniu okresu agregacji subskrypcja wygasa. Jeśli deweloper chce ponownie użyć pakietu, musi ponownie kupić abonament (i pakiet).
Informacje podane w szczegółach abonamentu są zasadniczo takie same jak te podane w szczegółach abonamentu w przypadku modelu rozliczeń opartego na przedziałach ilościowych. Różnice są następujące:
- Każdy określony przez Ciebie plan cenowy dotyczy pakietu (a nie przedziału woluminu).
- W przypadku ostatniego pakietu musisz określić górny limit, chyba że chcesz pobierać od dewelopera stałą kwotę za nieograniczoną liczbę transakcji w tym pakiecie.
Pełną listę opcji szczegółów planu cenowego znajdziesz w artykule Ustawienia konfiguracji szczegółów planu cenowego.
Na przykład ten kod tworzy plan arkusza stawek z modelem rozliczeniowym z pakietem. Cena pierwszego pakietu (do 1000 transakcji) wynosi 50 USD, a drugiego (ponad 1000 transakcji, ale nie więcej niż 2000) – 40 USD. Podstawą agregacji jest 1 miesiąc. Płatność jest należna w ciągu 30 dni.
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Bundled rate plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Bundled rate plan",
"displayName" : "Bundled rate plan",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "true",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "STAIR_STEP",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "50",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "40",
"startUnit": "1000",
"endUnit": "2000"
}
],
"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" \
-u email:password
Określanie planu freemium dla poszczególnych produktów za pomocą interfejsu API
W ramach planu cennika możesz skonfigurować plan freemium dla poszczególnych usług (zamiast dla pakietu interfejsów API). Plan freemium oferuje deweloperom bezpłatne korzystanie z usługi API przez określony czas lub w określonym zakresie.
Gdy konfigurujesz plan freemium dla usługi API, w szczegółach planu taryfowego określasz okres, w którym deweloper może bezpłatnie korzystać z zasobów udostępnianych przez usługę API. Okres może być oparty na jednym z tych kryteriów:
- okres obowiązywania, czyli czas między datą wejścia w życie a datą zakończenia;
- Ilość, np. liczba transakcji z użyciem usługi API lub wielkość związana z atrybutem niestandardowym zarejestrowanym w polityce rejestrowania transakcji.
Jeśli okres freemium jest oparty na ilości, podaj go jako liczbę jednostek freemium. Na przykład poniższy kod tworzy abonament z cennikiem, który zawiera abonament freemium oparty na wolumenie 5000 jednostek (specyfikacje związane z abonamentem freemium są wyróżnione).
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan with freemium period",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan with freemium period",
"displayName" : "Flat rate card plan with freemium period",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "myorg"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "false",
"ratePlanDetails": [
{
"currency": {
"aggregateFreemiumCounters" : true,
"aggregateStandardCounters" : true,
"id" : "usd"
},
"product" : {
"id" : "location",
"displayName":"Location"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "myorg"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "0"
}
],
"freemiumUnit": "5000",
"freemiumDuration": "0",
"freemiumDurationType": "DAY",
"ratingParameterUnit":"MB",
"customPaymentTerm": "false",
"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" \
-u email:password