Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Zarządzaj planami stawek za pomocą interfejsu użytkownika i API zgodnie z opisem w sekcjach poniżej.
Przeglądanie strony abonamentów
Otwórz stronę abonamentów zgodnie z opisem poniżej.
Edge
Aby wyświetlić plany stawek w interfejsie Edge, otwórz stronę Plany stawek:
- Zaloguj się na stronie apigee.com/edge.
- Na pasku nawigacyjnym po lewej stronie kliknij Opublikuj > Zarabianie > Plany stawek.
Zostanie wyświetlona strona Plany taryf.
Jak zaznaczyliśmy na ilustracji, strona Plany taryfy umożliwia:
- Wyświetlanie podsumowania informacji o wszystkich planach stawek, w tym ich nazwy, pakietu usług API, stanu (opublikowano lub wersja robocza), kosztu planu oraz dat rozpoczęcia i zakończenia.
UWAGA: wygasłe plany stawek nie są wyświetlane w interfejsie. Aby wyświetlić abonamenty, które wygasły, użyj interfejsu API. Więcej informacji znajdziesz w artykule na temat wyświetlania planów stawek za pomocą interfejsu API. - Tworzenie planu stawek
- Edytowanie planu stawek
- Publikowanie planu cen
- Usuwanie wersji roboczej planu stawek
- Dodawanie przyszłego abonamentu zgodnie z opisem w sekcji Zarządzanie przyszłymi planami stawek
- Przeszukaj listę abonamentów w dowolnym widocznym polu albo podaj nazwę lub kategorię dewelopera (w odpowiednich przypadkach).
Klasyczna wersja Edge (Private Cloud)
Aby wyświetlić plany stawek w klasycznym interfejsie Edge, otwórz stronę Pakiety interfejsu API:
- Zaloguj się w
http://ms-ip:9000, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania. - Na pasku nawigacyjnym u góry wybierz Opublikuj > Pakiety.
Na stronie Pakiety interfejsu API są wyświetlane plany stawek zdefiniowane dla każdego pakietu.
Na stronie Abonamenty możesz:
- Tworzenie planu stawek
- Edytowanie planu stawek
- Publikowanie planu cen
- Usuwanie wersji roboczej planu stawek
- Dodawanie przyszłego abonamentu zgodnie z opisem w sekcji Zarządzanie przyszłymi planami stawek
- Przeszukaj listę abonamentów w dowolnym widocznym polu albo podaj nazwę lub kategorię dewelopera (w odpowiednich przypadkach).
Tworzenie planu taryf
Aby utworzyć plan stawek:
- Otwórz stronę Abonamenty.
- Kliknij + Abonament.
- W górnym panelu skonfiguruj te pola:
Pole Opis Domyślne Wymagane Nazwa planu taryf Nazwa planu taryfowego. UWAGA: nazwa musi być unikalna w pakiecie produktów API. Dwa abonamenty w tym samym pakiecie produktów nie mogą mieć takiej samej nazwy.
Nie dotyczy Tak Typ planu taryf Typ planu taryf. Wybierz wartość z listy. Listę prawidłowych typów abonamentów znajdziesz w artykule Obsługiwane typy abonamentów. Nie dotyczy Tak Pakiet produktów Pakiet produktów API. Wybierz wartość z listy. Więcej informacji o pakietach produktów przy użyciu interfejsu API znajdziesz w artykule Zarządzanie pakietami produktów za pomocą interfejsu API. Jeśli wybierzesz pakiet produktów zawierający więcej niż 1 usługę API, musisz wybrać, czy chcesz skonfigurować indywidualne plany stawek dla każdej z tych usług, czy ogólny plan stawek, który będzie stosowany do wszystkich tych usług.
Nie dotyczy Tak Odbiorcy Odbiorcy, którzy mają dostęp do planu stawek. Wybierz jedną z tych wartości z listy: - Wszyscy – wszyscy deweloperzy.
- Deweloper – deweloper lub firma. Wpisz nazwę dewelopera lub firmę. Podczas pisania w menu wyświetli się lista deweloperów lub firm, które zawierają ten ciąg znaków. Kliknij nazwę dewelopera lub firmy na liście.
- Kategoria dewelopera – kategoria dewelopera. Wybierz z listy kategorię dewelopera.
Skonfiguruj kategorie deweloperów zgodnie z opisem w artykule Zarządzanie kategoriami deweloperów.
Wszyscy Nie Data rozpoczęcia Data wejścia w życie planu stawek. Wpisz datę rozpoczęcia lub wybierz datę w kalendarzu. Dzisiaj Nie Data zakończenia Data zakończenia abonamentu. Aby określić datę zakończenia, włącz przełącznik Ma datę zakończenia i wpisz datę zakończenia lub wybierz datę w kalendarzu. UWAGA: plan stawek będzie obowiązywać do końca dnia w określonym dniu. Jeśli chcesz wygasnąć plan ceny np. 1 grudnia 2018 roku, ustaw wartość endDate na 30.11.2018. W takim przypadku abonament wygaśnie pod koniec dnia 30 listopada 2018 roku. Wszystkie żądania wysłane z dnia 1 grudnia 2018 roku zostaną zablokowane.
Brak Nie Widoczne dla portali Określ, czy abonament ma być publiczny czy prywatny. Zobacz Abonamenty publiczne a prywatne. Włączono Nie - Skonfiguruj opłaty na potrzeby planu stawek. Zobacz Konfigurowanie opłat w ramach planu stawek.
UWAGA: opcja nie dotyczy dostosowywanych planów powiadomień. - Jeśli wybierzesz pakiet produktów zawierający więcej niż 1 usługę API, w sekcji Szczegółowy lub ogólny plan stawek określ te preferencje:
UWAGA: tego kroku nie można zastosować w przypadku planowanych powiadomień o dostosowywaniu.
Pole Opis Domyślne Skonfiguruj każdą usługę osobno Flaga określająca, czy należy skonfigurować indywidualny plan stawek dla każdej usługi interfejsu API. Wyłączono Konfigurowanie oferty freemium każdej usługi oddzielnie Flaga określająca, czy należy skonfigurować abonament freemium dla każdej usługi API. Wyłączono Wybierz produkt Jeśli włączysz jedną lub obie flagi, musisz wybrać każdą usługę z listy i skonfigurować szczegóły jej abonamentu. UWAGA: pamiętaj, aby skonfigurować wszystkie produkty w pakiecie.
Nie dotyczy - Skonfiguruj szczegóły abonamentu na podstawie wybranego typu abonamentu:
- Kliknij jedną z tych opcji:
Przycisk Opis Zapisz jako wersję roboczą Zapisz plan stawek jako wersję roboczą. Abonament nie będzie widoczny dla deweloperów aplikacji, dopóki go nie opublikujesz. W roboczym planie taryf możesz edytować dowolne pole.
Opublikuj nowy plan Opublikuj plan. UWAGA: po opublikowaniu planu cen możesz zmienić datę zakończenia tylko wtedy, gdy nie została jeszcze ustawiona. Nie możesz usunąć abonamentu po jego opublikowaniu, ale możesz go utracić i zastąpić go przyszłym abonamentem zgodnie z opisem w sekcji Wygaśnięcie opublikowanego planu stawek.
- Dołącz zasadę sprawdzania limitów zarabiania do serwerów proxy API powiązanych z usługami API uwzględnionymi w planie stawek. Zasada sprawdzania limitów zarabiania egzekwuje limity zarabiania na serwerach proxy interfejsu API i zapewnia dokładne rejestrowanie wszelkich błędów w raportach o statystykach i przychodach. Więcej informacji znajdziesz w artykule o egzekwowaniu limitów zarabiania na serwerach proxy interfejsów API.
Edytowanie planu cen
W roboczym planie ceny możesz edytować wszystkie pola oprócz typu pakietu produktów, typu i odbiorców. Po opublikowaniu planu stawek możesz edytować tylko datę zakończenia i tylko wtedy, gdy nie została ona określona.
Aby edytować plan stawek:
- Otwórz stronę Abonamenty.
- Kliknij wiersz planu stawek, który chcesz edytować.
Wyświetli się panel abonamentu. - Odpowiednio zmodyfikuj pola planu stawek.
UWAGA: po opublikowaniu planu stawek możesz zmienić datę zakończenia tylko wtedy, gdy nie została jeszcze ustawiona. - Kliknij jedną z tych opcji:
Przycisk Opis Aktualizowanie wersji roboczej (wersje abonamentów) Zapisz plan stawek jako wersję roboczą.
Abonament nie będzie widoczny dla deweloperów aplikacji, dopóki go nie opublikujesz. W roboczym planie taryf możesz edytować dowolne pole.Opublikuj wersję roboczą (robocze abonamenty) Opublikuj plan stawek.
UWAGA: po opublikowaniu planu stawek możesz zmienić datę zakończenia tylko wtedy, gdy nie została jeszcze ustawiona. Nie możesz usunąć abonamentu po jego opublikowaniu, ale możesz go utracić i zastąpić go przyszłym abonamentem zgodnie z opisem w sekcji Wygaśnięcie opublikowanego planu stawek.Zaktualizowana data zakończenia (opublikowane plany stawek) Ustaw datę zakończenia opublikowanego planu.
UWAGA: po ustawieniu daty zakończenia opublikowanego planu cen nie można go już modyfikować.
Usuwanie wersji roboczej planu stawek
Usuń wersję roboczą planu stawek, jeśli nie jest już potrzebny.
UWAGA: nie można usunąć opublikowanego planu stawek.
Aby usunąć wersję roboczą abonamentu:
- Otwórz stronę Abonamenty.
- Najedź kursorem na plan stawek, który chcesz usunąć, aby wyświetlić menu czynności.
- Kliknij
. - Kliknij Usuń, aby potwierdzić działanie.
Zarządzanie planami stawek za pomocą interfejsu API
Poniżej znajdziesz informacje o tym, jak zarządzać planami stawek za pomocą interfejsu API.
Tworzenie planów stawek za pomocą interfejsu API
Aby utworzyć plan stawek, wyślij żądanie POST do /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 stawek musisz podać w treści żądania te informacje:
- Identyfikator organizacji
- Identyfikator pakietu produktów API
- Nazwa planu stawek
- Opis planu stawek
- Zakres planu cen (niezależnie od tego, czy dotyczy on wszystkich deweloperów czy tylko konkretnego dewelopera, firmy lub dewelopera)
- Data wejścia w życie planu stawek
- Waluta planu stawek
- Określa, czy opublikować plan stawek.
- od tego, czy abonament jest publiczny czy prywatny.
Możesz też określić inne ustawienia, takie jak termin płatności (np. 30 dni). Patrz Właściwości konfiguracji abonamentów.
Jeśli utworzysz plan stawek (inny niż abonament z opłatami) dla pakietu produktów API, który zawiera więcej niż 1 produkt, możesz go zastosować do konkretnego produktu w pakiecie. Aby to zrobić, wskaż usługę w żądaniu. Jeśli nie określisz produktu, plan zostanie zastosowany do wszystkich produktów w pakiecie interfejsu API.
Z tych sekcji dowiesz się, jak tworzyć plany stawek:
- Tworzenie planu taryf standardowych za pomocą interfejsu API
- Tworzenie dewelopera lub planu stawek firmy za pomocą interfejsu API
- Tworzenie planu stawek dla kategorii dla deweloperów za pomocą interfejsu API
- Tworzenie za pomocą interfejsu API planu stawek dla określonej usługi API
- Ustawianie abonamentu jako publicznego lub prywatnego przy użyciu interfejsu API
Tworzenie abonamentu standardowego przy użyciu interfejsu API
Aby utworzyć abonament standardowy, ustaw atrybut type na STANDARD, jak pokazano w poniższym 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 dewelopera lub planu stawek firmy za pomocą interfejsu API
Aby zastosować abonament do określonego dewelopera lub firmy, ustaw wartość type na Developer. W żądaniu musisz też podać dewelopera lub firmę, podając identyfikator, nazwę prawną oraz nazwę dewelopera.
Na przykład ten fragment tworzy plan stawek dewelopera Dev Five:
...
"type": "DEVELOPER",
"developer" : {
"id" : "0mkKu1PALUGfjUph",
"legalName" : "DEV FIVE",
"name" : "Dev Five"
}
...
Tworzenie planu stawek dla kategorii dla deweloperów za pomocą interfejsu API
Aby zastosować plan stawek do kategorii dewelopera, ustaw wartość type na Developer_Category. W żądaniu musisz też określić kategorię dewelopera.
Na przykład:
...
"type": "DEVELOPER_CATEGORY",
"developerCategory" : {
"id" : "5e172299-8232-45f9-ac46-40076139f373",
"name" : "Silver",
"description" : "Silver category"
}
...
Tworzenie planu stawek dla określonej usługi API przy użyciu interfejsu API
Podczas tworzenia planu stawek dla pakietów produktów API, które obejmują wiele usług API, możesz określić szczegóły planu stawek dla poszczególnych usług.
Na przykład wygląda tak:
$ 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 pakietu produktów API my-package, musisz dodać w treści żądania szczegóły abonamentu dla usługi API zgodnie z opisem w sekcji Dodawanie usługi API do pakietu produktów API z planami stawek dla poszczególnych usług interfejsu 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 abonamentu jako publicznego lub prywatnego przy użyciu interfejsu API
Podczas tworzenia abonamentu możesz określić, czy ma on być publiczny czy prywatny, korzystając z atrybutu isPrivate w treści żądania. Jeśli ustawisz wartość true, abonament będzie prywatny. Więcej informacji znajdziesz w sekcji Plany stawek publicznych i prywatnych.
Na przykład wygląda to tak:
$ 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 stawek przy użyciu interfejsu API
Aby opublikować plan cenowy, podczas jego tworzenia ustaw wartość właściwości published na „prawda”. Deweloperzy będą mogli wyświetlać plan stawek od dnia określonego we właściwości startDate planu.
Na przykład ten proces tworzy i publikuje plan arkusza stawek (widoczna 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 taryf przy użyciu interfejsu API
Aby zapisać plan stawek bez jego publikowania, podczas tworzenia planu stawek ustaw wartość właściwości published na false.
Na przykład wygląda tak:
$ 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 taryf przy użyciu interfejsu API
Aby zaktualizować wersję roboczą abonamentu, wyślij żądanie PUT do /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}, gdzie {package_id} to identyfikator pakietu interfejsu API, a {plan_Id} to identyfikator abonamentu. Podczas aktualizacji musisz podać w treści żądania zaktualizowane ustawienia i identyfikator abonamentu. Jeśli aktualizujesz stawkę w ramach abonamentu, musisz też podać jej identyfikator. Na przykład to żądanie aktualizuje stawkę abonamentu w planie, którego identyfikator to location_flat_rate_card_plan (ta aktualizacja 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ę abonamentu (wyświetlana jest tylko część odpowiedzi):
…
"ratePlanRates" : [ {
"id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
"rate" : 0.15,
"startUnit" : 0,
"type" : "RATECARD"
} ],
…
Wyświetlanie planów stawek przy użyciu interfejsu API
Plany stawek możesz wyświetlać za pomocą interfejsu Monetization API, w sposób opisany w sekcjach poniżej.
- Wyświetlanie wszystkich abonamentów dla organizacji przy użyciu interfejsu API
- Wyświetlanie wszystkich abonamentów związanych z pakietem produktów API za pomocą interfejsu API
- Wyświetlanie planu taryfowego pakietu produktów API za pomocą interfejsu API
- Wyświetlanie wszystkich aktywnych abonamentów dla dewelopera za pomocą interfejsu API
- Wyświetlanie za pomocą interfejsu API akceptowanego abonamentu dla dewelopera
- Wyświetlanie akceptowanego planu stawek w przypadku dewelopera, który zawiera usługę API za pomocą interfejsu API
- Wyświetlanie wszystkich abonamentów zaakceptowanych przez dewelopera za pomocą interfejsu API
Wyświetlanie wszystkich abonamentów w organizacji przy użyciu interfejsu API
Aby wyświetlić wszystkie abonamenty dla organizacji, wyślij żądanie GET do usługi /mint/organizations/{org_name}/rate-plans, gdzie {org_name} to nazwa Twojej organizacji.
Aby filtrować wyniki, możesz przekazywać te parametry zapytania:
| Parametr zapytania | Opis |
|---|---|
all |
Flaga określająca, czy należy zwrócić wszystkie plany stawek. Jeśli jest ustawiona na false, liczba planów stawek zwróconych na stronę jest określana przez parametr zapytania size. Domyślna wartość to true. |
size |
Liczba pakietów interfejsu API zwróconych na stronę. Jeśli parametr zapytania all ma wartość true, jest on ignorowany. |
page |
Numer strony, którą chcesz zwrócić (jeśli treść jest podzielona na strony). Jeśli parametr zapytania all ma wartość true, jest on ignorowany. |
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 abonamentów związanych z pakietem produktów API za pomocą interfejsu API
Aby wyświetlić wszystkie abonamenty dotyczące pakietu API, wyślij żądanie GET do usługi /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, gdzie {package_id} to identyfikator pakietu API (identyfikator pakietu jest zwracany podczas tworzenia pakietu zarabiania).
Domyślnie w wynikach wyświetlane są tylko aktywne, publiczne i standardowe abonamenty. Aby uwzględnić:
- W przypadku wersji roboczych lub wygasłych planów stawek ustaw parametr zapytania
currentnafalse(np.?current=false). - Plany stawek prywatnych, ustaw parametr zapytania
showPrivatenatrue(np.?showPrivate=true). - W przypadku wszystkich planów standardowych stawek ustaw parametr zapytania
standardnatrue(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 abonamentu dla pakietu API za pomocą interfejsu API
Aby wyświetlić plan taryfowy dotyczący pakietu API, wyślij żądanie GET do usługi /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, gdzie {package_id} to identyfikator pakietu API, a {plan_id} to identyfikator abonamentu (identyfikator pakietu jest zwracany podczas tworzenia pakietu zarabiania, a identyfikator abonamentu jest zwracany podczas tworzenia planu taryfowego).
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
Poniżej znajdziesz przykładową odpowiedź:
{
"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 za pomocą interfejsu API wszystkich aktywnych abonamentów dewelopera
Aby wyświetlić wszystkie aktywne abonamenty 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:
| Parametr zapytania | Opis |
|---|---|
all |
Flaga określająca, czy należy zwrócić wszystkie pakiety interfejsu API. Jeśli ma wartość false, liczba pakietów API zwróconych na stronę jest określana przez parametr zapytania size. Domyślna wartość to false. |
size |
Liczba pakietów interfejsu API zwróconych na stronę. Wartość domyślna to 20. Jeśli parametr zapytania all ma wartość true, jest on ignorowany. |
page |
Numer strony, którą chcesz zwrócić (jeśli treść jest podzielona na strony). Jeśli parametr zapytania all ma wartość true, jest on ignorowany. |
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
Poniżej znajdziesz przykładową odpowiedź:
{
"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 za pomocą interfejsu API zaakceptowanego abonamentu dla dewelopera
Aby wyświetlić aktywny abonament dla dewelopera, wyślij żądanie GET do usługi /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 akceptowanego planu stawek zwracany w odpowiedzi, gdy zaakceptujesz opublikowany abonament.
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
Poniżej znajdziesz przykładową odpowiedź:
{
"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 akceptowanego planu stawek w przypadku dewelopera, który zawiera usługę API za pomocą interfejsu API
Aby wyświetlić akceptowany abonament dewelopera, który zawiera usługę API, wyślij żądanie GET do /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 produktu.
Domyślnie w wynikach zwracany jest tylko publiczny abonament. Aby wyświetlić plan ceny prywatnej, ustaw parametr zapytania showPrivate na true (na przykład ?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 abonamentów zaakceptowanych przez dewelopera za pomocą interfejsu API
Aby wyświetlić plany stawek zaakceptowane przez dewelopera, wyślij do /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans żądanie GET, gdzie {developer_id} to identyfikator dewelopera.
Aby filtrować wyniki, możesz przekazywać te parametry zapytania:
| Parametr zapytania | Opis |
|---|---|
all |
Flaga określająca, czy należy zwrócić wszystkie pakiety interfejsu API. Jeśli ma wartość false, liczba pakietów API zwróconych na stronę jest określana przez parametr zapytania size. Domyślna wartość to false. |
size |
Liczba pakietów interfejsu API zwróconych na stronę. Wartość domyślna to 20. Jeśli parametr zapytania all ma wartość true, jest on ignorowany. |
page |
Numer strony, którą chcesz zwrócić (jeśli treść jest podzielona na strony). Jeśli parametr zapytania all ma wartość true, jest on ignorowany. |
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
Poniżej znajdziesz przykładową odpowiedź:
{
"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 taryf przy użyciu interfejsu API
Aby usunąć wersję roboczą abonamentu, wyślij żądanie DELETE do /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, gdzie {plan_Id} to identyfikator abonamentu, który ma zostać usunięty, a {package_id} to identyfikator pakietu API na potrzeby abonamentu. 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 abonamentów
Podczas tworzenia abonamentu za pomocą interfejsu API możesz określić te ustawienia konfiguracji.
| Nazwa | Opis | Domyślne | Wymagana? |
|---|---|---|---|
advance |
Dotyczy tylko opłat cyklicznych. Flaga określająca, czy opłata cykliczna jest pobierana z góry. Prawidłowe wartości to m.in.:
|
false | Nie |
contractDuration |
Czas trwania umowy na abonament wraz z |
Nie dotyczy | Nie |
contractDurationType |
Czas trwania umowy na abonament wraz z
|
Nie dotyczy | Nie |
currency |
Waluta używana na potrzeby planu stawek. Podaj kod ISO 4217 waluty, np. |
Nie dotyczy | Tak |
description |
Opis planu stawek. |
Nie dotyczy | Tak |
developer |
Identyfikator dewelopera (adres e-mail). Określ tylko w przypadku planów taryfowych dla deweloperów. |
Nie dotyczy | Nie |
developerCategory |
Identyfikator kategorii dewelopera. Określ tylko w przypadku planów stawek dla kategorii dewelopera. |
Nie dotyczy | Nie |
displayName |
Łatwa w użyciu wyświetlana nazwa planu taryfowego. |
Nie dotyczy | Tak |
earlyTerminationFee |
Jednorazowa opłata, która jest naliczana, gdy deweloper zakończy abonament przed okresem odnowienia. |
Nie dotyczy | Nie |
endDate |
Data zakończenia abonamentu. Po tej dacie deweloperzy nie będą mogli wyświetlić abonamentu. Jeśli nie chcesz, aby abonament kończył się konkretnego dnia, podaj w polu Abonament będzie obowiązywać do końca dnia w określonym dniu. Jeśli chcesz zakończyć abonament np. 1 grudnia 2016 roku, ustaw wartość endDate na 2016-11-30. W takim przypadku abonament wygasa 30 listopada 2016 roku. Wszystkie żądania wysłane z dnia 1 grudnia 2016 r. zostaną zablokowane. UWAGA: podczas wyświetlania planu cen za pomocą interfejsu API sygnatura czasowa endDate jest ustawiona jako |
Nie dotyczy | Nie |
freemiumDuration |
Okres okresu freemium wraz z wartością |
Nie dotyczy | Nie |
freemiumDurationType |
Okres obowiązywania freemium razem z wartością
|
Nie dotyczy | Nie |
freemiumUnit |
Liczba elementów freemium. Wartością może być liczba transakcji lub liczba jednostek związanych z atrybutem niestandardowym zarejestrowanym w zasadzie rejestrowania transakcji. |
Nie dotyczy | Nie |
frequencyDuration |
Dotyczy tylko opłat cyklicznych. Okres pomiędzy opłatami cyklicznymi a |
Nie dotyczy | Nie |
frequencyDurationType |
Dotyczy tylko opłat cyklicznych. Okres pomiędzy opłatami cyklicznymi a frequencyDuration. Prawidłowe wartości to m.in.:
|
Nie dotyczy | Nie |
isPrivate |
Flaga określająca, czy plan stawek jest publiczny czy prywatny. Wartość domyślna to false (publiczna). Więcej informacji znajdziesz w artykule Publiczne a prywatne plany taryfowe. |
Nie dotyczy | Nie |
monetizationPackage |
Identyfikator pakietu produktów API na potrzeby abonamentu. |
Nie dotyczy | Nie |
name |
Nazwa planu stawek. |
Nie dotyczy | Tak |
organization |
Identyfikator organizacji na potrzeby abonamentu. |
Nie dotyczy | Tak |
paymentDueDays |
Dotyczy tylko opłat cyklicznych. Liczba dni, przez które należy uregulować opłaty. Możesz na przykład ustawić wartość 30, aby wskazać, że opłaty będą obowiązywać za 30 dni. |
Nie dotyczy | Nie |
proRate |
Dotyczy tylko opłat cyklicznych. Flaga określająca, czy opłata cykliczna jest naliczana proporcjonalnie w przypadku rozpoczęcia lub zakończenia realizacji planu przez dewelopera w trakcie miesiąca. Prawidłowe wartości to między innymi:
|
false | Nie |
published |
Flaga określająca, czy abonament powinien zostać opublikowany do przeglądania przez deweloperów. Prawidłowe wartości to m.in.:
|
Nie dotyczy | Tak |
ratePlanDetails |
Szczegóły abonamentu (szczegóły znajdziesz w sekcji Właściwości konfiguracji szczegółów abonamentu). |
Nie dotyczy | Tak |
recurringFee |
Opłata, którą deweloper jest obciążany na bieżąco do momentu zakończenia przez niego abonamentu. |
Nie dotyczy | Nie |
recurringStartUnit |
Obowiązuje tylko wtedy, gdy |
Nie dotyczy | Nie |
recurringType |
Harmonogram opłaty cyklicznej. Prawidłowe wartości to m.in.:
|
Nie dotyczy | Nie |
setUpFee |
Jednorazowa opłata, którą jest obciążany każdego dewelopera w dniu rozpoczęcia abonamentu (czyli od dnia jego zakupu). |
Nie dotyczy | Nie |
startDate |
Data rozpoczęcia abonamentu. Deweloperzy mogą zobaczyć abonament od tej daty. |
Nie dotyczy | Tak |
type |
Typ planu taryfowego. Podaj jedną z tych wartości:
|
Nie dotyczy | Tak |
Właściwości konfiguracji szczegółów abonamentu
Podczas tworzenia planu taryfowego w tablicy ratePlanDetails możesz określić dowolną z tych właściwości konfiguracji.
| Nazwa | Opis | Domyślne | Wymagana? |
|---|---|---|---|
aggregateFreemiumCounters |
Flaga określająca, czy liczniki zbiorcze są włączone, aby określić, czy wykorzystanie usługi interfejsu API mieści się w swobodnym zakresie. Aby skonfigurować plan freemium dotyczący produktu, musisz włączyć liczniki zbiorcze. Prawidłowe wartości to m.in.:
|
Nie dotyczy | Nie |
aggregateStandardCounters |
Flaga określająca, czy do określania zakresu wykorzystania są używane liczniki agregujące (np. zakres głośności w abonamencie arkusza stawek). Możliwe wartości:
|
Nie dotyczy | Nie |
aggregateTransactions |
UWAGA: ta właściwość nie jest obecnie używana do generowania przychodu i można ją zignorować. |
prawda | Nie |
currency |
Walutę. |
Nie dotyczy | Nie |
duration |
Okres częstotliwości obliczania, wraz z wartością Na przykład ustaw |
Nie dotyczy | Nie |
durationType |
Okres częstotliwości obliczania ( Przykład użycia znajdziesz na stronie |
Nie dotyczy | Nie |
freemiumDuration |
Czas okresu freemium dla pojedynczej usługi API razem z |
Nie dotyczy | Nie |
freemiumDurationType |
Czas okresu freemium dla pojedynczej usługi API razem z
Aby na przykład określić, że okres freemium dla usługi API wynosi 30 dni, ustaw |
Nie dotyczy | Nie |
freemiumUnit |
Liczba freemium dla produktu API. Wartością może być liczba transakcji lub liczba jednostek związanych z atrybutem niestandardowym zarejestrowanym w zasadzie rejestrowania transakcji. |
Nie dotyczy | Nie |
meteringType |
Model naliczania opłat za abonament w arkuszu stawek. Prawidłowe wartości to m.in.:
|
Nie dotyczy | tak |
organization |
Identyfikator organizacji. |
Nie dotyczy | Nie |
paymentDueDays |
Termin płatności dla dewelopera korzystającego z opcji płatności po wykonaniu usługi. Możesz na przykład ustawić wartość 30, aby wskazać, że termin płatności upływa za 30 dni. |
Nie dotyczy | Nie |
product |
informacje o interfejsie API, np. identyfikator. |
Nie dotyczy | Nie |
ratePlanRates |
szczegóły dotyczące stawek w planie stawek, takie jak typ planu stawek ( |
Nie dotyczy | Tak |
ratingParameter |
Podstawa planu opłat. Plan stawek jest oparty na transakcjach lub atrybucie niestandardowym. Prawidłowe wartości to m.in.:
|
VOLUME |
Tak |
ratingParameterUnit |
Jednostka odnosząca się do |
Nie dotyczy | Tak |
revenueType |
Podstawa udziału w przychodach w planie udziału w przychodach. Prawidłowe wartości to m.in.:
|
Nie dotyczy | Nie |
type |
Typ planu taryf. Prawidłowe wartości to m.in.:
Więcej informacji o typach abonamentów znajdziesz w artykule Obsługiwane typy abonamentów. |
Nie dotyczy | Tak |