Anpassbaren Benachrichtigungsplan konfigurieren

Sie sehen sich die Dokumentation zu Apigee Edge an.
Rufen Sie die Dokumentation zu Apigee X auf. Weitere Informationen

Einführung

Bei einem anpassbaren Benachrichtigungsplan kann der API-Anbieter die Zielanzahl der Transaktionen für jeden App-Entwickler anpassen. Sie können konfigurieren, ob und wann Benachrichtigungen gesendet werden, je nachdem, wann ein Prozentsatz der Zielzahl erreicht wird, z. B. 90%, 100 % oder 150%. Zusätzliche Transaktionen werden nicht blockiert, nachdem die Zielanzahl erreicht wurde.

Konfigurieren eines anpassbaren Benachrichtigungsplans über die Benutzeroberfläche

Konfigurieren Sie anpassbare Benachrichtigungspläne wie unten beschrieben.

Anpassbaren Benachrichtigungsplan mit der API konfigurieren

Geben Sie die Details des anpassbaren Benachrichtigungsplans in der Eigenschaft ratePlanDetails im Anfragetext einer POST-Anfrage an /organizations/{org_name}/monetization-packages/{package_id}/rate-plans an.

Wenn Sie einen anpassbaren Benachrichtigungsplan angeben möchten, geben Sie in den RatePlanDetails des Anfragetexts die folgenden Werte an:

Attribut	Wert
type	Setze diese Property auf USAGE_TARGET.
meteringType	Setze diese Property auf DEV_SPECIFIC.
duration	Legen Sie als Wert den Zeitraum für die Aggregationsbasis fest, zusammen mit durationType. Legen Sie für anpassbare Benachrichtigungstarife eine Ganzzahl zwischen 1 und 24 fest.
durationType	Legen Sie den Zeitraum für die Aggregationsbasis zusammen mit durationType fest. Legen Sie für anpassbare Benachrichtigungstarife diesen Wert auf MONTH fest.

Weitere Informationen zu den Konfigurationseigenschaften, die beim Angeben anpassbarer Details des Benachrichtigungsplans festgelegt werden können, finden Sie unter Konfigurationseinstellungen für Preisplandetails.

Im folgenden Beispiel wird beispielsweise ein anpassbarer Benachrichtigungsplan mit einer Aggregationsbasis von einem Monat definiert.

$ 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

Zielanzahl der Transaktionen für jeden App-Entwickler festlegen, der die API verwendet

Sie können die Zielanzahl der Transaktionen für einen App-Entwickler festlegen, wenn der Entwickler den Preisplan akzeptiert. Sie können den Wert später aktualisieren.

Die angestrebte Anzahl von Transaktionen beim Akzeptieren des Preisplans festlegen

Wenn du den Tarifplan akzeptierst, kannst du die Zielanzahl der Transaktionen festlegen, indem du das Attribut quotaTarget im Anfragetext einer POST-Anfrage an die Ressource /organizations/{org_name}/developers/{developer_id}/developer-rateplans angibst. Legen Sie quotaTarget auf eine positive Ganzzahl oder 0 fest, um Benachrichtigungen für den App-Entwickler zu deaktivieren. Wenn keine Angabe erfolgt, wird quotaTarget standardmäßig auf 0 gesetzt.

In der folgenden Anfrage wird beispielsweise die Zielanzahl der Transaktionen auf 4.000 festgelegt, wenn der App-Entwickler den anpassbaren Benachrichtigungsplan akzeptiert.

$ 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

Zielanzahl von Transaktionen beim Aktualisieren des akzeptierten Preisplans festlegen

Wenn du die Zielanzahl der Transaktionen festlegen möchtest, kannst du das akzeptierte Tarifpaket aktualisieren und die Property quotaTarget im Anfragetext einer PUT-Anfrage an die /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}-Ressource angeben. Legen Sie quotaTarget auf eine positive Ganzzahl oder 0 fest, um Benachrichtigungen für den App-Entwickler zu deaktivieren. Wenn Sie keinen Wert angeben, wird für quotaTarget standardmäßig „0“ verwendet.

Die {developer_rateplan_id} wird in der Antwort zurückgegeben, wenn Sie den veröffentlichten Preisplan akzeptieren.

Beispiel:

{
  "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
}

Alternativ können Sie die {developer-rateplan-id} für den Entwicklerpreisplan anfordern, indem Sie eine GET-Anfrage an /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans senden, wobei {developer_id} die E-Mail-Adresse des Entwicklers ist. Weitere Informationen finden Sie unter Alle von einem Entwickler akzeptierten Preispläne ansehen.

Beispiel:

{
  "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 
}
        

Mit der folgenden Anfrage wird die Zielanzahl der Transaktionen auf 4.000 aktualisiert.

email:password