Preispläne verwalten

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

Sie können Preispläne über die Benutzeroberfläche und die API verwalten, wie in den folgenden Abschnitten beschrieben.

Die Seite „Preispläne“ erkunden

Rufen Sie die Seite mit den Preisplänen wie unten beschrieben auf.

Edge

Um Preispläne in der Edge-Benutzeroberfläche anzuzeigen, greifen Sie auf die Seite mit den Preisplänen zu:

  1. Melden Sie sich bei apigee.com/edge an.
  2. Wählen Sie Veröffentlichen > Monetarisierung > Preispläne.

Die Seite "Preispläne" wird angezeigt.

Wie in der Abbildung hervorgehoben, können Sie auf der Seite „Preispläne“ Folgendes tun:

Classic Edge (Private Cloud)

Rufen Sie die Seite API-Pakete auf, um Preispläne mithilfe der Classic Edge-Benutzeroberfläche anzuzeigen:

  1. Melden Sie sich in http://ms-ip:9000 an. ms-ip ist hierbei IP-Adresse oder DNS-Name des Verwaltungsserverknotens.
  2. Wählen Sie Veröffentlichen > Pakete.

Auf der Seite API-Pakete werden die für jedes Paket definierten Preispläne angezeigt.

Auf der Seite „Preispläne“ können Sie:

Tarifplan erstellen

So erstellen Sie einen Preisplan:

  1. Rufen Sie die Seite "Tarifpakete" auf.
  2. Klicken Sie auf + Preisplan.
  3. Konfigurieren Sie im oberen Bereich die folgenden Felder:
    Feld Beschreibung Standard Erforderlich
    Name des Tarifpakets Name Ihres Preisplans.

    HINWEIS: Der Name darf innerhalb eines API-Produktsets nur einmal vorkommen. Zwei Tarife im selben Produktset können nicht denselben Namen haben.

    Ja
    Preisplantyp Preisplantyp. Wählen Sie einen Wert aus der Drop-down-Liste aus. Eine Liste der gültigen Preisplantypen finden Sie unter Unterstützte Preisplantypen. Ja
    Produktset API-Produktpaket. Wählen Sie einen Wert aus der Drop-down-Liste aus. Weitere Informationen zu API-Produktsets finden Sie unter API-Produktsets verwalten.

    Wenn Sie ein Produktpaket auswählen, das mehr als ein API-Produkt enthält, müssen Sie festlegen, ob für jedes API-Produkt ein eigener Tarif oder ein allgemeiner Tarif, der für alle API-Produkte gilt, konfiguriert werden sollen.

    Ja
    Zielgruppe Zielgruppe, die auf den Preisplan zugreifen kann. Wählen Sie einen der folgenden Werte aus der Dropdown-Liste aus:
    • Alle: Alle Entwickler.
    • Entwickler: Entwickler oder Unternehmen. Geben Sie den Namen des Entwicklers oder das Unternehmen ein. Während der Eingabe wird eine Liste der Entwickler/Unternehmen, die den String enthalten, in einem Drop-down-Menü angezeigt. Klicken Sie in der Drop-down-Liste auf den Namen des Entwicklers oder des Unternehmens.
    • Entwicklerkategorie: Entwicklerkategorie. Wählen Sie die Entwicklerkategorie aus der Drop-down-Liste aus.

      Konfigurieren Sie die Entwicklerkategorien nach Bedarf, wie unter Entwicklerkategorien verwalten beschrieben.

    Alle Nein
    Startdatum Datum, an dem der Preisplan in Kraft tritt. Geben Sie ein Startdatum ein oder wählen Sie im Kalender ein Datum aus. Heute Nein
    Enddatum Datum, an dem der Preisplan endet. Wenn Sie ein Enddatum angeben möchten, aktivieren Sie den Schalter Hat Enddatum, und geben Sie ein Enddatum ein oder wählen Sie ein Datum im Kalender aus.

    HINWEIS: Der Preisplan gilt bis zum Ende des Tages des angegebenen Datums. Wenn Sie einen Preisplan beispielsweise am 1. Dezember 2018 auslaufen lassen möchten, sollten Sie den Wert „endDate“ auf 30.11.2018 festlegen. In diesem Fall läuft der Preisplan am 30. November 2018 am Tagesende aus. werden alle Anfragen ab dem 1. Dezember 2018 blockiert.

    Keine Nein
    Sichtbar für Portale Legen Sie fest, ob der Preisplan öffentlich oder privat ist. Weitere Informationen finden Sie unter Preispläne für öffentliche und private Angebote. Aktiviert Nein
  4. Konfigurieren Sie die Gebühren für den Preisplan. Weitere Informationen finden Sie unter Gebühren für einen Preisplan konfigurieren.
    HINWEIS: Gilt nicht für anpassbare Benachrichtigungspläne.
  5. Wenn Sie ein Produktset auswählen, das mehr als ein API-Produkt enthält, legen Sie im Abschnitt Spezifischer oder allgemeiner Preisplan die folgenden Einstellungen fest:
    HINWEIS: Dieser Schritt gilt nicht für anpassbare Benachrichtigungspläne.
    Feld Beschreibung Standard
    Jedes Produkt einzeln konfigurieren Flag, das angibt, ob für jedes API-Produkt ein individueller Preisplan konfiguriert werden soll. Deaktiviert
    Das Freemium-Angebot für jedes Produkt einzeln konfigurieren Flag, das angibt, ob für jedes API-Produkt ein Freemium-Tarif konfiguriert werden soll. Deaktiviert
    Produkt auswählen Wenn Sie eine oder beide Markierungen aktivieren, müssen Sie jedes Produkt einzeln aus der Drop-down-Liste auswählen und die zugehörigen Preisplandetails konfigurieren.

    HINWEIS: Sie müssen alle Produkte im Produktset konfigurieren.

  6. Konfigurieren Sie die Preisplandetails basierend auf dem ausgewählten Preisplantyp:
    <ph type="x-smartling-placeholder">
  7. Klicken Sie auf eine der folgenden Optionen:
    Schaltfläche Beschreibung
    Als Entwurf speichern Speichern Sie den Preisplan als Entwurf.

    Der Preisplan ist für App-Entwickler erst sichtbar, wenn Sie ihn veröffentlichen. Sie können jedes Feld in einem Entwurf eines Preisplans bearbeiten.

    Neuen Plan veröffentlichen Veröffentlichen Sie den Plan.

    HINWEIS: Nachdem Sie einen Preisplan veröffentlicht haben, können Sie das Enddatum nur ändern, wenn es noch nicht festgelegt ist. Sie können einen Preisplan nach seiner Veröffentlichung nicht mehr löschen, aber Sie können den Preisplan ablaufen und durch einen zukünftigen Preisplan ersetzen, wie unter Veröffentlichten Preisplan ablaufen lassen beschrieben.

  8. Hängen Sie die Richtlinie Prüfung der Monetarisierungslimits an die API-Proxys an, die mit den im Preisplan enthaltenen API-Produkten verknüpft sind. Die Richtlinie zur Überprüfung der Monetarisierungslimits erzwingt Monetarisierungslimits für die API-Proxys und stellt sicher, dass alle Fehler korrekt in Analyse- und Monetarisierungsberichte. Weitere Informationen finden Sie unter Monetarisierungslimits für API-Proxys erzwingen

Preisplan bearbeiten

Sie können alle Felder in einem Preisplanentwurf bearbeiten, mit Ausnahme von Produktset, Typ und Zielgruppe. Nachdem Sie einen Preisplan veröffentlicht haben, können Sie das Enddatum nur bearbeiten, wenn kein Enddatum angegeben wurde.

So bearbeiten Sie einen Preisplan:

  1. Rufen Sie die Seite "Tarifpakete" auf.
  2. Klicken Sie in die Zeile des Preisplans, den Sie bearbeiten möchten.
    Der Preisplan wird angezeigt.
  3. Bearbeiten Sie die Preisplanfelder nach Bedarf.
    HINWEIS: Nachdem Sie einen Preisplan veröffentlicht haben, können Sie das Enddatum nur ändern, wenn es noch nicht festgelegt ist.
  4. Klicken Sie auf eine der folgenden Optionen:
    Schaltfläche Beschreibung
    Entwurf aktualisieren (Preispläne-Entwürfe) Speichern Sie den Preisplan als Entwurf.

    Der Preisplan ist für App-Entwickler erst sichtbar, wenn Sie ihn veröffentlichen. Sie können jedes Feld in einem Entwurf eines Preisplans bearbeiten.
    Entwurf veröffentlichen (Tarifpläne) Veröffentlichen Sie den Preisplan.

    HINWEIS: Nachdem Sie einen Preisplan veröffentlicht haben, können Sie das Enddatum nur ändern, wenn es noch nicht festgelegt ist. Sie können einen Preisplan nach seiner Veröffentlichung nicht mehr löschen, aber Sie können den Preisplan ablaufen und durch einen zukünftigen Preisplan ersetzen, wie unter Veröffentlichten Preisplan ablaufen lassen beschrieben.
    Aktualisiertes Enddatum (veröffentlichte Preispläne) Legen Sie das Enddatum für einen veröffentlichten Plan fest.

    HINWEIS: Nachdem das Enddatum für einen veröffentlichten Preisplan festgelegt wurde, kann es nicht mehr geändert werden.

Entwurf eines Preisplans löschen

Löschen Sie einen nicht mehr benötigten Preisplanentwurf.

HINWEIS: Sie können einen veröffentlichten Preisplan nicht löschen.

So löschen Sie einen Entwurf eines Preisplans:

  1. Rufen Sie die Seite "Tarifpakete" auf.
  2. Bewegen Sie den Cursor über den Preisplan aus, den Sie löschen möchten, um das Aktionsmenü anzuzeigen.
  3. Klicken Sie auf .
  4. Klicken Sie auf Löschen, um die Aktion zu bestätigen.

Preispläne mithilfe der API verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie Preispläne mithilfe der API verwalten.

Tarifpläne mit der API erstellen

Um einen Preisplan zu erstellen, senden Sie eine POST-Anfrage an /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, Dabei ist {monetizationpackage_id} die ID des API-Produktpakets, für das Sie die Tarifplan (die ID wird in der Antwort zurückgegeben, wenn Sie das API-Produktset erstellen).

Wenn Sie einen Preisplan erstellen, müssen Sie im Anfragetext Folgendes angeben:

  • Organisations-ID
  • API-Produktpaket-ID
  • Name des Preisplans
  • Beschreibung des Preisplans
  • Umfang des Tarifplans (gilt für alle Entwickler oder nur für einen bestimmten Entwickler, Unternehmen oder Entwicklerkategorie)
  • Datum, an dem der Preisplan in Kraft tritt
  • Währung für den Preisplan
  • Ob der Preisplan veröffentlicht werden soll
  • Ob der Preisplan öffentlich oder privat ist

Es gibt weitere Einstellungen, die Sie optional vornehmen können, wie z. B. den Zeitraum, in dem die Zahlung erfolgt. fällig (z. B. 30 Tage). Siehe Konfigurationseigenschaften für Preispläne.

Wenn Sie einen Tarifplan (außer einem Tarif nur mit Gebühren) für ein API-Produktpaket erstellen, das mehr als eines Produkts können Sie den Tarif auf ein bestimmtes Produkt im Produktset anwenden. Sie tun dies durch in der Anfrage identifiziert wird. Wenn Sie kein Produkt identifizieren, ist der Plan wird auf alle Produkte im API-Produktset angewendet.

In den folgenden Abschnitten wird beschrieben, wie Preispläne erstellt werden:

Standardtarif mit der API erstellen

Legen Sie zum Erstellen eines Standardpreisplans das Attribut type auf STANDARD fest. wie im folgenden Beispiel gezeigt.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password

Tarifplan für Entwickler oder Unternehmen mithilfe der API erstellen

Wenn Sie den Preisplan auf einen bestimmten Entwickler oder ein bestimmtes Unternehmen anwenden möchten, setzen Sie den Wert type auf Developer. Außerdem müssen Sie den Entwickler oder das Unternehmen in der Anfrage angeben. zur Identifizierung der ID, des rechtsgültigen Namens und des Namens des Entwicklers des Unternehmens.

Mit dem folgenden Auszug wird beispielsweise ein Preisplan für Dev Five erstellt. Entwickler:

...
     "type": "DEVELOPER",
       "developer" : {
        "id" : "0mkKu1PALUGfjUph",
        "legalName" : "DEV FIVE",
        "name" : "Dev Five"
      }
...

Preisplan für Entwicklerkategorie mithilfe der API erstellen

Um den Preisplan auf eine Entwicklerkategorie anzuwenden, setzen Sie den Wert type auf Developer_Category. Außerdem müssen Sie die Entwicklerkategorie in der Anfrage angeben. Beispiel:

...
     "type": "DEVELOPER_CATEGORY",
       "developerCategory" : {
        "id" : "5e172299-8232-45f9-ac46-40076139f373",
        "name" : "Silver",
        "description" : "Silver category"
      }
...

Mit der API einen produktspezifischen API-Preisplan erstellen

Wenn Sie einen Preisplan für API-Produktpakete mit mehreren API-Produkten erstellen, können Sie Preisplandetails für API-Produkte einzeln angeben.

So wird beispielsweise ein Umsatzbeteiligungsplan mit zwei API-Produkten erstellt:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Multi-product rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Multi-product rate plan",
     "displayName" : "Multi-product rate plan",
     "monetizationPackage": {
      "id": "mypackage",
      ...
     },
     "organization": {
      "id": "{org_name}",
      ...
     },
     "published": true,
     "isPrivate" : false,
     "ratePlanDetails": [
     {
        "ratePlanRates":[{
            "revshare":0,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product1","displayName":"Product1"},
       "customPaymentTerm":false
     },
     {
        "ratePlanRates":[{
            "revshare":10,
            "startUnit":0,
            "type":"REVSHARE",
            "endUnit":null
        }],
       "revenueType":"NET",
       "type":"REVSHARE"
       "currency":{...},
       "product":{"id":"product2","displayName":"Product2"},
       "customPaymentTerm":false
     }
     ],
     "startDate": "2019-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/rate-plans" \
-u email:password

Um dem my-package API-Produktset ein API-Produkt hinzuzufügen, müssen Sie die Preisplandetails für das API-Produkt im Anfragetext, wie unter API-Produkt einem API-Produktpaket mit API-produktspezifischen Preisplänen hinzufügen beschrieben.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [
    {
        "id": "my-package_multi-product-rate-plan",
        "ratePlanDetails": [
        {
            "ratePlanRates":[{
                "revshare":20,
                "startUnit":0,
                "type":"REVSHARE",
                "endUnit":null
             }],
             "revenueType":"NET",
             "type":"REVSHARE"
             "currency":{...},
             "customPaymentTerm":false
         }]
    }]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/my-package/products/product3" \
-u email:password

Preisplan mithilfe der API als öffentlich oder privat festlegen

Beim Erstellen eines Tarifplans können Sie mithilfe der Funktion isPrivate im Anfragetext. Wenn true festgelegt ist, wird der Preisplan bleiben privat. Weitere Informationen finden Sie unter Öffentlich im Vergleich zu Tarifen für bestimmte Zielgruppen.

Mit dem folgenden Befehl wird beispielsweise ein Tarif für bestimmte Zielgruppen erstellt:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "published": true,
     "isPrivate" : true,
     "ratePlanDetails": [
     {
      …
     }
     ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u email:password