Skonfiguruj konfigurowalny plan powiadomień

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

Wprowadzenie

W dostosowanym planie powiadomień dostawca interfejsu API może dostosować docelową liczbę transakcji dla każdego dewelopera aplikacji. Możesz skonfigurować, czy i kiedy mają być wysyłane powiadomienia na podstawie wartości procentowej liczby docelowej, np. 90%, 100% lub 150%. Po osiągnięciu liczby docelowej dodatkowe transakcje nie są blokowane.

Konfigurowanie elastycznego planu powiadomień za pomocą interfejsu

Skonfiguruj plany powiadomień z możliwością zmiany, jak opisano poniżej.

Konfigurowanie elastycznego planu powiadomień za pomocą interfejsu API

Określ możliwe do dostosowania szczegóły 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ć plan powiadomień z możliwością zmiany, podaj te wartości w sekcji ratePlanDetails w treści żądania:

Właściwość	Wartość
type	Ustaw jako: USAGE_TARGET.
meteringType	Ustaw jako: DEV_SPECIFIC.
duration	Ustaw okres czasu dla podstawy agregacji, wraz z durationType. W przypadku planów z regulowanymi częstotliwościami powiadomień ustaw tę wartość jako liczbę całkowitą z zakresu od 1 do 24.
durationType	Ustaw zakres czasu używany jako podstawa agregacji, razem z parametrem durationType. W przypadku planów z regulowaną częstotliwością powiadomień ustaw tę wartość na MONTH.

Więcej informacji o właściwościach konfiguracji, które można ustawić podczas podawania szczegółów regulowanego planu powiadomień, znajdziesz w sekcji Ustawienia konfiguracji szczegółów planu cenowego.

Na przykład poniższy kod definiuje plan powiadomień z możliwością zmiany, którego podstawa agregacji jest ustawiona 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

Ustawianie docelowej liczby transakcji dla każdego dewelopera aplikacji korzystającego z interfejsu API

Gdy deweloper zaakceptuje abonament, możesz ustawić docelową liczbę transakcji dla dewelopera aplikacji. Możesz też później zaktualizować tę wartość.

Ustawianie docelowej liczby transakcji podczas akceptowania abonamentu

Aby podczas akceptowania planu cenowego ustawić docelową liczbę transakcji, w treści żądania żądania POST do zasobu /organizations/{org_name}/developers/{developer_id}/developer-rateplans podaj właściwość quotaTarget. Aby wyłączyć powiadomienia dla dewelopera aplikacji, ustaw wartość quotaTarget na dodatnią liczbę całkowitą lub 0. Jeśli nie podasz żadnej wartości, właściwość quotaTarget ma domyślną wartość 0.

Na przykład poniższe żądanie ustawia docelową liczbę transakcji na 4000, gdy deweloper aplikacji zaakceptuje plan powiadomień z możliwością zmiany.

$ 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 w ciele żądania w żądaniu PUT do zasobu /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} określić właściwość quotaTarget. Ustaw wartość quotaTarget na dodatnią liczbę całkowitą lub 0, aby wyłączyć powiadomienia dla dewelopera aplikacji. Jeśli nie podasz wartości, quotaTarget przyjmie domyślnie wartość 0.

Wartość {developer_rateplan_id} jest zwracana w odpowiedzi, gdy zaakceptujesz opublikowany plan stawek.

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 planu stawek dla deweloperów, wysyłając żądanie GET do usługi /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, gdzie {developer_id} to adres e-mail dewelopera. Więcej informacji znajdziesz w artykule Wyświetlanie 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 
}
        

Poniższe żądanie aktualizuje docelową liczbę transakcji do 4000.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password