Skonfiguruj plan arkusza stawek

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

W przypadku abonamentu w arkuszu stawek deweloper jest obciążany za każdą transakcję. W przypadku tego typu abonamentu musisz podać dodatkowe informacje, takie jak model i ceny modelu naliczania opłat.

Opcjonalnie możesz określić abonament freemium dla poszczególnych produktów (a nie dla pakietu interfejsów API) – możesz to zrobić tylko w przypadku abonamentu związanego z konkretną usługą.

Kiedy pobierane są opłaty cykliczne i pakiety abonamentowe są resetowane?

Abonamenty mogą obejmować opłaty cykliczne, a także pakiety interfejsów API (związane z ilością woluminu i abonamenty w pakiecie). Oba te abonamenty określają konkretne godziny naliczania opłat, a abonamenty są resetowane do zera. Z tabeli poniżej dowiesz się, kiedy są naliczane opłaty cykliczne i resetowana jest liczba pakietów. Jeśli aplikacje dewelopera nie mogą wykonywać kolejnych wywołań interfejsu API z powodu osiągnięcia określonego limitu transakcji, w takich przypadkach liczniki wywołań interfejsu API są resetowane, a aplikacje mogą ponownie wykonywać wywołania.

Jeśli plan obejmuje...	...tak się dzieje
niezerową opłatę cykliczną ustawioną na Miesiąc, Abonament w opasach lub pakietach woluminowych	Opłata cykliczna i reset pakietu są resetowane pierwszego dnia miesiąca (domyślnie). Aby powtarzać się co miesiąc w określonym dniu, utwórz plan stawek za pomocą interfejsu Management API i wskaż dzień za pomocą właściwości RecurringStartUnit zgodnie z opisem w sekcji Tworzenie planów stawek przy użyciu interfejsu API.
niezerową opłatę cykliczną ustawioną na Tydzień, Abonament w opasach lub pakietach woluminowych	Opłata cykliczna i reset pakietu następuje co 7 dni po dacie rozpoczęcia abonamentu dewelopera.
niezerową opłatę cykliczną ustawioną na Dzień, Abonament w opasach lub pakietach woluminowych	Opłata cykliczna i abonament na pakiet są resetowane co X dni po dacie rozpoczęcia abonamentu dewelopera.
Bez opłaty cyklicznej w wysokości 0 dolarów Abonament w opasach lub pakietach woluminowych	Abonamenty są resetowane na podstawie podstawy agregacji zdefiniowanej w arkuszu stawek. Jeśli na przykład deweloper rozpocznie plan stawek 19 dnia miesiąca, a podstawa agregacji wynosi co 1 miesiąc, wykorzystanie pakietu zostanie zresetowane co miesiąc 19 dnia miesiąca. Pamiętaj, że dzień miesiąca nie zawsze będzie taki sam. Jeśli na przykład abonament zaczyna się 31 grudnia, datą resetowania będzie 28 lutego w roku nieprzestępnym, ponieważ w lutym jest tylko 28 dni. Dzień 28 jest wciąż dniem resetowania.

Konfigurowanie planów arkusza stawek za pomocą interfejsu użytkownika

Skonfiguruj plany arkuszy stawek w sposób opisany poniżej.

Konfigurowanie planu arkusza stawek przy użyciu interfejsu API

Skonfiguruj szczegóły planu w arkuszu stawek przy użyciu interfejsu API w sposób opisany w sekcjach poniżej.

Określanie szczegółów abonamentu arkusza stawek przy użyciu interfejsu API

Szczegóły planu w arkuszu stawek określasz podczas tworzenia planu. 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 ładowania: stała opłata, głośność z pasmami lub pakiety.

Określanie modelu ładowania ze stałą opłatą

Aby wdrożyć model opłat ze stałą opłatą, w szczegółach abonamentu podaj te informacje:

• Parametr oceny, który wskazuje, że plan stawek jest oparty na transakcjach (VOLUME) lub na podstawie atrybutu niestandardowego (np. MINT_CUSTOM_ATTRIBUTE_1). Wartość domyślna to VOLUME.
• Typ pomiaru (UNIT), który wskazuje, że stawka jest stała za jednostkę (czyli nie jest określana na podstawie liczby transakcji, jak w przypadku modelu opłat z uwzględnieniem ilości danych lub opłat zbiorczych).
• Termin płatności (np. 30 dni).
• Identyfikator Twojej organizacji.
• Waluta podstawowa lub księgowa, której używa Twoja firma.
• Stawka w ramach abonamentu, która zawiera szczegółowe informacje o sposobie obliczania stawki. Model opłat opiera się na stałej stawce, więc określasz tylko jedną stawkę abonamentu.

W stawce planu stawek określasz:

• Typ stawki w ramach abonamentu (RATECARD).
• Cena abonamentu. Jeśli na przykład podasz 0,10, a waluta to dolar amerykański, deweloper zostanie obciążony opłatą w wysokości 0,10 USD za każdą transakcję. Jeśli na podstawie atrybutu niestandardowego, takiego jak liczba bajtów przesłanych w transakcji, deweloper zostanie obciążony opłatą w wysokości 0,10 USD za przesłanie określonej liczby bajtów.
• Początkowa jednostka zastosowania stawki (0). Oznacza to, że stawka jest stosowana do każdej transakcji, począwszy od pierwszej transakcji.

Pełną listę opcji szczegółów planu stawek znajdziesz w sekcji Ustawienia konfiguracji szczegółów planu stawek.

Poniżej możesz na przykład utworzyć plan arkusza stawek ze stałym modelem obciążeń. Stawka jest ustalana na 0,10 USD za każdą transakcję. Termin płatności upływa za 30 dni. (wyróżnione są szczegóły arkusza stawek).

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 z użyciem pasma głośności

W modelu z pasmem ilości danych określasz szczegóły abonamentu, które obejmują co najmniej 1 stawkę abonamentu. Każda stawka dotyczy „zakresu ilości”, czyli zakresu liczby transakcji (lub zakresu opartego na atrybucie niestandardowym, takim jak liczba przesłanych bajtów). Abonament tego typu ma zwykle zachęcać deweloperów do generowania większej ilości treści przez oferowanie rabatów w przypadku większych pasm.

Oprócz stawek planu stawek w szczegółach abonamentu podajesz też te informacje:

• Parametr oceny, który wskazuje, że plan stawek jest oparty na transakcjach (VOLUME) lub na podstawie atrybutu niestandardowego (np. CUSTOM_ATTRIBUTE_1). Wartość domyślna to VOLUME.
• Typ pomiaru (VOLUME), który wskazuje, że stawka jest ustalana na podstawie liczby transakcji (czyli nie jest to stała opłata za transakcję, jak w przypadku modelu płatności ze stałą opłatą).
• Termin płatności (np. 30 dni).
• Identyfikator Twojej organizacji.
• Waluta podstawowa lub księgowa, której używa Twoja firma.
• Typ czasu trwania i czasu trwania, które razem określają okres, w którym ma być sumowana liczba transakcji (lub liczba związana z atrybutami niestandardowymi). Nazywamy to też „podstawą agregacji”. Liczba transakcji jest agregowana na podstawie agregacji (np. z 1 miesiąca), aby określić odpowiedni przedział czasowy.
• Liczniki agregacji używane do określania odpowiedniego pasma głośności.

W przypadku każdej stawki w ramach abonamentu określasz te stawki:

• Typ stawki w ramach abonamentu (RATECARD).
• Cena abonamentu. Jeśli na przykład podasz 0,10, a waluta to dolary amerykańskie, deweloper zostanie obciążony opłatą w wysokości 0,15 USD za każdą transakcję (lub jeśli na podstawie atrybutu niestandardowego, takiego jak liczba bajtów przesłanych w transakcji, deweloper zostanie obciążony opłatą w wysokości 0,15 USD za przesłanie określonej liczby bajtów).
• Początkowa i końcowa jednostka pasma głośności. Jednostka początkowa określa dolny limit pasma głośności, a jednostka końcowa – górny limit pasma głośności. Jeśli na przykład określisz jednostkę początkową 0 i jednostkę końcową 1000, zakres ilości obejmuje w okresie agregacji maksymalnie 1000 transakcji. Jeśli walutą jest dolar amerykański, okres agregacji wynosi 1 miesiąc, a stawka pierwszych 1000 transakcji wynosi 0,15, deweloper jest obciążany 0,15 USD za transakcję za maksymalnie 1000 transakcji w miesiącu.
  
  Aby dowiedzieć się, kiedy pakiety są resetowane, przeczytaj sekcję Kiedy pobierane są opłaty cykliczne i abonamenty są resetowane?
  

  Jeśli nie określisz jednostki końcowej zakresu końcowego, stawka dla tego zakresu będzie stosowana do wszystkich transakcji, gdy liczba transakcji przekroczy jednostkę początkową tego zakresu. Jeśli na przykład jednostka początkowa ostatniego zakresu to 1000 i nie określisz jednostki końcowej dla tego zakresu, stawka dla tego zakresu zostanie zastosowana do wszystkich transakcji po przekroczeniu 1000 transakcji w okresie agregacji.

Pełną listę opcji szczegółów planu stawek znajdziesz w sekcji Ustawienia konfiguracji szczegółów planu stawek.

Na przykład wygląda tak: Stawka jest ustalana na 0,15 USD za pierwsze 1000 transakcji i 0,10 USD dla wszystkich transakcji powyżej 1000. Podstawą agregacji jest 1 miesiąc. Termin płatności upływa za 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 w pakiecie deweloper płaci (z góry) za „pakiet” transakcji (lub za pakiet na podstawie atrybutu niestandardowego, takiego jak liczba przesłanych bajtów). Określasz stawkę dla każdego pakietu i podstawy agregacji, czyli okres, w którym deweloper może korzystać z pakietu.

Załóżmy na przykład, że konfigurujesz 2 pakiety, z których pierwszy rozmiar to od 1 do 1000 transakcji, a drugi od 1001 do 2000 transakcji. Stawka wynosi 50 USD za pierwszy pakiet i 40 USD za drugi, przy czym podstawa agregacji wynosi 1. Jeśli deweloper wykupi abonament pierwszego pakietu, płaci z góry 50 USD za 1000 transakcji miesięcznie. Deweloper płaci określoną kwotę niezależnie od tego, czy pakiet zostanie w całości wykorzystany, czy też nie. Po zakończeniu okresu agregacji abonament wygasa. Jeśli deweloper chce ponownie użyć pakietu, musi ponownie go kupić.

To, co określasz w szczegółach abonamentu, jest zasadniczo takie samo jak to, które określasz w szczegółach abonamentu dla modelu opłat z uwzględnieniem ilości. Różnice są następujące:

• Każdy podany przez Ciebie abonament dotyczy pakietu (a nie pasma głośności).
• Musisz określić górny limit ostatniego pakietu, chyba że w ostatnim pakiecie chcesz obciążać dewelopera stałą kwotę za nieograniczone transakcje.

Pełną listę opcji szczegółów planu stawek znajdziesz w sekcji Ustawienia konfiguracji szczegółów planu stawek.

Poniżej możesz na przykład utworzyć plan arkusza stawek ze modelem rozliczeń w pakiecie. Stawka wynosi 50 USD za pierwszy pakiet (do 1000 transakcji), a za drugi 40 USD (ponad 1000 do 2000 transakcji). Podstawą agregacji jest 1 miesiąc. Termin płatności upływa za 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 abonamencie arkusza stawek możesz skonfigurować abonament freemium dla pojedynczego produktu (a nie pakietu API). Abonament freemium umożliwia deweloperom bezpłatne korzystanie z usług interfejsu API przez określony czas lub na podstawie częstotliwości korzystania.

Podczas konfigurowania planu freemium dla usługi API określasz w szczegółach abonamentu w arkuszu stawek okres, w którym deweloper może bezpłatnie korzystać z zasobów udostępnionych przez usługę API. Może on być obliczany na podstawie jednej z tych wartości:

• Czas trwania, czyli czas między datą wejścia w życie a datą zakończenia.
• Ilość, na przykład liczba transakcji związanych z usługą API lub liczba związana z atrybutem niestandardowym zarejestrowanym w zasadach rejestrowania transakcji.

Jeśli okres freemium zależy od ilości, określ go jako liczbę jednostek freemium. Poniższy przykład tworzy plan arkusza stawek z abonamentem freemium opartym na ilości 5000 jednostek (wyróżnione są specyfikacje związane z freemium).

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