Preispläne mithilfe der API kaufen

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

In diesem Abschnitt wird beschrieben, wie Sie einen veröffentlichten Tarif kaufen und einen erworbenen Tarif auslaufen oder stornieren können. bei Bedarf mithilfe der API.

Veröffentlichten Tarifplan über die API kaufen

Nach der Veröffentlichung eines Tarifplans kann ein Entwickler oder ein Unternehmen ihn kaufen (oder „akzeptieren“), indem dem Senden einer POST-Anfrage an /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans, Dabei ist {org_name} der Name der Organisation und {developer_or_company_id} ist die ID des Entwicklers oder Unternehmens.

<ph type="x-smartling-placeholder">

Wenn Sie beim Kauf eines Preisplans auf Einrichtungsgebühren verzichten möchten, legen Sie den Abfrageparameter waivefees fest an true. Dieses Flag ist nützlich, wenn Sie Entwickler zur Monetarisierung migrieren, da wie Sie unter Entwickler migrieren zu Monetarisierung.

In der folgenden Tabelle sind die Konfigurationseigenschaften zusammengefasst, die Sie in den Anfragetext, ihre Standardwerte und ob sie erforderlich sind.

Name Beschreibung Standard Erforderlich?
startDate

Datum, an dem der Preisplan beginnt. Beispiel: 2017-03-24.

 – Ja
endDate

Datum, an dem der Preisplan endet. Beispiel: 2017-09-24.

Der Preisplan gilt bis zum Ende des Tages am das angegebene Datum. Wenn Sie einen Preisplan beispielsweise am 1. Dezember 2017 auslaufen lassen möchten, sollten Sie den Wert für endDate festlegen. bis 30.11.2017. In dieser der Preisplan am Ende des Tages am 30. November 2017 ausläuft. alle Anfragen am 1. Dezember 2017 gesperrt.

– Nein
developer

id-Property, die die ID des Entwicklers oder Unternehmens definiert, den Kauf des Tarifplans.

 – Ja
quotaTarget

Anzahl der für den App-Entwickler zulässigen Zieltransaktionen. Sie können konfigurieren, ob und je nachdem, wie viel Prozent der Zielanzahl erreicht werden, z. B. 90%, 100 % oder 150%. Zusätzliche Transaktionen werden nach dem Zielanzahl wurde erreicht.

Setzen Sie diesen Wert auf eine positive Ganzzahl oder auf 0, um Benachrichtigungen für eine App zu deaktivieren. Entwickler.

 0 Nein
ratePlan

id-Property, die die ID des Preisplans definiert.

Die Preisplan-ID unterscheidet sich vom Anzeigenamen. So rufen Sie Details zum Preisplan auf einschließlich der ID, siehe Mit der Seite „Preispläne“ vertraut machen

 – Ja
suppressWarning

Flag, das angibt, ob der Fehler bei einem Kaufversuch des Entwicklers unterdrückt werden soll einen Preisplan, der sich mit einem anderen gekauften Preisplan überschneidet. Dabei kann es sich um einen der folgenden Werte handeln: Folgendes:

  • true: Durch die Monetarisierung werden alle erworbenen Preispläne beendet, die muss der Entwickler API-Pakete erstellen, die die in Konflikt stehenden API-Produkte enthalten. Dann ein neues API-Paket für den Entwickler kauft.
  • false: Bei einer Überschneidung wird ein Fehler ausgegeben. Tarifplan aus.
 – Nein
waveTerminationCharge

Angabe, ob bei einem aktiven Tarifplan auf Kündigungsgebühren verzichtet wird im Rahmen der Aktivierung des neuen Tarifplans gekündigt. Dabei kann es sich um einen der folgenden Werte handeln: Folgendes:

  • true – Kündigungsgebühr erlassen, wenn ein aktiver Tarifplan gekündigt wird im Rahmen der Aktivierung des neuen Tarifplans.
  • false – Verzichten Sie nicht auf die Kündigungsgebühr, wenn ein aktiver Tarifplan im Rahmen der Aktivierung eines neuen Tarifplans gekündigt.
 – Nein

Mit der folgenden Anfrage wird beispielsweise der Preisplan location_&_messaging erworben für den angegebenen Entwickler:

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

In diesem Beispiel ist das Attribut suppressWarning auf false festgelegt. In In diesem Fall wird bei einem Konflikt ein Fehler ausgegeben. Wenn zum Beispiel der Entwickler versucht, einen Preisplan zu kaufen, der sich mit einem anderen gekauften Preisplan überschneidet, wird ein Fehler ausgegeben. Dieses ermöglicht es einer Anwendung, die eine Benutzeroberfläche für die Monetarisierung zur Verfügung stellt, um den Fehler abzufangen und Zeigen Sie dem Entwickler die in Konflikt stehenden Produkte gegebenenfalls zur Bestätigung an. Wenn suppressWarning ist auf true gesetzt, alle Käufe werden durch die Monetarisierung beendet für API-Pakete, die die in Konflikt stehenden Produkte enthalten. Dann ein neues API-Paket für den Entwickler kauft.

Mit der folgenden Anfrage wird ein anpassbarer Tarif für Benachrichtigungen erworben und die Zielanzahl festgelegt von Transaktionen auf 4.000.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

Wenn in einem der obigen Beispiele die folgende Fehlermeldung zurückgegeben wird:

Developer legal name not specified.

Dann musst du die Monetarisierungsattribute MINT_DEVELOPER_ADDRESS und MINT_DEVELOPER_LEGAL_NAME und wiederholen Sie dann den API-Aufruf.

Ein von einem Entwickler über die API erworbener Tarifplan läuft aus

Wenn Sie einen von einem Entwickler erworbenen Tarifplan ablaufen oder kündigen möchten, aktualisieren Sie den erworbenen Preisplandetails und geben Sie das Attribut endDate im Anfragetext in eine PUT-Anfrage an Die Ressource /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id}.

Der Preisplan gilt bis zum Ende des Tages am Ende Datum angegeben. Wenn Sie beispielsweise einen Tarifplan am 1. Dezember 2017 auslaufen lassen möchten, sollten Sie endDate-Wert festlegen bis 30.11.2017. In diesem Fall der Tarifplan läuft am Ende des Tages am 30. November 2017 aus. alle Anträge am 1. Dezember 2017 wird blockiert.

{developer_rateplan_id} wird beim Kauf in der Antwort zurückgegeben den veröffentlichten Preisplan.

Beispiel:

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Alternativ können Sie die {developer-rateplan-id} für den Entwicklerpreisplan durch Senden einer GET-Anfrage an /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, Dabei ist {developer_id} die E-Mail-Adresse des Entwicklers. Weitere Informationen erhalten Sie unter Anzeigen von alle von einem Entwickler erworbenen Preisplänen.

Im folgenden Antrag wird das Enddatum auf den 1. Dezember 2017 aktualisiert. Das heißt, der Preisplan laufen am Ende des Tages am 30. November 2017 ab. werden alle am 1. Dezember 2017 blockiert.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'