Preispläne verwalten

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

Verwalten Sie Preispläne mithilfe der Benutzeroberfläche und der API, wie in den folgenden Abschnitten beschrieben.

Seite mit Preisplänen

Rufen Sie wie unten beschrieben die Seite „Preispläne“ auf.

Edge

Rufen Sie die Seite „Preispläne“ auf, um Preispläne in der Edge-Benutzeroberfläche anzuzeigen:

  1. Melden Sie sich unter apigee.com/edge an.
  2. Wählen Sie in der linken Navigationsleiste Veröffentlichen > Monetarisierung > Preispläne aus.

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 mit der Classic Edge-Benutzeroberfläche anzuzeigen:

  1. Melden Sie sich bei http://ms-ip:9000 an, wobei ms-ip die IP-Adresse oder der DNS-Name des Knotens des Verwaltungsservers ist.
  2. Wählen Sie in der oberen Navigationsleiste Veröffentlichen > Pakete aus.

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

Auf der Seite „Preispläne“ haben Sie folgende Möglichkeiten:

Preisplan 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-Produktpakets nur einmal vorkommen. Zwei Pläne 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-Produktset. 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 angeben, ob Sie für jedes API-Produkt einen individuellen Preisplan oder einen allgemeinen Preisplan konfigurieren möchten, der für alle API-Produkte gilt.

    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 die Zeichenfolge enthalten, in einem Drop-down-Menü angezeigt. Klicken Sie in der Drop-down-Liste auf den Namen des Entwicklers oder Unternehmens.
    • Entwicklerkategorie: Entwicklerkategorie. Wähle 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 festlegen möchten, aktivieren Sie den Umschalter Hat Enddatum und geben Sie ein Enddatum ein oder wählen Sie ein Datum mithilfe des Kalenders aus.

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

    Keine Nein
    Für Portale sichtbar Legen Sie fest, ob der Preisplan öffentlich oder privat sein soll. Weitere Informationen finden Sie unter Öffentliche und private Preispläne im Vergleich. Aktiviert Nein
  4. Konfigurieren Sie Gebühren für den Preisplan. Weitere Informationen finden Sie unter Gebühren für einen Tarifplan konfigurieren.
    HINWEIS: Nicht zutreffend für anpassbare Benachrichtigungspläne.
  5. Wenn Sie ein Produktpaket auswählen, das mehr als ein API-Produkt enthält, legen Sie im Bereich 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 Tarifplan 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 Flags aktivieren, müssen Sie jedes Produkt einzeln aus der Drop-down-Liste auswählen und die zugehörigen Preisplandetails konfigurieren.

    HINWEIS: Achten Sie darauf, alle Produkte im Produktset zu konfigurieren.

  6. Konfigurieren Sie die Preisplandetails basierend auf dem ausgewählten Preisplantyp:
  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 des Preisplans bearbeiten.

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

    HINWEIS: Nach dem Veröffentlichen eines Preisplans können Sie das Enddatum nur ändern, wenn es noch nicht festgelegt wurde. Sie können einen Preisplan nach der 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.

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

Preisplan bearbeiten

Mit Ausnahme des Produktpakets, des Typs und der Zielgruppe können Sie alle Felder im Entwurf des Preisplans bearbeiten. Nachdem Sie einen Preisplan veröffentlicht haben, können Sie nur das Enddatum bearbeiten, und zwar nur, 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 Preisplanbereich 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 wurde.
  4. Klicken Sie auf eine der folgenden Optionen:
    Schaltfläche Beschreibung
    Entwurf aktualisieren (Entwurf für Preispläne) 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 des Preisplans bearbeiten.
    Entwurf veröffentlichen (Entwurf für Preisplä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 wurde. Sie können einen Preisplan nach der 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.
    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 dieser nicht mehr geändert werden.

Entwurf eines Preisplans löschen

Löschen Sie einen Entwurf für einen Preisplan, wenn er nicht mehr benötigt wird.

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

So löschen Sie einen Entwurf für einen Preisplan:

  1. Rufen Sie die Seite "Tarifpakete" auf.
  2. Bewegen Sie den Mauszeiger auf den Preisplan, den Sie löschen möchten, um das Aktionsmenü aufzurufen.
  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.

Preisplä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, wobei {monetizationpackage_id} die ID des API-Produktpakets ist, für das Sie den Preisplan erstellen. Die ID wird in der Antwort zurückgegeben, wenn Sie das API-Produktpaket erstellen.

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

  • Organisations-ID
  • API-Produktpaket-ID
  • Name des Preisplans
  • Beschreibung des Preisplans
  • Umfang des Preisplans (ob er für alle Entwickler oder nur für einen bestimmten Entwickler, ein bestimmtes Unternehmen oder eine bestimmte Entwicklerkategorie gilt)
  • 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 angeben können, z. B. den Zeitraum, in dem die Zahlung fällig ist (z. B. 30 Tage). Weitere Informationen finden Sie unter Konfigurationseigenschaften für Preispläne.

Wenn Sie einen Preisplan für ein API-Produktpaket erstellen, das mehrere Produkte umfasst, können Sie den Tarif auf ein bestimmtes Produkt im Produktpaket anwenden. Dazu geben Sie das Produkt in der Anfrage an. Wenn Sie kein Produkt angeben, wird der Tarif auf alle Produkte im API-Produktpaket angewendet.

In den folgenden Abschnitten wird beschrieben, wie Sie Preispläne erstellen:

Standardpreisplan mit der API erstellen

Wenn Sie einen Standardpreisplan erstellen möchten, legen Sie 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, legen Sie den Wert type auf Developer fest. Außerdem musst du in der Anfrage den Entwickler oder das Unternehmen identifizieren und dabei die ID, den rechtsgültigen Namen und den Namen des Entwicklers des Unternehmens angeben.

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

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

Preisplan für Entwicklerkategorien mit der API erstellen

Wenn Sie den Preisplan auf eine Entwicklerkategorie anwenden möchten, legen Sie den Wert type auf Developer_Category fest. Außerdem müssen Sie in der Anfrage die Entwicklerkategorie angeben. Beispiel:

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

Einen produktspezifischen API-Tarif mithilfe der API erstellen

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

Im folgenden Beispiel wird 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

Wenn Sie dem API-Produktpaket my-package ein API-Produkt hinzufügen möchten, müssen Sie im Anfragetext die Preisplandetails für das API-Produkt angeben, wie unter API-Produkt zu einem API-Produktpaket mit produktspezifischen API-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 über die API als öffentlich oder privat festlegen

Beim Erstellen eines Preisplans können Sie mithilfe des Attributs isPrivate im Anfragetext angeben, ob er öffentlich oder privat sein soll. Mit der Einstellung true ist der Preisplan privat. Weitere Informationen finden Sie unter Öffentliche und private Preispläne.

Mit der folgenden Abfrage 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

Tarifplan mit der API veröffentlichen

Wenn Sie einen Preisplan veröffentlichen möchten, setzen Sie den Wert der Property published beim Erstellen des Preisplans auf "true". Entwickler können den Preisplan ab dem Datum aufrufen, das in der Property startDate für den Plan angegeben ist.

Im folgenden Beispiel wird ein Preislistenplan erstellt und veröffentlicht (nur ein Teil der Anfrage wird angezeigt):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "true",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Preisplanentwurf mithilfe der API speichern

Wenn Sie einen Preisplan speichern möchten, ohne ihn zu veröffentlichen, setzen Sie den Wert der Property published beim Erstellen des Preisplans auf "false".

Im folgenden Beispiel wird ein Preislistenplan erstellt und als Entwurf gespeichert (nur ein Teil der Anfrage wird angezeigt):

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flat rate card plan",
     "developer":null,
     "developerCategory":null,
     "advance": "false",
     …
     "published": "false",
     "ratePlanDetails": [
     …
      ],
     …
     "type": "RATECARD"
     }],
     …
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Preisplanentwurf mit der API bearbeiten

Um einen Preisplanentwurf zu aktualisieren, senden Sie eine PUT-Anfrage an /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_Id}, wobei {package_id} die Identifikation des API-Pakets und {plan_Id} die Identifizierung des Preisplans ist. Wenn Sie die Aktualisierung vornehmen, müssen Sie im Anfragetext die aktualisierten Einstellungen und die ID des Preisplans angeben. Wenn Sie einen Preisplan aktualisieren, müssen Sie auch die ID des Preisplans angeben. Mit der folgenden Anfrage wird beispielsweise der Preisplanpreis in einem Preisplan mit der ID location_flat_rate_card_plan aktualisiert (die Aktualisierung ist hervorgehoben):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
      "id" : "location_flat_rate_card_plan",
      "name": "Flat rate card plan",
      "advance": "false",
      "currency": {
       "id" : "usd"
      },
      "description": "Flat rate card plan",
      "displayName" : "Flat rate card plan",
      "frequencyDuration": "30",
      "frequencyDurationType": "DAY",
      "earlyTerminationFee": "10",
      "monetizationPackage": {
       "id": "location"
      },
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "prorate": "false",
      "published": "false",
      "ratePlanDetails": [
      {
       "currency": {
        "id" : "usd"
       },
       "paymentDueDays": "30",
       "meteringType": "UNIT",
       "organization": {
        "id": "{org_name}"
       },
       "ratePlanRates": [
        {
         "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
         "type": "RATECARD",
         "rate": "0.15",
         "startUnit": "0"
        }
       ],
      "ratingParameter": "VOLUME",
      "type": "RATECARD"
      }],
      "recurringStartUnit": 1,
      "recurringType": "CALENDAR",
      "recurringFee": "10",
      "setUpFee": "10",
      "startDate": "2013-09-15 00:00:00",
      "type": "STANDARD"
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Die Antwort enthält den aktualisierten Preisplanpreis (nur ein Teil der Antwort wird angezeigt):

…
"ratePlanRates" : [ {
  "id" : "26b69b0b-9863-48c9-ba73-74a5b918fcec",
  "rate" : 0.15,
  "startUnit" : 0,
  "type" : "RATECARD"
} ],
…

Preispläne mithilfe der API ansehen

Sie können Preispläne mithilfe der Monetarisierungs-API aufrufen, wie in den folgenden Abschnitten beschrieben.

Alle Preispläne für eine Organisation mithilfe der API ansehen

Um alle Preispläne für eine Organisation anzusehen, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/rate-plans, wobei {org_name} der Name Ihrer Organisation ist.

Sie können die folgenden Abfrageparameter übergeben, um die Ergebnisse zu filtern:

Suchparameter Beschreibung
all Flag, das angibt, ob alle Preispläne zurückgegeben werden sollen. Bei Einstellung auf false wird die Anzahl der pro Seite zurückgegebenen Preispläne durch den Abfrageparameter size definiert. Die Standardeinstellung ist true.
size Anzahl der pro Seite zurückgegebenen API-Pakete. Wenn der Abfrageparameter all auf true festgelegt ist, wird dieser Parameter ignoriert.
page Nummer der Seite, die zurückgegeben werden soll (bei paginierten Inhalten). Wenn der Abfrageparameter all auf true gesetzt ist, wird dieser Parameter ignoriert.

Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/rate-plans" \
  -u email:password

Alle Preispläne für ein API-Produktpaket mithilfe der API ansehen

Wenn Sie alle Preispläne für ein API-Paket ansehen möchten, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans, wobei {package_id} die ID des API-Pakets ist (die Paket-ID wird zurückgegeben, wenn Sie das Monetarisierungspaket erstellen).

Standardmäßig werden in den Ergebnissen nur aktive, öffentliche und Standardpreispläne zurückgegeben. Einbeziehen:

  • Wenn Sie Preispläne entwerfen oder abgelaufen sind, legen Sie den Abfrageparameter current auf false fest (z. B. ?current=false).
  • Für private Preispläne legen Sie den Abfrageparameter showPrivate auf true fest (z. B. ?showPrivate=true).
  • Legen Sie bei allen Standardpreisplänen den Abfrageparameter standard auf true fest (z. B. ?standard=true).

Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
  -u email:password

Tarif für ein API-Paket mithilfe der API ansehen

Wenn Sie sich einen Tarifplan für ein API-Paket ansehen möchten, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, wobei {package_id} die ID des API-Pakets und {plan_id} die ID des Preisplans ist (die Paket-ID wird zurückgegeben, wenn Sie das Monetarisierungspaket erstellen, und die Preisplan-ID wird zurückgegeben, wenn Sie den Preisplan erstellen).

Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
  -u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

Alle aktiven Preispläne für einen Entwickler mithilfe der API ansehen

Wenn Sie alle aktiven Preispläne für einen Entwickler aufrufen möchten, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans, wobei {developer_id} die E-Mail-Adresse des Entwicklers ist.

Sie können die folgenden Abfrageparameter übergeben, um die Ergebnisse zu filtern:

Suchparameter Beschreibung
all Flag, das angibt, ob alle API-Pakete zurückgegeben werden sollen. Wenn false festgelegt ist, wird die Anzahl der pro Seite zurückgegebenen API-Pakete durch den Abfrageparameter size definiert. Die Standardeinstellung ist false.
size Anzahl der pro Seite zurückgegebenen API-Pakete. Der Standardwert ist 20. Wenn der Abfrageparameter all auf true festgelegt ist, wird dieser Parameter ignoriert.
page Nummer der Seite, die zurückgegeben werden soll (bei paginierten Inhalten). Wenn der Abfrageparameter all auf true gesetzt ist, wird dieser Parameter ignoriert.

Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
  -u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

Akzeptierten Preisplan für einen Entwickler mithilfe der API ansehen

Wenn Sie einen aktiven Preisplan für einen Entwickler aufrufen möchten, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}, wobei {developer_id} die E-Mail-Adresse des Entwicklers und {developer_rateplan_id} die ID des akzeptierten Preisplans ist, der in der Antwort zurückgegeben wird, wenn Sie den veröffentlichten Preisplan akzeptieren.

Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
  -u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
    "created" : "2018-01-25 20:01:54",
    "developer" : {
    },
    "id" : "a73s104-276f-45b3-8075-83d1046ea550",
    "nextCycleStartDate" : "2018-02-19 00:00:00",
    "nextRecurringFeeDate" : "2018-02-19 00:00:00",
    "prevRecurringFeeDate" : "2018-01-25 00:00:00",
    "ratePlan" : {
      "frequencyDuration" : 1,
      "frequencyDurationType" : "MONTH",
      "recurringFee" : 0.0000,
      "recurringStartUnit" : 19,
      "recurringType" : "CALENDAR",
      "setUpFee" : 0.0000,
      "type" : "STANDARD"
    },
    "startDate" : "2018-01-25 20:01:54",
    "updated" : "2018-01-25 20:01:54"
  }

Akzeptierten Preisplan für einen Entwickler, der ein API-Produkt enthält, mithilfe der API aufrufen

Wenn Sie einen akzeptierten Preisplan für einen Entwickler aufrufen möchten, der ein API-Produkt enthält, senden Sie eine GET-Anfrage an /mint/organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, wobei {developer_id} die ID des Entwicklers und /{product_id} die ID des Produkts ist.

Standardmäßig wird in den Ergebnissen nur ein öffentlicher Preisplan zurückgegeben. Wenn Sie einen Tarif für bestimmte Zielgruppen aufrufen möchten, legen Sie den Abfrageparameter showPrivate auf true fest (z. B. ?showPrivate=true).

Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
  -u email:password

Alle von einem Entwickler akzeptierten Preispläne über die API ansehen

Um von einem Entwickler akzeptierte Preispläne aufzurufen, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, wobei {developer_id} die ID des Entwicklers ist.

Sie können die folgenden Abfrageparameter übergeben, um die Ergebnisse zu filtern:

Suchparameter Beschreibung
all Flag, das angibt, ob alle API-Pakete zurückgegeben werden sollen. Wenn false festgelegt ist, wird die Anzahl der pro Seite zurückgegebenen API-Pakete durch den Abfrageparameter size definiert. Die Standardeinstellung ist false.
size Anzahl der pro Seite zurückgegebenen API-Pakete. Der Standardwert ist 20. Wenn der Abfrageparameter all auf true festgelegt ist, wird dieser Parameter ignoriert.
page Nummer der Seite, die zurückgegeben werden soll (bei paginierten Inhalten). Wenn der Abfrageparameter all auf true gesetzt ist, wird dieser Parameter ignoriert.

Beispiel:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
  -u email:password

Im Folgenden finden Sie ein Beispiel für die Antwort:

{
  "developerRatePlan" : [ {
     "created" : "2018-01-25 20:01:54",
     "developer" : { ...
     },
     "id" : "a73s104-276f-45b3-8075-83d1046ea550",
     "nextCycleStartDate" : "2018-02-19 00:00:00",
     "nextRecurringFeeDate" : "2018-02-19 00:00:00",
     "prevRecurringFeeDate" : "2018-01-25 00:00:00",
     "ratePlan" : {
       "frequencyDuration" : 1,
       "frequencyDurationType" : "MONTH",
       "recurringFee" : 0.0000,
       "recurringStartUnit" : 19,
       "recurringType" : "CALENDAR",
       "setUpFee" : 0.0000,
       "type" : "STANDARD"
     },
     "startDate" : "2018-01-25 20:01:54",
     "updated" : "2018-01-25 20:01:54"
   }],
   "totalRecords" : 1
}

Preisplanentwurf über die API löschen

Um einen Preisplanentwurf zu löschen, senden Sie eine DELETE-Anfrage an /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, wobei {plan_Id} die Identifikation des zu löschenden Preisplans und {package_id} die Identifizierung des API-Pakets für den Preisplan ist. Beispiel:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans/location_flat_rate_card_plan" \
-u email:password

Konfigurationsattribute für Preispläne

Beim Erstellen eines Tarifplans mit der API können Sie die folgenden Konfigurationseinstellungen festlegen.

Name Beschreibung Standard Erforderlich?
advance

Nur für wiederkehrende Gebühren gültig. Flag, das angibt, ob die wiederkehrende Gebühr im Voraus berechnet wird. Gültige Werte sind:

  • true: Die wiederkehrende Gebühr wird im Voraus erhoben. Beträgt der Zeitraum beispielsweise 1 Monat, wird die wiederkehrende Gebühr auf der Rechnung erhoben, die mit dem Ende des vorherigen Abrechnungsmonats generiert wird.
  • false: Die wiederkehrende Gebühr wird am Ende des Zeitraums in Rechnung gestellt. Beträgt der Zeitraum beispielsweise 1 Monat, wird die wiederkehrende Gebühr auf die Rechnung gestellt, wenn der aktuelle Abrechnungsmonat endet. Das ist die Standardeinstellung.
false Nein
contractDuration

Länge des Vertrags für den Tarif zusammen mit contractDurationType. Wenn Sie beispielsweise eine Vertragslaufzeit von 6 Monaten angeben möchten, setzen Sie contractDuration auf 6 und contractDurationType auf MONTH.

Nein
contractDurationType

Länge des Vertrags für den Tarif zusammen mit contractDuration. Gültige Werte sind:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
Nein
currency

Währung, die für den Preisplan verwendet wird. Geben Sie den ISO 4217-Code für die Währung an, z. B. usd für US-Dollar oder chf für Schweizer Franken.

Ja
description

Beschreibung des Preisplans.

Ja
developer

Entwickler-ID (E-Mail-Adresse) Geben Sie dies nur für Preispläne für Entwickler an.

Nein
developerCategory

Entwicklerkategorie-ID. Geben Sie dies nur für Preispläne für Entwicklerkategorien an.

Nein
displayName

Nutzerfreundlicher Anzeigename für den Preisplan.

Ja
earlyTerminationFee

Es fällt eine einmalige Gebühr an, wenn der Entwickler das Abo vor dem Verlängerungszeitraum beendet.

Nein
endDate

Datum, an dem der Plan endet. Nach diesem Datum können Entwickler den Preisplan nicht mehr aufrufen. Wenn der Preisplan nicht an einem bestimmten Datum enden soll, geben Sie für endDate einen Nullwert an.

Der Preisplan gilt bis zum Ende des Tages des angegebenen Datums. Wenn Sie beispielsweise einen Preisplan am 1. Dezember 2016 auslaufen lassen möchten, sollten Sie für endDate den Wert 2016-11-30 festlegen. In diesem Fall läuft der Preisplan am Ende des Tages am 30. November 2016 ab. Alle Anfragen am 1. Dezember 2016 werden blockiert.

HINWEIS: Wenn Sie sich den Preisplan mit der API ansehen, wird der Zeitstempel endDate als YYYY-MM-DD 00:00:00 angegeben, was irreführend sein kann.

Nein
freemiumDuration

Zeitraum für den Freemium-Zeitraum zusammen mit freemiumDurationType. Wenn Sie beispielsweise einen Freemium-Zeitraum von 30 Tagen festlegen möchten, setzen Sie freemiumDuration auf 30 und freemiumDurationType auf DAY.

Nein
freemiumDurationType

Zeitraum für den Freemium-Zeitraum zusammen mit freemiumDuration. Gültige Werte sind:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
Nein
freemiumUnit

Freemium-Menge. Der Wert kann die Anzahl der Transaktionen oder die Anzahl der Einheiten sein, die zu einem benutzerdefinierten Attribut gehören, das in der Transaktionsaufzeichnungsrichtlinie aufgezeichnet wurde.

Nein
frequencyDuration

Nur für wiederkehrende Gebühren gültig. Zeitraum zwischen wiederkehrenden Gebühren in Verbindung mit frequencyDurationType. Wenn Sie beispielsweise angeben möchten, dass der Zeitraum zwischen den Gebührengebühren 30 Tage beträgt, setzen Sie frequencyDuration auf 30 und frequencyDurationType auf DAY.

Nein
frequencyDurationType Nur für wiederkehrende Gebühren gültig. Zeitraum zwischen wiederkehrenden Gebühren in Verbindung mit frequencyDuration. Gültige Werte:
  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR
Nein
isPrivate Flag, das angibt, ob der Preisplan öffentlich oder privat ist. Die Standardeinstellung ist false (öffentlich). Weitere Informationen finden Sie unter Öffentliche und private Preispläne. Nein
monetizationPackage

API-Produktpaket-ID für den Preisplan.

Nein
name

Name des Preisplans.

Ja
organization

Organisations-ID für den Preisplan.

Ja
paymentDueDays

Nur für wiederkehrende Gebühren gültig. Anzahl der Tage, an denen Gebühren fällig sind. Legen Sie den Wert beispielsweise auf 30 fest, um anzugeben, dass Gebühren in 30 Tagen fällig sind.

Nein
proRate

Nur für wiederkehrende Gebühren gültig. Angabe, ob die wiederkehrende Gebühr anteilig berechnet wird, wenn ein Entwickler einen Plan im Laufe eines Monats startet oder beendet. Gültige Werte sind:

  • true: Die anfängliche Gebühr wird anteilig anhand der Anzahl der Tage bis zum Ende des Zeitraums oder der Anzahl der im Zeitraum verwendeten Tage berechnet.
  • false: Dem Entwickler wird die volle Grundgebühr berechnet, unabhängig davon, wann der Entwickler den Tarif beginnt oder endet. Das ist die Standardeinstellung.
false Nein
published

Flag, das angibt, ob der Preisplan zur Ansicht durch Entwickler veröffentlicht werden soll. Gültige Werte sind:

  • true: Veröffentlichen des Preisplans
  • false: Der Preisplan wird nicht veröffentlicht.
Ja
ratePlanDetails

Details zum Preisplan (siehe Konfigurationseigenschaften für Preisplandetails)

Ja
recurringFee

Gebühr, die dem Entwickler fortlaufend in Rechnung gestellt wird, bis er den Tarif beendet.

Nein
recurringStartUnit

Nur gültig, wenn recurringType auf CALENDAR gesetzt ist. Tag des Monats, an dem die wiederkehrende Gebühr berechnet werden soll. Wenn die wiederkehrende Gebühr beispielsweise monatlich in Rechnung gestellt wird und recurringStartUnit auf 1 gesetzt ist, wird die wiederkehrende Gebühr am ersten Tag jedes Monats berechnet.

Nein
recurringType

Planen Sie die regelmäßige Gebühr ein. Gültige Werte sind:

  • CALENDAR: anhand eines Kalenders geplant.
  • CUSTOM: basierend auf einer benutzerdefinierten Datumseinstellung geplant.
Nein
setUpFee

Einmalige Gebühr, die jedem Entwickler am Startdatum des Abos (d. h. dem Datum, an dem der Entwickler das Abo erwirbt) in Rechnung gestellt wird.

Nein
startDate

Datum, an dem der Plan beginnt. Entwickler können den Preisplan ab diesem Datum aufrufen.

Ja
type

Art des Preisplans. Wählen Sie eine der folgenden Optionen aus:

  • STANDARD. Gilt für alle Entwickler.
  • DEVELOPER_CATEGORY: Gilt für alle Entwickler in einer ausgewählten Kategorie.
  • DEVELOPER. Gilt für einen bestimmten Entwickler oder ein bestimmtes Unternehmen.
Ja

Konfigurationseigenschaften für Preisplandetails

Beim Erstellen des Preisplans können Sie die folgenden Konfigurationseigenschaften als Teil des Arrays ratePlanDetails angeben.

Name Beschreibung Standard Erforderlich?
aggregateFreemiumCounters

Flag, das angibt, ob Aggregatzähler aktiviert sind, um festzustellen, ob die Nutzung eines API-Produkts im freien Bereich liegt. Aggregierte Zähler müssen aktiviert sein, um einen Freemium-Plan für ein Produkt einzurichten. Gültige Werte sind:

  • true: Zähler für Aggregatfunktionen aktivieren
  • false: Aggregierte Zähler werden nicht aktiviert.
Nein
aggregateStandardCounters

Flag, das angibt, ob Aggregatzähler verwendet werden, um das Nutzungsband zu bestimmen (z. B. ein Volumenband für einen Preislistenplan). Folgende Werte sind möglich:

  • true: Aggregierte Zähler verwenden
  • false: Verwenden Sie keine aggregierten Zähler.
Nein
aggregateTransactions

HINWEIS: Diese Property wird derzeit nicht von der Monetarisierung verwendet und kann ignoriert werden.

true Nein
currency

Währung

Nein
duration

Zeitraum für die Berechnungshäufigkeit, zusammen mit durationType, wobei die zulässigen duration-Werte 1–24 sind.

Legen Sie beispielsweise duration auf 2 und durationType auf MONTH fest, um eine Berechnungshäufigkeit von 2 Monaten anzugeben.

Nein
durationType

Zeitraum für die Berechnungshäufigkeit, zusammen mit duration. Der einzige gültige Wert ist MONTH.

Ein Anwendungsbeispiel finden Sie unter duration.

Nein
freemiumDuration

Zeitraum für den Freemium-Zeitraum für ein einzelnes API-Produkt zusammen mit freemiumDurationType. Wenn Sie beispielsweise einen Freemium-Zeitraum für ein API-Produkt von 30 Tagen festlegen möchten, setzen Sie freemiumDuration auf 30 und freemiumDurationType auf DAY.

Nein
freemiumDurationType

Zeitraum für den Freemium-Zeitraum für ein einzelnes API-Produkt zusammen mit freemiumDuration. Gültige Werte sind:

  • DAY
  • WEEK
  • MONTH
  • QUARTER
  • YEAR

Wenn Sie beispielsweise einen Freemium-Zeitraum für ein API-Produkt von 30 Tagen festlegen möchten, setzen Sie freemiumDuration auf 30 und freemiumDurationType auf DAY.

Nein
freemiumUnit

Freemium-Menge für ein API-Produkt. Der Wert kann die Anzahl der Transaktionen oder die Anzahl der Einheiten sein, die zu einem benutzerdefinierten Attribut gehören, das in der Transaktionsaufzeichnungsrichtlinie erfasst wurde.

Nein
meteringType

Abrechnungsmodell für einen Preislistentarif. Gültige Werte sind:

  • UNIT – Pauschalpreis-Lademodell.
  • VOLUME – Volumenband-Lademodell.
  • STAIR_STEP – gebündeltes Lademodell.
  • DEV_SPECIFIC – Anpassbares Lademodell für Benachrichtigungen. Gilt nicht für andere Umsatzmodelle.
Ja
organization

Organisations-ID

Nein
paymentDueDays

Fälligkeitsdatum der Zahlung für einen Entwickler mit nachträglicher Zahlung. Legen Sie den Wert beispielsweise auf 30 fest, um anzugeben, dass die Zahlung in 30 Tagen fällig ist.

Nein
product

API-Produktinformationen wie ID.

Nein
ratePlanRates

Preisdetails des Preisplans, wie der Typ des Preisplans (REVSHARE oder RATECARD), der Preis für einen Preislistenplan, die Umsatzbeteiligung für einen Umsatzbeteiligungsplan und die Spanne (Start- und Endeinheit für die der Preisplanpreis gilt).

Ja
ratingParameter

Basis für den Tarifplan. Der Preisplan basiert auf Transaktionen oder einem benutzerdefinierten Attribut. Gültige Werte sind:

  • VOLUME: Der Preisplan basiert auf dem Transaktionsvolumen.
  • custom_attribute : Name eines benutzerdefinierten Attributs, das in der Richtlinie zur Transaktionsaufzeichnung für das API-Produkt definiert ist und nur für Preislistenpläne gültig ist. Der Name des benutzerdefinierten Attributs darf nicht als VOLUME definiert werden.
VOLUME Ja
ratingParameterUnit

Die Einheit für ratingParameter. Only required if ratingParameter ist auf ein benutzerdefiniertes Attribut gesetzt (d. h. nicht auf VOLUME).

Ja
revenueType

Basis der Umsatzbeteiligung in einem Umsatzbeteiligungsplan. Gültige Werte sind:

  • GROSS: Die Umsatzbeteiligung basiert auf einem Prozentsatz des Bruttopreises einer Transaktion.
  • NET: Die Umsatzbeteiligung basiert auf einem Prozentsatz des Nettopreises einer Transaktion.
Nein
type

Preisplantyp. Gültige Werte sind:

  • REVSHARE: Umsatzbeteiligungsmodell.
  • RATECARD: Preislistenmodell
  • REVSHARE_RATECARD: Umsatzbeteiligung und Preislistenmodell
  • USAGE_TARGET – Anpassbares Benachrichtigungsmodell.

Weitere Informationen zu den Preisplantypen finden Sie unter Unterstützte Preisplantypen.

Ja