Anpassbaren Benachrichtigungsplan konfigurieren

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

Einführung

In einem anpassbaren Benachrichtigungsplan kann der API-Anbieter die Zielanzahl von 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 ist.

Konfigurieren eines anpassbaren Benachrichtigungsplans über die Benutzeroberfläche

Konfigurieren Sie anpassbare Benachrichtigungspläne, wie unten beschrieben.

Edge

Wenn Sie einen anpassbaren Benachrichtigungsplan über die Edge-Benutzeroberfläche konfigurieren möchten, wählen Sie beim Hinzufügen oder Bearbeiten eines Preisplans den Preisplantyp Anpassbare Benachrichtigung aus und konfigurieren Sie im Abschnitt Anpassbare Benachrichtigung die folgenden Informationen:

Field Beschreibung Standard
Berechnungshäufigkeit Zeitraum, in dem das Transaktionsvolumen (oder das auf benutzerdefinierte Attribute bezogene Volumen) berechnet wird. Wählen Sie die Anzahl der Monate aus (1 bis 24 Monate). 1 Monat

Wenn Sie benutzerdefinierte Attribute für Ihr API-Produkt definiert haben, können Sie einen benutzerdefinierten Bewertungsparameter konfigurieren, um einen Transaktionszähler auf der Grundlage eines benutzerdefinierten Attributs zu definieren.

Beispielsweise müssen Sie eventuell Folgendes tun:

  • Sie berechnen Entwicklern einen variablen Betrag basierend auf einem Wert, der in der Nachricht eines API-Aufrufs angegeben ist.
    Beispiel: Sie möchten App-Entwicklern die Anzahl der in der API-Anfrage übertragenen Byte in Rechnung stellen.
  • Fassen Sie mehrere API-Aufrufe in einer einzigen Transaktion zusammen.
    Wählen Sie in diesem Fall „Benutzerdefinierten Bewertungsparameter verwenden“ und dann das benutzerdefinierte Attribut aus der Drop-down-Liste aus.

Weitere Informationen finden Sie unter Preisplan mit benutzerdefinierten Attributen konfigurieren.

Classic Edge (Private Cloud)

So konfigurieren Sie anpassbare Benachrichtigungspläne mit der Classic Edge-Benutzeroberfläche:

  1. Wählen Sie im Fenster "Preisplan" auf dem Tab "Plandetails" im Feld Preisplantyp die Option Benachrichtigung anpassen aus.

    Informationen zum Zugriff auf das Preisplanfenster finden Sie unter Preisplan über die Benutzeroberfläche erstellen.

  2. Geben Sie im Feld Verlängerungszeitraum die Anzahl der Monate an, nach denen der Tarif automatisch verlängert wird (es sei denn, der Entwickler kündigt die Vereinbarung vor diesem Datum). Wenn Sie diesen Wert auf 0 setzen, bleibt der Plan so lange gültig, bis der Entwickler ihn beendet.
  3. Klicken Sie unter „Allgemeiner Preisplan“ auf Details.
  4. Legen Sie als Aggregationsgrundlage den Zeitraum fest, über den das Transaktionsvolumen aggregiert wird. Wählen Sie eine Zahl zwischen 1 und 24 Monaten aus. Der Standardwert ist 1 Monat.
  5. Klicken Sie auf Übernehmen und schließen.
  6. Klicken Sie auf Entwurf speichern.
  7. Veröffentlichen Sie den Plan nur, wenn Sie sicher sind, dass er endgültig ist. Informationen zum Festlegen des Veröffentlichungsdatums und zum Veröffentlichen des Plans finden Sie unter Preispläne veröffentlichen.

    Nachdem Sie einen Preisplan veröffentlicht haben, können Sie nur noch das Enddatum ändern. Sie können einen Preisplan nach seiner Veröffentlichung nicht mehr löschen. Sie können ihn jedoch ablaufen und durch einen zukünftigen Preisplan ersetzen, wie unter Veröffentlichten Preisplan ablaufen beschrieben.

Konfigurieren eines anpassbaren Benachrichtigungsplans mithilfe der API

Geben Sie die anpassbaren Details des Benachrichtigungsplans im Attribut 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 die folgenden Werte im Feld „ratePlanDetails“ des Anfragetexts an:

Property Wert
type Setze diese Property auf USAGE_TARGET.
meteringType Setze diese Property auf DEV_SPECIFIC.
duration Legen Sie den Zeitraum für die Aggregationsgrundlage zusammen mit durationType fest. Legen Sie für anpassbare Benachrichtigungstarife einen ganzzahligen Wert zwischen 1 und 24 fest.
durationType

Legen Sie den Zeitraum für die Aggregationsgrundlage zusammen mit durationType fest. Legen Sie für anpassbare Benachrichtigungstarife diesen Wert auf MONTH fest.

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

Im Folgenden wird beispielsweise ein anpassbarer Benachrichtigungsplan mit einer auf 1 Monat festgelegten Aggregationsgrundlage 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 von Transaktionen für jeden App-Entwickler mithilfe der API festlegen

Für jeden App-Entwickler, der den anpassbaren Benachrichtigungstarif akzeptiert hat, musst du die Zielanzahl von Transaktionen festlegen. Sie können konfigurieren, ob und wann Benachrichtigungen gesendet werden, je nachdem, wann ein bestimmter Prozentsatz der Zielzahl erreicht wird, z. B. 90%, 100 % oder 150%. Zusätzliche Transaktionen werden nicht blockiert, nachdem die Zielanzahl erreicht ist.

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

Zielanzahl von Transaktionen beim Akzeptieren des Preisplans festlegen

Geben Sie beim Akzeptieren des Preisplans in einer POST-Anfrage an die Ressource /organizations/{org_name}/developers/{developer_id}/developer-rateplans das Attribut quotaTarget im Anfragetext an, um die Zielanzahl von Transaktionen festzulegen. Setze quotaTarget auf eine positive Ganzzahl oder 0, um Benachrichtigungen für den App-Entwickler zu deaktivieren. Wenn keine Angabe erfolgt, wird für quotaTarget standardmäßig „0“ verwendet.

Mit 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

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

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

Die folgende Anfrage aktualisiert die Zielanzahl der Transaktionen auf 4.000.

email:password