Entwickler zur Monetarisierung migrieren

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

Wenn Sie bereits Entwickler haben, die zur Monetarisierung migriert werden müssen, gehen Sie so vor:

  1. Erstellen Sie die API-Produkte, API-Pakete und Tarifpläne für die zu migrierenden Entwickler, falls diese noch nicht vorhanden sind. Weitere Informationen:
  2. Veröffentlichen Sie die Preispläne, wie unter Preispläne veröffentlichen beschrieben.
  3. Fügen Sie Ihrer Organisation die neuen Entwickler hinzu, wie unter App-Entwickler registrieren beschrieben.
  4. Lade das Prepaidguthaben für jeden Entwickler auf, wie unter Prepaid-Kontoguthaben verwalten beschrieben.
  5. Akzeptieren Sie den Preisplan, wie unter Preispläne über die API erwerben beschrieben.

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

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

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

    Die Ressource transactions fügt eine einzelne Transaktion ein, die die aktuelle Transaktionsnutzung widerspiegelt, und aktualisiert alle internen Zähler entsprechend.

    Wenn der Entwickler beispielsweise vor der Migration 1.000 Aufrufe an die API gesendet hat, können Sie die Transaktionsnutzung auf 1.000 setzen, um die aktuelle Aktivität zu erfassen. Dazu rufen Sie die Ressource transactions auf und setzen das Attribut batchSize im Anfragetext auf 1.000.

    In der folgenden Tabelle sind die Konfigurationsattribute zusammengefasst, die Sie im Anfragetext angeben können, um die Anzahl der Transaktionen, deren Standardwerte und die Frage, ob sie erforderlich sind, manuell festzulegen.

    Property 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 zur Berechnung der Transaktionsnutzung verwendet wird.

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

    Das benutzerdefinierte Attribut muss folgendermaßen definiert werden:

    Ja
    product

    ID des API-Produkts.

    Ja
    type

    Muss auf CHARGE (Standardeinstellung) festgelegt sein.

    CHARGE Nein

    Wenn Sie die Überprüfungsschritte überspringen und die Anzahl der Transaktionen erzwingen möchten, setzen Sie den Abfrageparameter force auf true (z. B. ?force=true). Standardmäßig werden ?force=false und die Validierungsschritte ausgeführt. Wenn ein Entwickler mit einem Prepaidguthaben beispielsweise keinen Saldo hat und die Kontoaktivität gesperrt ist, schlägt die Anfrage während der Überprüfung fehl, wenn ?force=false.

    Beispiel: Die folgende Anfrage legt die Anzahl der Transaktionen für die angegebene Anwendung und das angegebene API-Produkt auf 50 fest:

    $ 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
    

    Die folgende Anfrage legt die Transaktionsnutzung für die angegebene Anwendung und das angegebene API-Produkt auf 12,5 fest. In der Anfrage wird batchSize auf 125 und der Wert für das erste für das API-Produkt definierte benutzerdefinierte Attribut auf 0.1 festgelegt. Multipliziert wird 125 × 0,1 zu 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 für einen Preisplan manuell eine Einrichtungs- oder wiederkehrende Gebühr für einen Preisplan berechnen. Verwenden Sie dazu die folgende Ressource:
    /organizations/{org_name}/transactions, wobei {org_name} der Name der Organisation ist.

    Hinweis:Wenn dem Entwickler bereits Einrichtungsgebühren oder wiederkehrende Gebühren berechnet wurden, können Sie diesen Schritt überspringen. Der Aufruf der Ressource transactions hat keine Auswirkungen auf die Einrichtung oder wiederkehrende Gebühren, die im Preisplan festgelegt sind.

    In der folgenden Tabelle sind die Konfigurationsattribute, die Sie im Anfragetext angeben können, um manuell eine Einrichtungs- oder wiederkehrende Gebühr für einen Preisplan in Rechnung zu stellen, sowie ihre Standardwerte und die Angabe, ob sie erforderlich sind, zusammengefasst.

    Property Beschreibung Standard Erforderlich?
    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
    developer

    ID des Entwicklers.

    Ja
    rate

    Einrichtung oder wiederkehrende Gebühr, die in Rechnung gestellt werden soll

    Ja
    ratePlan

    ID des Tarifpakets.

    Ja
    type

    Lege dafür SETUPFEES oder RECURRINGFEES fest.

    CHARGE Ja

    Wenn Sie die Überprüfungsschritte überspringen und die Gebühr erzwingen möchten, setzen Sie den Abfrageparameter force auf true (z. B. ?force=true). Standardmäßig werden ?force=false und die Validierungsschritte ausgeführt. Wenn ein Entwickler mit Prepaid beispielsweise kein Guthaben hat und die Aktivitäten im Konto gesperrt werden, schlägt die Anfrage während der Überprüfung fehl, wenn ?force=false.

    Mit der folgenden Anfrage wird dem Entwickler, der den Preisplan abonniert hat, beispielsweise eine Einrichtungsgebühr in Höhe von 10 $ 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