Entwickler zur Monetarisierung migrieren

Sie lesen gerade die Apigee Edge -Dokumentation.
Zur Apigee X -Dokumentation. info

Wenn Sie vorhandene Entwickler haben, die Sie zu Monetarisierung migrieren müssen, gehen Sie so vor:

  1. Erstellen Sie die API-Produkte, API-Pakete und Tarifpakete für die Entwickler, die Sie migrieren, falls sie noch nicht vorhanden sind. Weitere Informationen finden Sie unter:
  2. Veröffentlichen Sie die Tarifpakete, wie unter Tarifpakete veröffentlichen beschrieben.
  3. Fügen Sie die neuen Entwickler Ihrer Organisation hinzu, wie unter App-Entwickler registrieren beschrieben.
  4. Füllen Sie das Prepaid-Guthaben für jeden Entwickler auf, wie unter Prepaid-Guthaben verwalten beschrieben.
  5. Akzeptieren Sie das Tarifpaket, wie unter Tarifpakete mit der API kaufen beschrieben.

    Hinweis: Wenn Sie die Einrichtungsgebühren erlassen möchten, falls einem Entwickler bereits Gebühren in Rechnung gestellt wurden, setzen Sie den waivefees Abfrageparameter auf true.

  6. Wenn ein Entwickler, den Sie migrieren, vorhandene Transaktionen hat, können Sie die Transaktionsnutzung mit der folgenden Ressource manuell übertragen:
    /organizations/{org_name}/transactions, wobei {org_name} der Name der Organisation ist.

    Hinweis: Wenn ein Entwickler keine vorhandenen Transaktionen hat, können Sie diesen Schritt überspringen.

    Mit der Ressource transactions wird eine einzelne Transaktion eingefügt, die die aktuelle Transaktionsnutzung widerspiegelt, und alle internen Zähler werden aktualisiert, um diesen neuen Wert widerzuspiegeln.

    Wenn der Entwickler beispielsweise vor der Migration 1.000 Aufrufe an die API gesendet hat, können Sie die Transaktionsnutzung auf 1.000 setzen, indem Sie die transactions Ressource aufrufen und die batchSize Eigenschaft im Anfragetext auf 1.000 setzen.

    In der folgenden Tabelle sind die Konfigurationseigenschaften zusammengefasst, die Sie im Anfragetext angeben können, um die Anzahl der Transaktionen manuell festzulegen. Außerdem sind die Standardwerte und die Angabe, ob sie erforderlich sind, enthalten.

    Attribut Beschreibung Standard Erforderlich?
    application

    ID der Entwickler-App.

    		 – Ja
    batchSize

    Anzahl der Transaktionen, die Sie übertragen möchten.

    		 1 Nein
    custAttn

    Wert des benutzerdefinierten Attributs, das mit „batchSize“ verwendet wird, um die Transaktionsnutzung zu berechnen.

    Die Nummer des benutzerdefinierten Attributs in der Nachricht muss als positive Ganzzahl oder Dezimalzahl (bis zu vier Dezimalstellen) angegeben werden. Negative Werte sind nicht zulässig.

    Das benutzerdefinierte Attribut muss in Folgendem definiert sein:

    		 – Ja
    product

    ID des API-Produkts.

    		 – Ja
    type

    Muss auf CHARGE gesetzt sein (Standard).

    		 CHARGE Nein

    Wenn Sie Validierungsschritte überspringen und die Anzahl der Transaktionen erzwingen möchten, setzen Sie den force Abfrageparameter auf true (z. B. ?force=true). Standardmäßig ist ?force=false festgelegt und die Validierungsschritte werden ausgeführt. Wenn ein Prepaid-Entwickler beispielsweise ein Guthaben von null hat und die Aktivität im Konto gesperrt ist, schlägt die Anfrage bei ?force=false während der Validierung fehl.

    Mit der folgenden Anfrage wird die Anzahl der Transaktionen für die angegebene Anwendung und das API-Produkt auf 50 gesetzt:

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize":50
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password

    Mit der folgenden Anfrage wird die Transaktionsnutzung für die angegebene Anwendung und API-Produkt auf 12,5 gesetzt. In der Anfrage ist batchSize auf 125 gesetzt und der Wert für das erste benutzerdefinierte Attribut, das für das API-Produkt definiert wurde, ist auf 0.1 gesetzt. 125 * 0,1 = 12,5.

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "application":{
     "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b"
   },
   "product":{
     "id":"testproduct"
   },
   "batchSize": 125,
   "custAtt1" : 0.1
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password
  7. Wenn einem Entwickler die erforderlichen Einrichtungs- oder wiederkehrenden Gebühren nicht in Rechnung gestellt wurden, können Sie mit der folgenden Ressource manuell eine Einrichtungs- oder wiederkehrende Gebühr für ein Tarifpaket in Rechnung stellen:
    /organizations/{org_name}/transactions, wobei {org_name} der Name der Organisation ist.

    Hinweis: Wenn dem Entwickler bereits Einrichtungs- oder wiederkehrende Gebühren in Rechnung gestellt wurden, können Sie diesen Schritt überspringen. Der Aufruf der transactions Ressource hat keine Auswirkungen auf die Einrichtungs- oder wiederkehrenden Gebühren, die im Tarifpaket definiert sind.

    In der folgenden Tabelle sind die Konfigurationseigenschaften zusammengefasst, die Sie im Anfragetext angeben können, um manuell eine Einrichtungs- oder wiederkehrende Gebühr für ein Tarifpaket in Rechnung zu stellen. Außerdem sind die Standardwerte und die Angabe, ob sie erforderlich sind, enthalten.

    Attribut Beschreibung Standard Erforderlich?
    currency

    Währung, die für das Tarifpaket 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
    developer

    ID des Entwicklers.

    		 – Ja
    rate

    Einrichtungs- oder wiederkehrende Gebühr, die in Rechnung gestellt werden soll.

    		 – Ja
    ratePlan

    ID des Tarifpakets.

    		 – Ja
    type

    Auf SETUPFEES oder RECURRINGFEES setzen.

    		 CHARGE Ja

    Wenn Sie Validierungsschritte überspringen und die Gebühr erzwingen möchten, setzen Sie den force Abfrage parameter auf true (z. B. ?force=true). Standardmäßig ist ?force=false festgelegt und die Validierungsschritte werden ausgeführt. Wenn ein Prepaid Entwickler beispielsweise ein Guthaben von null hat und die Aktivität im Konto gesperrt ist, schlägt die Anfrage bei ?force=false während der Validierung fehl.

    Mit der folgenden Anfrage wird dem Entwickler, der das Tarifpaket abonniert hat, eine Einrichtungsgebühr von 10 US-Dollar in Rechnung gestellt:

    $ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev1@myorg.com"
   },
   "currency":{
     "id":"usd"
   },
   "ratePlan":{
     "id":"mypackage_rateplan1"
   },   
   "rate":10,
   "type":"SETUPFEES"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \
-u email:password