Skonfiguruj konfigurowalny plan powiadomień

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

Wprowadzenie

W przypadku planu powiadomień z możliwością dostosowania 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 tego, kiedy zostanie osiągnięty określony procent docelowej liczby, np. 90%, 100% lub 150%. Po osiągnięciu docelowej liczby transakcji nie są blokowane dodatkowe transakcje.

Konfigurowanie planu powiadomień z możliwością dostosowania za pomocą interfejsu

Skonfiguruj plany powiadomień z możliwością dostosowania zgodnie z opisem poniżej.

Konfigurowanie planu powiadomień z możliwością dostosowania za pomocą interfejsu API

Szczegóły planu powiadomień z możliwością dostosowania określ w właściwości ratePlanDetails w treści żądania POST wysłanego do adresu /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Aby określić plan powiadomień z możliwością dostosowania, w treści żądania w sekcji ratePlanDetails podaj te wartości:

Więcej informacji o właściwościach konfiguracyjnych, które można ustawić podczas określania szczegółów planu powiadomień z możliwością dostosowania, znajdziesz w artykule Ustawienia konfiguracji szczegółów planu taryfowego.

Na przykład poniższy kod definiuje plan powiadomień z możliwością dostosowania, w którym 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 za pomocą interfejsu API

Docelową liczbę transakcji dla dewelopera aplikacji możesz ustawić, gdy deweloper zaakceptuje plan taryfowy. Możesz też później zaktualizować tę wartość.

Ustawianie docelowej liczby transakcji podczas akceptowania planu taryfowego

Aby ustawić docelową liczbę transakcji podczas akceptowania planu taryfowego, w treści żądania POST wysłanego do /organizations/{org_name}/developers/{developer_id}/developer-rateplans zasobu określ właściwość quotaTarget. Ustaw quotaTarget na dodatnią liczbę całkowitą lub 0, aby wyłączyć powiadomienia dla dewelopera aplikacji. Jeśli nie zostanie określona, domyślna wartość quotaTarget to 0.

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

$ 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 zaakceptowanego planu taryfowego

Aby ustawić docelową liczbę transakcji, możesz zaktualizować zaakceptowany plan taryfowy i określić właściwość quotaTarget w treści żądania PUT wysłanego 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 zostanie określona, domyślna wartość quotaTarget to 0.

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

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ć wartość {developer-rateplan-id} dla planu taryfowego dewelopera, wysyłając żądanie GET do adresu /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 planów taryfowych 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":"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