Preispläne verwalten

Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen info

Verwalten Sie Tarifpakete über die Benutzeroberfläche und die API, wie in den folgenden Abschnitten beschrieben.

Seite „Tarifpakete“

Rufen Sie die Seite „Tarifpakete“ wie unten beschrieben auf.

Tarifpaket erstellen

So erstellen Sie ein Tarifpaket:

1. Rufen Sie die Seite "Tarifpakete" auf.
2. Klicken Sie auf + Tarif.
3. Konfigurieren Sie die folgenden Felder im oberen Bereich:
   

   Feld	Beschreibung	Standard	Erforderlich
   Name des Preisplans	Name Ihres Tarifpakets. NOTE: Der Name muss innerhalb eines API-Produktpakets eindeutig sein. Zwei Tarife im selben Produktpaket dürfen nicht denselben Namen haben.	–	Ja
   Preisplantyp	Tarifpakettyp. Wählen Sie einen Wert aus der Drop-down-Liste aus. Eine Liste der gültigen Tarifarten finden Sie unter Unterstützte Tarifarten.	–	Ja
   Produktpaket	API-Produktbundle. Wählen Sie einen Wert aus der Drop-down-Liste aus. Weitere Informationen zu API-Produktbündeln finden Sie unter API-Produktbündel verwalten. Wenn Sie ein Produktpaket auswählen, das mehr als ein API-Produkt enthält, müssen Sie festlegen, ob Sie individuelle Tarifpakete für jedes API-Produkt oder ein generisches Tarifpaket konfigurieren möchten, das für alle API-Produkte gilt.	–	Ja
   Zielgruppe	Zielgruppe, die auf das Tarifpaket zugreifen kann. Wählen Sie einen der folgenden Werte aus der Drop-down-Liste aus: Alle: Alle Entwickler. Entwickler: Entwickler oder Unternehmen. Geben Sie den Namen des Entwicklers oder des Unternehmens 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 Unternehmens. Entwicklerkategorie: Entwicklerkategorie. Wählen Sie in der Drop-down-Liste eine Entwicklerkategorie aus. Konfigurieren Sie die Entwicklerkategorien nach Bedarf, wie unter Entwicklerkategorien verwalten beschrieben.	Alle	Nein
   Startdatum	Datum, an dem das Preismodell in Kraft tritt. Geben Sie ein Startdatum ein oder wählen Sie im Kalender ein Datum aus.	Heute	Nein
   Enddatum	Das Datum, an dem das Tarifpaket endet. Wenn Sie ein Enddatum angeben möchten, aktivieren Sie den Ein/Aus-Schalter Hat Enddatum und geben Sie ein Enddatum ein oder wählen Sie ein Datum im Kalender aus. HINWEIS: Das Tarifpaket gilt bis zum Ende des Tages am angegebenen Datum. Wenn Sie beispielsweise einen Tarif am 1. Dezember 2018 ablaufen lassen möchten, sollten Sie den Wert für „endDate“ auf 2018-11-30 festlegen. In diesem Fall läuft der Tarif am 30. November 2018 um Mitternacht ab. Alle Anfragen am 1. Dezember 2018 werden blockiert.	–	Nein
   Für Portale sichtbar	Legen Sie fest, ob das Tarifpaket öffentlich oder privat ist. Weitere Informationen finden Sie unter Öffentliche Tarife im Vergleich zu Tarifen für bestimmte Zielgruppe(n).	Aktiviert	Nein

4. Konfigurieren Sie Gebühren für das Tarifpaket. Weitere Informationen finden Sie unter Gebühren für ein Tarifpaket konfigurieren.
   NOTE: Gilt nicht für anpassbare Benachrichtigungspläne.
5. Wenn Sie ein Produkt-Bundle auswählen, das mehr als ein API-Produkt enthält, legen Sie im Bereich Specific or generic rate plan (Spezifisches oder generisches Tarifpaket) die folgenden Einstellungen fest:
   HINWEIS: Dieser Schritt gilt nicht für anpassbare Benachrichtigungstarife.
   

   Feld	Beschreibung	Standard
   Jedes Produkt einzeln konfigurieren	Flag, das angibt, ob für jedes API-Produkt ein individueller Tarifplan konfiguriert werden soll.	Deaktiviert
   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 eines oder beide Flags aktivieren, müssen Sie jedes Produkt einzeln aus der Drop-down-Liste auswählen und die Tarifdetails konfigurieren. NOTE: Konfigurieren Sie alle Produkte im Produktpaket.	–

6. Konfigurieren Sie die Preisplandetails entsprechend dem ausgewählten Preisplantyp:
   
   • Freemium
   • Preisliste
   • Umsatzbeteiligung
   • Anpassbare Benachrichtigungen
7. Klicken Sie auf eine der folgenden Optionen:
   

   Button	Beschreibung
   Als Entwurf speichern	Speichern Sie das Tarifpaket als Entwurf. Das Tarifpaket ist für App-Entwickler erst sichtbar, wenn Sie es veröffentlichen. Sie können jedes Feld in einem Tarifplanentwurf bearbeiten.
   Neuen Plan veröffentlichen	Veröffentlichen Sie den Plan. NOTE: Nachdem Sie ein Tarifpaket veröffentlicht haben, können Sie das Enddatum nur ändern, wenn es noch nicht festgelegt ist. Sie können ein Tarifpaket nach der Veröffentlichung nicht mehr löschen. Sie können es aber ablaufen lassen und durch ein zukünftiges Tarifpaket ersetzen, wie unter Veröffentlichtes Tarifpaket ablaufen lassen beschrieben.

8. Hängen Sie die Richtlinie Monetization Limits Check an die API-Proxys an, die mit den im Tarifpaket enthaltenen API-Produkten verknüpft sind. Mit der Richtlinie „MonetizationLimitsCheck“ werden Monetarisierungslimits für die API-Proxys erzwungen. Außerdem wird dafür gesorgt, dass alle Fehler in den Analyse- und Monetarisierungsberichten korrekt erfasst werden. Weitere Informationen finden Sie unter Monetarisierungslimits für API-Proxys erzwingen.

Tarifpaket bearbeiten

Sie können alle Felder in einem Tarifplanentwurf bearbeiten, mit Ausnahme von Produktpaket, Typ und Zielgruppe. Nachdem Sie ein Tarifpaket veröffentlicht haben, können Sie nur das Enddatum bearbeiten und nur, wenn kein Enddatum angegeben wurde.

So bearbeiten Sie einen Tarif:

1. Rufen Sie die Seite "Tarifpakete" auf.
2. Klicken Sie in die Zeile des Preismodells, das Sie bearbeiten möchten.
   Der Bereich „Tarif“ wird angezeigt.
3. Bearbeiten Sie die Felder des Tarifpakets nach Bedarf.
   NOTE: Nachdem Sie ein Tarifpaket veröffentlicht haben, können Sie das Enddatum nur ändern, wenn es noch nicht festgelegt ist.
4. Klicken Sie auf eine der folgenden Optionen:

   Button	Beschreibung
   Entwurf aktualisieren (Tarifpakete im Entwurf)	Speichern Sie das Tarifpaket als Entwurf. Das Tarifpaket ist erst für App-Entwickler sichtbar, wenn Sie es veröffentlichen. Sie können jedes Feld in einem Tarifplanentwurf bearbeiten.
   Entwurf veröffentlichen (Tarifpaketentwürfe)	Veröffentlichen Sie das Tarifpaket. NOTE: Nachdem Sie ein Tarifpaket veröffentlicht haben, können Sie das Enddatum nur ändern, wenn es noch nicht festgelegt ist. Sie können ein Tarifpaket nach der Veröffentlichung nicht mehr löschen. Sie können es aber ablaufen lassen und durch ein zukünftiges Tarifpaket ersetzen, wie unter Veröffentlichtes Tarifpaket ablaufen lassen beschrieben.
   Aktualisiertes Enddatum (veröffentlichte Tarifpakete)	Enddatum für einen veröffentlichten Plan festlegen NOTE: Nachdem das Enddatum für ein veröffentlichtes Tarifpaket festgelegt wurde, kann es nicht mehr geändert werden.

Tarifpaketentwurf löschen

Löschen Sie einen Tarifplanentwurf, wenn er nicht mehr benötigt wird.

HINWEIS:Veröffentlichte Tarifpakete können nicht gelöscht werden.

So löschen Sie ein Tarifpaket im Entwurfsstatus:

1. Rufen Sie die Seite "Tarifpakete" auf.
2. Bewegen Sie den Mauszeiger auf den Tarif, 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.

Tarifpakete mit der API verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie Tarifpakete mit der API verwalten.

Tarifpakete mit der API erstellen

Senden Sie eine POST-Anfrage an /organizations/{org_name}/monetization-packages/{monetizationpackage_id}/rate-plans, um einen Tarifplan zu erstellen. Dabei ist {monetizationpackage_id} die ID des API-Produktpakets, für das Sie den Tarifplan erstellen. Die ID wird in der Antwort zurückgegeben, wenn Sie das API-Produktpaket erstellen.

Wenn Sie ein Tarifpaket erstellen, müssen Sie im Anfragetext Folgendes angeben:

• Organisations-ID
• API-Produkt-Paket-ID
• Name des Tarifpakets
• Beschreibung des Preismodells
• Geltungsbereich des Tarifs (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 Tarif in Kraft tritt
• Währung für das Tarifpaket
• Gibt an, ob das Tarifpaket veröffentlicht werden soll.
• Ob der Tarif öffentlich oder privat ist

Sie können optional weitere Einstellungen angeben, z. B. den Zeitraum, in dem die Zahlung fällig ist (z. B. 30 Tage). Weitere Informationen zu Konfigurationsattributen für Ratenpläne

Wenn Sie einen Tarif (außer einem Tarif nur mit Gebühren) für ein API-Produktbundle mit mehr als einem Produkt erstellen, können Sie den Tarif auf ein bestimmtes Produkt im Produktbundle anwenden. Dazu müssen Sie das Produkt in der Anfrage angeben. Wenn Sie kein Produkt angeben, wird der Plan auf alle Produkte im API-Produktpaket angewendet.

In den folgenden Abschnitten wird beschrieben, wie Sie Tarifpakete erstellen:

• Standardtarifpaket mit der API erstellen
• Entwickler- oder Unternehmens-Tarifpaket mit der API erstellen
• Tarifpaket für Entwicklerkategorie mit der API erstellen
• API-Produkt-spezifisches Tarifpaket mit der API erstellen
• Tarifpaket mithilfe der API als öffentlich oder privat festlegen

Standardtarifpaket mit der API erstellen

Wenn Sie ein Standardtarifpaket 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

Entwickler- oder Unternehmenstarifpaket mit der API erstellen

Wenn Sie das Preismodell auf einen bestimmten Entwickler oder ein bestimmtes Unternehmen anwenden möchten, legen Sie den Wert type auf Developer fest. Sie müssen in der Anfrage auch den Entwickler oder das Unternehmen angeben, indem Sie die ID, den rechtsgültigen Namen und den Namen des Entwicklers oder Unternehmens angeben.

Im folgenden Beispiel wird ein Tarifpaket für den Entwickler Dev Five erstellt:

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

Preisplan für Entwicklerkategorie mit der API erstellen

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

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

API-Produkt-spezifischen Preisplan mit der API erstellen

Wenn Sie einen Tarif für API-Produktbundles mit mehreren API-Produkten erstellen, können Sie die Tarifdetails für API-Produkte einzeln angeben.

Mit dem folgenden Beispiel wird ein Plan zur Umsatzbeteiligung 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 my-package-API-Produktpaket ein API-Produkt hinzufügen möchten, müssen Sie die Tarifpaketdetails für das API-Produkt im Anfragetext hinzufügen, wie unter API-Produkt einem API-Produktpaket mit API-produktspezifischen Tarifpaketen 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

Tarifpaket mithilfe der API als öffentlich oder privat festlegen

Beim Erstellen eines Tarifmodells können Sie mit dem Attribut isPrivate im Anfragetext angeben, ob es öffentlich oder privat ist. Wenn der Wert auf true festgelegt ist, ist der Tarif privat. Weitere Informationen finden Sie unter Öffentliche und Tarife für bestimmte Zielgruppe(n).

Im Folgenden wird beispielsweise ein Tarif für bestimmte Zielgruppe(n) 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

Tarifpaket mithilfe der API veröffentlichen

Wenn Sie ein Tarifpaket veröffentlichen möchten, legen Sie beim Erstellen des Tarifpakets den Property-Wert published auf „true“ fest. Entwickler können den Tarif ab dem Datum einsehen, das in der Eigenschaft startDate für den Tarif angegeben ist.

Mit dem folgenden Beispiel wird ein Tarifkartenplan 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

Tarifpaketentwurf mithilfe der API speichern

Wenn Sie ein Tarifpaket speichern möchten, ohne es zu veröffentlichen, legen Sie beim Erstellen des Tarifpakets den Wert der Eigenschaft published auf „false“ fest.

Mit dem folgenden Beispiel wird ein Tarifkartenplan 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

Tarifpaketentwurf mit der API bearbeiten

Wenn Sie einen Tarifpaketentwurf aktualisieren möchten, senden Sie eine PUT-Anfrage an /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 Tarifpakets ist. Wenn Sie die Aktualisierung vornehmen, müssen Sie im Anfragetext die aktualisierten Einstellungen und die ID des Tarifmodells angeben. Wenn Sie einen Tarifpaketpreis aktualisieren, müssen Sie auch die ID des Tarifpaketpreises angeben. Mit der folgenden Anfrage wird beispielsweise der Tarifpaketpreis in einem Tarifpaket 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 Tarif (nur ein Teil der Antwort wird angezeigt):

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

Tarifpakete mithilfe der API ansehen

Sie können Tarifpakete mit der Monetarisierungs-API aufrufen, wie in den folgenden Abschnitten beschrieben.

• Alle Tarifpakete für eine Organisation mit der API ansehen
• Alle Tarifpakete für ein API-Produktbündel mithilfe der API ansehen
• Tarifpaket für ein API-Produktbündel mithilfe der API ansehen
• Alle aktiven Tarifpakete für einen Entwickler mithilfe der API ansehen
• Angenommenes Tarifpaket für einen Entwickler mithilfe der API ansehen
• Angenommenen Tarifplan für einen Entwickler mit einem API-Produkt über die API ansehen
• Alle von einem Entwickler akzeptierten Tarifpakete mithilfe der API ansehen

Alle Tarifpakete für eine Organisation mithilfe der API aufrufen

Um alle Tarifpakete für eine Organisation aufzurufen, 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:

Beispiel:

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

Alle Tarifpakete für ein API-Produktbündel mithilfe der API ansehen

Wenn Sie alle Tarifpakete für ein API-Paket aufrufen 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 Standard-Tarifpakete zurückgegeben. Folgendes muss enthalten sein:

• Bei Tarifplänen im Entwurfsstatus oder abgelaufenen Tarifplänen legen Sie den Abfrageparameter current auf false fest (z. B. ?current=false).
• Bei Tarifen für bestimmte Zielgruppe(n) setzen Sie den Abfrageparameter showPrivate auf true (z. B. ?showPrivate=true).
• Bei allen Standardtarifen legen Sie 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

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

Wenn Sie ein Tarifpaket für ein API-Paket aufrufen 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 Tarifpakets ist. Die Paket-ID wird zurückgegeben, wenn Sie das Monetarisierungspaket erstellen, und die Tarifpaket-ID wird zurückgegeben, wenn Sie das Tarifpaket 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 Tarifpakete für einen Entwickler mithilfe der API aufrufen

Wenn Sie alle aktiven Tarifpakete 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:

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
}

Ein akzeptiertes Tarifpaket für einen Entwickler mithilfe der API ansehen

Wenn Sie ein aktives Tarifpaket 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 Tarifpakets ist, die in der Antwort zurückgegeben wird, wenn Sie das veröffentlichte Tarifpaket 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"
  }

Einen akzeptierten Tarif für einen Entwickler mit einem API-Produkt mithilfe der API ansehen

Wenn Sie ein akzeptiertes Tarifpaket für einen Entwickler mit einem API-Produkt aufrufen möchten, 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 öffentliches Tarifmodell zurückgegeben. Wenn Sie einen Tarif für bestimmte Zielgruppen aufrufen möchten, setzen Sie den Abfrageparameter showPrivate auf true (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 Tarifpakete mithilfe der API aufrufen

Wenn Sie Tarife aufrufen möchten, die von einem Entwickler akzeptiert wurden, 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:

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
}

Tarifpaketentwurf mithilfe der API löschen

Wenn Sie einen Tarifpaketentwurf löschen möchten, senden Sie eine DELETE-Anfrage an /organizations/{org_name}/monetization-packages/package_id}/rate-plans/{plan_Id}, wobei {plan_Id} die ID des zu löschenden Tarifpakets und {package_id} die ID des API-Pakets für das Tarifpaket 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 Tarife

Wenn Sie ein Tarifpaket mit der API erstellen, können Sie die folgenden Konfigurationseinstellungen angeben.

Konfigurationsattribute für Preisplandetails

Sie können beim Erstellen des Tarifpakets eine der folgenden Konfigurationseigenschaften als Teil des ratePlanDetails-Arrays angeben.