Skonfiguruj konfigurowalny plan powiadomień

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

Wstęp

W abonamencie, który można dostosować, dostawca interfejsu API może dostosować docelową liczbę transakcji dla każdego dewelopera aplikacji. Możesz określić, czy i kiedy powiadomienia mają być wysyłane na podstawie osiągnięcia określonego procentu wartości docelowej, np. 90%, 100% lub 150%. Po osiągnięciu docelowej liczby dodatkowe transakcje nie są blokowane.

Konfigurowanie dostosowywanego planu powiadomień za pomocą interfejsu użytkownika

Skonfiguruj plany powiadomień, które możesz dostosowywać, w sposób opisany poniżej.

Konfigurowanie dostosowywanego planu powiadomień przy użyciu interfejsu API

Określ szczegóły dostosowywanego planu powiadomień we właściwości ratePlanDetails w treści żądania w żądaniu POST wysyłanym do /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Aby określić dostosowywany plan powiadomień, w wskaźniku stawkiPlanDetails w treści żądania podaj te wartości:

Właściwość	Wartość
type	Ustaw jako: USAGE_TARGET.
meteringType	Ustaw jako: DEV_SPECIFIC.
duration	Ustaw jako przedział czasu na podstawie agregacji (wraz z wartością durationType). W przypadku planów z powiadomieniami o dostosowywaniu ustaw tę wartość na liczbę całkowitą od 1 do 24.
durationType	Ustaw jako przedział czasu na podstawie agregacji (wraz z wartością durationType). W przypadku planów z możliwością dostosowania stawek powiadomień ustaw tę wartość na MONTH.

Więcej informacji o właściwościach konfiguracji, które można ustawić przy określaniu szczegółów dostosowywanego planu powiadomień, znajdziesz w artykule Ustawienia konfiguracji szczegółów planu opłat.

Na przykład poniżej zdefiniowano dostosowywany plan powiadomień z zasadą agregacji ustawioną na 1 miesiąc.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Ustalanie docelowej liczby transakcji dla każdego dewelopera aplikacji za pomocą interfejsu API

Możesz ustawić docelową liczbę transakcji dla dewelopera aplikacji po zaakceptowaniu przez niego planu stawek. Możesz też zaktualizować wartość później.

Ustawianie docelowej liczby transakcji podczas akceptowania planu stawek

Akceptując plan stawek, aby ustawić docelową liczbę transakcji, określ właściwość quotaTarget w treści żądania w żądaniu POST wysyłanym do zasobu /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Ustaw quotaTarget na dodatnią liczbę całkowitą lub 0, aby wyłączyć powiadomienia dla dewelopera aplikacji. Jeśli nie określono parametru quotaTarget, wartość domyślna to 0.

Na przykład to żądanie ustawia docelową liczbę transakcji na 4000, gdy deweloper aplikacji zaakceptuje dostosowany plan powiadomień.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Ustawianie docelowej liczby transakcji podczas aktualizowania akceptowanego planu stawek

Aby ustawić docelową liczbę transakcji, możesz zaktualizować akceptowany plan stawek i określić właściwość quotaTarget w treści żądania w żądaniu PUT kierowanym do zasobu /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Ustaw quotaTarget na dodatnią liczbę całkowitą lub 0, aby wyłączyć powiadomienia dla dewelopera aplikacji. Jeśli nie określono parametru quotaTarget, wartość domyślna to 0.

Gdy zaakceptujesz opublikowany abonament, w odpowiedzi zostanie zwrócona {developer_rateplan_id}.

Na przykład:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Możesz też uzyskać {developer-rateplan-id} dla abonamentu z cenami dla deweloperów, wysyłając żądanie GET do /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, gdzie {developer_id} to adres e-mail dewelopera. Więcej informacji znajdziesz w artykule na temat wyświetlania wszystkich abonamentów zaakceptowanych przez dewelopera.

Na przykład:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

To żądanie aktualizuje docelową liczbę transakcji do 4000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
 "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
 "developer":{
 "id":"plandev@mojafirma.com"
 }email:password