Zarządzanie planami stawek

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Zarządzaj planami cenowymi za pomocą interfejsu i interfejsu API zgodnie z opisem w sekcjach poniżej.

Poznawanie strony z planami taryfowymi

Otwórz stronę planów taryfowych, wykonując czynności opisane poniżej.

Tworzenie planu cenowego

Aby utworzyć plan cenowy:

1. Otwórz stronę Plany taryfowe.
2. Kliknij + Plan cenowy.
3. Skonfiguruj te pola w górnym panelu:
   

   Pole	Opis	Domyślny	Wymagane
   Nazwa planu taryfowego	Nazwa planu taryfowego. NOTE nazwa musi być unikalna w obrębie pakietu produktów interfejsu API. Dwa plany w tym samym pakiecie produktów nie mogą mieć tej samej nazwy.	Nie dotyczy	Tak
   Typ planu taryfowego	Typ planu taryfowego. Wybierz wartość z listy. Listę prawidłowych typów planów cenowych znajdziesz w artykule Obsługiwane typy planów cenowych.	Nie dotyczy	Tak
   Pakiet produktów	Pakiet usług API. Wybierz wartość z listy. Więcej informacji o pakietach produktów API znajdziesz w artykule Zarządzanie pakietami produktów API. Jeśli wybierzesz pakiet usług zawierający więcej niż 1 usługę API, musisz określić, czy chcesz skonfigurować indywidualne plany taryfowe dla każdej usługi API, czy ogólny plan taryfowy, który będzie obowiązywać w przypadku wszystkich usług API.	Nie dotyczy	Tak
   Odbiorcy	Odbiorcy, którzy mogą korzystać z abonamentu. Z menu wybierz jedną z tych wartości: Wszyscy – wszyscy deweloperzy. Deweloper – deweloper lub firma. Wpisz nazwę dewelopera lub firmy. Podczas wpisywania na liście rozwijanej będą się pojawiać nazwy deweloperów lub firm zawierające wpisany ciąg znaków. Kliknij nazwę dewelopera lub firmy na liście. Kategoria dewelopera – kategoria dewelopera. Wybierz kategorię dewelopera z listy. Skonfiguruj kategorie deweloperów zgodnie z potrzebami, jak opisano w artykule Zarządzanie kategoriami deweloperów.	Wszyscy	Nie
   Data rozpoczęcia	Data wejścia w życie planu taryfowego. Wpisz datę rozpoczęcia lub wybierz ją w kalendarzu.	Dzisiaj	Nie
   Data zakończenia	Data zakończenia planu cenowego. Aby określić datę zakończenia, włącz przełącznik Ma datę zakończenia i wpisz datę zakończenia lub wybierz ją w kalendarzu. UWAGA: plan taryfowy będzie obowiązywać do końca dnia w określonej dacie. Jeśli na przykład chcesz, aby plan cenowy wygasł 1 grudnia 2018 r., ustaw wartość endDate na 2018-11-30. W takim przypadku abonament wygaśnie 30 listopada 2018 r. o północy, a wszystkie żądania z 1 grudnia 2018 r. zostaną zablokowane.	Brak	Nie
   Widoczne dla portali	Określ, czy abonament jest publiczny czy prywatny. Zobacz Publiczne i prywatne abonamenty.	Włączono	Nie

4. Skonfiguruj opłaty za plan cenowy. Zobacz Konfigurowanie opłat dla planu cenowego.
   NOTE nie dotyczy planów powiadomień z możliwością dostosowania.
5. Jeśli wybierzesz pakiet produktów zawierający więcej niż 1 produkt API, w sekcji Konkretny lub ogólny plan cenowy ustaw te preferencje:
   UWAGA: ten krok nie dotyczy planów powiadomień z możliwością dostosowania.
   

   Pole	Opis	Domyślny
   Konfigurowanie każdego produktu osobno	Flaga określająca, czy dla każdej usługi API ma być skonfigurowany indywidualny plan taryfowy.	Wyłączono
   Skonfiguruj ofertę freemium dla każdego produktu osobno	Flaga określająca, czy dla każdej usługi API ma być skonfigurowany plan freemium.	Wyłączono
   Wybierz produkt	Jeśli włączysz co najmniej 1 z tych flag, musisz wybrać każdy produkt z listy i skonfigurować szczegóły planu cenowego. NOTE upewnij się, że konfigurujesz wszystkie produkty w zestawie produktów.	Nie dotyczy

6. Skonfiguruj szczegóły planu cenowego na podstawie wybranego typu planu cenowego:
   
   • Freemium
   • Cennik
   • Udział w przychodach
   • Powiadomienie z możliwością dostosowania
7. Kliknij jedną z tych opcji:
   

   Przycisk	Opis
   Zapisz jako wersję roboczą	Zapisz plan cenowy jako wersję roboczą. Plan cenowy nie będzie widoczny dla deweloperów aplikacji, dopóki go nie opublikujesz. Możesz edytować dowolne pole w wersji roboczej pakietu cenowego.
   Opublikuj nowy plan	Opublikuj plan. NOTE po opublikowaniu planu cenowego możesz zmienić tylko datę zakończenia, jeśli nie została jeszcze ustawiona. Po opublikowaniu planu taryfowego nie można go usunąć, ale można go wycofać i zastąpić przyszłym planem taryfowym, jak opisano w artykule Wycofywanie opublikowanego planu taryfowego.

8. Dołącz zasadę Monetization Limits Check do proxy interfejsów API powiązanych z usługami API uwzględnionymi w planie taryfowym. Zasady sprawdzania limitów zarabiania wymuszają limity zarabiania w przypadku serwerów proxy interfejsu API i zapewniają, że wszelkie błędy są dokładnie rejestrowane w raportach analitycznych i raportach dotyczących zarabiania. Więcej informacji znajdziesz w artykule o egzekwowaniu limitów zarabiania na proxy interfejsu API.

Edytowanie planu cenowego

Możesz edytować wszystkie pola w roboczej wersji planu cenowego z wyjątkiem pakietu produktów, typu i odbiorców. Po opublikowaniu planu cenowego możesz edytować tylko datę zakończenia i tylko wtedy, gdy nie została ona określona.

Aby edytować abonament:

1. Otwórz stronę Plany taryfowe.
2. Kliknij wiersz planu cenowego, który chcesz edytować.
   Wyświetli się panel abonamentu.
3. W razie potrzeby zmień pola planu cenowego.
   NOTE po opublikowaniu planu cenowego możesz zmienić tylko datę zakończenia, jeśli nie została jeszcze ustawiona.
4. Kliknij jedną z tych opcji:

   Przycisk	Opis
   Zaktualizuj wersję roboczą (wersje robocze abonamentów)	Zapisz plan cenowy jako wersję roboczą. Plan cenowy nie będzie widoczny dla deweloperów aplikacji, dopóki go nie opublikujesz. Możesz edytować dowolne pole w wersji roboczej pakietu cenowego.
   Opublikuj wersję roboczą (wersje robocze planów cenowych)	Opublikuj plan taryfowy. NOTE po opublikowaniu planu cenowego możesz zmienić tylko datę zakończenia, jeśli nie została jeszcze ustawiona. Po opublikowaniu planu taryfowego nie można go usunąć, ale można go wycofać i zastąpić przyszłym planem taryfowym, jak opisano w artykule Wycofywanie opublikowanego planu taryfowego.
   Zaktualizowana data zakończenia (opublikowane abonamenty)	Ustaw datę zakończenia opublikowanego planu. NOTE po ustawieniu daty zakończenia opublikowanego planu cenowego nie można jej już zmienić.

Usuwanie wersji roboczej planu taryfowego

Usuń wersję roboczą planu taryfowego, jeśli nie jest już potrzebna.

UWAGA: nie możesz usunąć opublikowanego planu taryfowego.

Aby usunąć wersję roboczą planu taryfowego:

1. Otwórz stronę Plany taryfowe.
2. Umieść kursor nad planem cenowym, który chcesz usunąć, aby wyświetlić menu czynności.
3. Kliknij .
4. Aby potwierdzić czynność, kliknij Usuń.

Zarządzanie planami cenowymi za pomocą interfejsu API

W kolejnych sekcjach opisujemy, jak zarządzać planami cenowymi za pomocą interfejsu API.

Tworzenie planów cenowych za pomocą interfejsu API

Aby utworzyć plan stawek, wyślij żądanie POST na adres /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, gdzie {monetizationpackage_id} to identyfikator pakietu produktów API, dla którego tworzysz plan stawek (identyfikator jest zwracany w odpowiedzi podczas tworzenia pakietu produktów API).

Podczas tworzenia planu cenowego musisz podać w treści żądania te informacje:

• Identyfikator organizacji
• Identyfikator pakietu usług API
• Nazwa planu taryfowego
• Opis planu taryfowego
• Zakres planu stawek (czy dotyczy wszystkich deweloperów, czy tylko konkretnego dewelopera, firmy lub kategorii deweloperów)
• Data wejścia w życie planu cenowego
• Waluta planu taryfowego
• czy opublikować plan taryfowy;
• czy plan cenowy jest publiczny czy prywatny.

Możesz też opcjonalnie określić inne ustawienia, takie jak okres, w którym należy dokonać płatności (np. 30 dni). Zobacz Właściwości konfiguracji planów cenowych.

Jeśli tworzysz plan taryfowy (inny niż plan obejmujący tylko opłaty) dla pakietu usług API, który zawiera więcej niż 1 usługę, możesz zastosować ten plan do konkretnej usługi w pakiecie. W tym celu wskaż produkt w prośbie. Jeśli nie określisz produktu, plan zostanie zastosowany do wszystkich produktów w pakiecie usług API.

W sekcjach poniżej znajdziesz informacje o tym, jak tworzyć plany stawek:

• Tworzenie standardowego planu taryfowego za pomocą interfejsu API
• Tworzenie planu cenowego dla programisty lub firmy za pomocą interfejsu API
• Tworzenie planu taryfowego kategorii deweloperów za pomocą interfejsu API
• Tworzenie planu taryfowego dla konkretnej usługi API za pomocą interfejsu API
• Ustawianie planu taryfowego jako publicznego lub prywatnego za pomocą interfejsu API

Tworzenie standardowego planu cenowego za pomocą interfejsu API

Aby utworzyć standardowy plan cenowy, ustaw atrybut type na STANDARD, jak pokazano w tym przykładzie.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Tworzenie planu stawek dla programisty lub firmy za pomocą interfejsu API

Aby zastosować plan stawek do konkretnego dewelopera lub firmy, ustaw wartość type na Developer. W prośbie musisz też podać identyfikator, imię i nazwisko oraz nazwę dewelopera lub firmy.

Na przykład ten fragment kodu tworzy plan cenowy dla dewelopera Dev Five:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Tworzenie planu cenowego kategorii deweloperów za pomocą interfejsu API

Aby zastosować abonament do kategorii deweloperów, ustaw wartość type na Developer_Category. W prośbie musisz też podać kategorię dewelopera. Na przykład:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

Tworzenie planu taryfowego dla konkretnej usługi API za pomocą interfejsu API

Podczas tworzenia planu taryfowego dla pakietów usług API, które obejmują wiele usług API, możesz określić szczegóły planu taryfowego dla poszczególnych usług API.

Na przykład poniższy kod tworzy plan podziału przychodów z 2 usługami API:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

Aby dodać usługę API do my-package pakietu usług API, musisz dodać szczegóły planu taryfowego usługi API w treści żądania, zgodnie z opisem w artykule Dodawanie usługi API do pakietu usług API z planami taryfowymi specyficznymi dla usługi API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

Ustawianie planu cenowego jako publicznego lub prywatnego za pomocą interfejsu API

Podczas tworzenia abonamentu możesz określić, czy ma być publiczny czy prywatny, używając atrybutu isPrivate w treści żądania. Jeśli ustawisz wartość true, abonament będzie prywatny. Więcej informacji znajdziesz w artykule Publiczne i prywatne abonamenty.

Na przykład ten kod tworzy prywatny plan cenowy:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Publikowanie planu taryfowego za pomocą interfejsu API

Aby opublikować plan cenowy, podczas jego tworzenia ustaw wartość właściwości published na true. Programiści będą mogli wyświetlić plan cenowy od daty określonej we właściwości startDate planu.

Na przykład poniższe polecenie tworzy plan cennika i go publikuje (wyświetlona jest tylko część żądania):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Zapisywanie wersji roboczej planu taryfowego za pomocą interfejsu API

Aby zapisać plan cenowy bez publikowania go, podczas tworzenia planu cenowego ustaw wartość właściwości published na false.

Na przykład poniższe polecenie tworzy plan cennika i zapisuje go jako wersję roboczą (pokazana jest tylko część żądania):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Edytowanie wersji roboczej planu cenowego za pomocą interfejsu API

Aby zaktualizować wersję roboczą planu cenowego, wyślij żądanie PUT na adres /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}, gdzie {package_id} to identyfikator pakietu API, a {plan_Id} to identyfikator planu cenowego. Gdy wprowadzisz zmianę, musisz podać w treści żądania zaktualizowane ustawienia i identyfikator planu cenowego. Jeśli zaktualizujesz stawkę w ramach planu cenowego, musisz też podać identyfikator tej stawki. Na przykład to żądanie aktualizuje stawkę w planie cenowym o identyfikatorze location_flat_rate_card_plan (zaktualizowana część jest wyróżniona):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "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": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "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/location_flat_rate_card_plan" \
-u email:password

Odpowiedź zawiera zaktualizowaną stawkę planu taryfowego (wyświetlana jest tylko część odpowiedzi):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

Wyświetlanie planów cenowych za pomocą interfejsu API

Plany stawek możesz wyświetlać za pomocą interfejsu Monetization API w sposób opisany w kolejnych sekcjach.

• Wyświetlanie wszystkich planów cenowych organizacji za pomocą interfejsu API
• Wyświetlanie wszystkich planów taryfowych dla pakietu usług API za pomocą interfejsu API
• Wyświetlanie planu taryfowego dla pakietu usług API za pomocą interfejsu API
• Wyświetlanie wszystkich aktywnych planów taryfowych dewelopera za pomocą interfejsu API
• Wyświetlanie zaakceptowanego planu taryfowego dla dewelopera za pomocą interfejsu API
• Wyświetlanie zaakceptowanego planu taryfowego dla dewelopera, który zawiera usługę API, za pomocą interfejsu API
• Wyświetlanie wszystkich planów taryfowych akceptowanych przez dewelopera za pomocą interfejsu API

Wyświetlanie wszystkich planów taryfowych organizacji za pomocą interfejsu API

Aby wyświetlić wszystkie plany cenowe organizacji, wyślij żądanie GET do /mint/organizations/{org_name}/rate-plans, gdzie {org_name} to nazwa Twojej organizacji.

Aby filtrować wyniki, możesz przekazywać te parametry zapytania:

Na przykład:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

Wyświetlanie wszystkich planów taryfowych pakietu usług API za pomocą interfejsu API

Aby wyświetlić wszystkie plany cenowe pakietu API, wyślij żądanie GET do /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, gdzie {package_id} to identyfikator pakietu API (identyfikator pakietu jest zwracany podczas tworzenia pakietu do zarabiania).

Domyślnie w wynikach zwracane są tylko aktywne, publiczne i standardowe abonamenty. Aby uwzględnić:

• W przypadku projektów lub wygasłych planów cenowych ustaw parametr zapytania current na wartość false (np. ?current=false).
• W przypadku prywatnych planów cenowych ustaw parametr zapytania showPrivate na true (np. ?showPrivate=true).
• W przypadku wszystkich standardowych planów cenowych ustaw parametr zapytania standard na true (np. ?standard=true).

Na przykład:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

Wyświetlanie planu cenowego pakietu interfejsu API za pomocą interfejsu API

Aby wyświetlić plan cenowy pakietu interfejsów API, wyślij żądanie GET na adres /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, gdzie {package_id} to identyfikator pakietu interfejsów API, a {plan_id} to identyfikator planu cenowego (identyfikator pakietu jest zwracany podczas tworzenia pakietu do zarabiania, a identyfikator planu cenowego jest zwracany podczas tworzenia planu cenowego).

Na przykład:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

Oto przykład odpowiedzi:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

Wyświetlanie wszystkich aktywnych planów taryfowych dla programisty za pomocą interfejsu API

Aby wyświetlić wszystkie aktywne plany stawek dewelopera, wyślij żądanie GET do /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, gdzie {developer_id} to adres e-mail dewelopera.

Aby filtrować wyniki, możesz przekazywać te parametry zapytania:

Na przykład:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

Oto przykład odpowiedzi:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

Wyświetlanie zaakceptowanego planu taryfowego dewelopera za pomocą interfejsu API

Aby wyświetlić aktywny plan stawek dla dewelopera, wyślij żądanie GET na adres /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}, gdzie {developer_id} to adres e-mail dewelopera, a {developer_rateplan_id} to identyfikator zaakceptowanego planu stawek, który jest zwracany w odpowiedzi, gdy zaakceptujesz opublikowany plan stawek.

Na przykład:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

Oto przykład odpowiedzi:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

Wyświetlanie za pomocą interfejsu API zaakceptowanego planu taryfowego dewelopera, który zawiera usługę API

Aby wyświetlić zaakceptowany plan taryfowy dla dewelopera, który zawiera usługę API, wyślij żądanie GET na adres /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, gdzie {developer_id} to identyfikator dewelopera, a /{product_id} to identyfikator usługi.

Domyślnie w wynikach zwracany jest tylko publiczny abonament. Aby wyświetlić prywatny plan cenowy, ustaw parametr zapytania showPrivate na true (np. ?showPrivate=true).

Na przykład:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

Wyświetlanie wszystkich planów taryfowych zaakceptowanych przez dewelopera za pomocą interfejsu API

Aby wyświetlić plany cenowe zaakceptowane przez dewelopera, wyślij żądanie GET na adres /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, gdzie {developer_id} to identyfikator dewelopera.

Aby filtrować wyniki, możesz przekazywać te parametry zapytania:

Na przykład:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

Oto przykład odpowiedzi:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

Usuwanie wersji roboczej planu taryfowego za pomocą interfejsu API

Aby usunąć wersję roboczą planu taryfowego, wyślij żądanie DELETE na adres /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, gdzie {plan_Id} to identyfikator planu taryfowego do usunięcia, a {package_id} to identyfikator pakietu API dla planu taryfowego. Obejmuje to na przykład:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Właściwości konfiguracji planów stawek

Podczas tworzenia planu cenowego za pomocą interfejsu API możesz określić te ustawienia konfiguracji:

Właściwości konfiguracji szczegółów planu taryfowego

Podczas tworzenia planu cenowego możesz określić dowolną z tych właściwości konfiguracji w ramach tablicy ratePlanDetails.