Anpassbaren Benachrichtigungsplan konfigurieren

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Einführung

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

Konfigurieren eines anpassbaren Benachrichtigungsplans über die Benutzeroberfläche

Konfigurieren Sie wie unten beschrieben anpassbare Benachrichtigungspläne.

Konfigurieren eines anpassbaren Benachrichtigungsplans mithilfe der API

Geben Sie die anpassbaren Details zum Benachrichtigungsplan im Attribut ratePlanDetails an im Anfragetext einer POST-Anfrage, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Um einen anpassbaren Benachrichtigungsplan festzulegen, geben Sie die folgenden Werte in die ratePlanDetails des Anfragetexts ein:

Weitere Informationen zu den Konfigurationseigenschaften, die bei der Angabe von anpassbare Details zum Benachrichtigungsplan, siehe Details zum Preisplan Konfigurationseinstellungen.

Im Folgenden wird beispielsweise ein anpassbarer Benachrichtigungsplan auf Aggregationsbasis definiert. auf 1 Monat festgelegt.

$ 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

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

Sie können die angestrebte Anzahl von Transaktionen für einen App-Entwickler festlegen, wenn dieser das Angebot akzeptiert und Sie können den Wert später aktualisieren.

Die angestrebte Anzahl von Transaktionen beim Akzeptieren des Preisplans festlegen

Wenn Sie den Preisplan akzeptieren, geben Sie zum Festlegen der Zielanzahl von Transaktionen die quotaTarget im Anfragetext in einer POST-Anfrage an den /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Lege quotaTarget auf eine positive Ganzzahl oder 0 fest, um Benachrichtigungen für die App zu deaktivieren Entwickler. Wenn keine Angabe erfolgt, wird quotaTarget standardmäßig auf 0 gesetzt.

Die folgende Anfrage legt beispielsweise die angestrebte Anzahl von Transaktionen auf 4.000 fest, wenn die App den 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

Die angestrebte Anzahl von Transaktionen beim Aktualisieren des akzeptierten Preisplans festlegen

Um die Zielanzahl von Transaktionen festzulegen, können Sie den akzeptierten Preisplan aktualisieren und das Attribut quotaTarget im Anfragetext einer PUT-Anfrage an den /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} . Setzen Sie quotaTarget auf eine positive Ganzzahl oder auf 0, um die Funktion zu deaktivieren Benachrichtigungen für den App-Entwickler. Wenn keine Angabe erfolgt, wird quotaTarget standardmäßig auf 0 gesetzt.

Die {developer_rateplan_id} wird in der Antwort zurückgegeben, wenn Sie den veröffentlichter Tarifplan.

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 Entwicklerpreis abrufen indem Sie eine GET-Anfrage an /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, Dabei ist {developer_id} die E-Mail-Adresse des Entwicklers. Weitere Informationen Siehe Alle von den Anbietern akzeptierten Preispläne ansehen Entwickler.

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@meinunternehmen.de“
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",

   "quotaTarget": 4.000,
   "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