Anpassbaren Benachrichtigungsplan konfigurieren

Sie lesen gerade die Apigee Edge -Dokumentation.
Zur Apigee X -Dokumentation. info

Einführung

In 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 bestimmter Prozentsatz der Zielanzahl erreicht wird, z. B. 90%, 100 % oder 150%. Zusätzliche Transaktionen werden nicht blockiert, nachdem die Zielanzahl erreicht wurde.

Anpassbaren Benachrichtigungsplan über die Benutzeroberfläche konfigurieren

Konfigurieren Sie anpassbare Benachrichtigungspläne wie unten beschrieben.

Anpassbaren Benachrichtigungsplan mit der API konfigurieren

Geben Sie die Details des anpassbaren Benachrichtigungsplans in der ratePlanDetails Property 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 die folgenden Werte in der `ratePlanDetails` des Anfragetexts an:

Weitere Informationen zu den Konfigurationseigenschaften, die beim Angeben von Details zu anpassbaren Benachrichtigungsplänen festgelegt werden können, finden Sie unter Konfigurationseinstellungen für Tarifpaketdetails.

Im folgenden Beispiel wird ein anpassbarer Benachrichtigungsplan mit einer auf 1 Monat festgelegten Aggregationsbasis 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 mit der API festlegen

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

Zielanzahl der Transaktionen beim Akzeptieren des Tarifpakets festlegen

Wenn Sie das Tarifpaket akzeptieren und die Zielanzahl der Transaktionen festlegen möchten, geben Sie die quotaTarget Property im Anfragetext einer POST-Anfrage an die /organizations/{org_name}/developers/{developer_id}/developer-rateplans Ressource an. Setzen Sie quotaTarget auf eine positive Ganzzahl oder 0, um Benachrichtigungen für den App Entwickler zu deaktivieren. Wenn nichts angegeben ist, ist der Standardwert für „quotaTarget“ 0.

Mit der folgenden Anfrage wird 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 der Transaktionen beim Aktualisieren des akzeptierten Tarifpakets festlegen

Wenn Sie die Zielanzahl der Transaktionen festlegen möchten, können Sie das akzeptierte Tarifpaket aktualisieren und die quotaTarget Property im Anfragetext einer PUT-Anfrage an die /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} Ressource angeben. Setzen Sie quotaTarget auf eine positive Ganzzahl oder 0, um Benachrichtigungen für den App-Entwickler zu deaktivieren. Wenn nichts angegeben ist, ist der Standardwert für „quotaTarget“ 0.

Die {developer_rateplan_id} wird in der Antwort zurückgegeben, wenn Sie das veröffentlichte Tarifpaket 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 das Entwicklertarifpaket abrufen, 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 Tarifpakete 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.

$ 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