Entwickler zur Monetarisierung migrieren

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an.
info

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

  1. Falls noch nicht vorhanden, erstellen Sie die API-Produkte, API-Pakete und Tarifpläne für die zu migrierenden Entwickler. Weitere Informationen:
  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. Lade das Prepaidguthaben für jeden Entwickler auf, wie unter Prepaidguthaben verwalten beschrieben.
  5. Nimm den Tarifplan wie unter Kauftarifpläne mit der API beschrieben an.

    Hinweis: Wenn einem Entwickler bereits Einrichtungsgebühren in Rechnung gestellt wurden, können Sie diese mit dem Abfrageparameter waivefees auf true setzen, um sie zu erstatten.

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

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

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

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

    In der folgenden Tabelle sind die Konfigurationseigenschaften zusammengefasst, die Sie im Anfragetext angeben können, um die Anzahl der Transaktionen, ihre Standardwerte und die Erforderlichkeit manuell festzulegen.

    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 zusammen 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 Nachkommastellen) angegeben werden. Negative Werte sind nicht zulässig.

    Das benutzerdefinierte Attribut muss definiert werden in:

    Ja
    product

    ID des API-Produkts.

    Ja
    type

    Muss auf CHARGE festgelegt sein (Standardeinstellung).

    CHARGE Nein

    Wenn Sie die Validierungsschritte ü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 beispielsweise ein Prepaid-Entwickler ein Guthaben von null hat und die Aktivität im Konto gesperrt ist, schlägt die Anfrage bei der Validierung fehl, wenn ?force=false.

    Die folgende Anfrage legt beispielsweise die Anzahl der Transaktionen für die angegebene Anwendung und das 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 API-Produkt auf 12,5 fest. In der Anfrage ist batchSize auf 125 und der Wert für das erste benutzerdefinierte Attribut, das für das API-Produkt definiert ist, auf 0.1 festgelegt. Multipliziert ergibt das 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 eine Einrichtungs- oder wiederkehrende Gebühr für einen Preisplan manuell mithilfe der folgenden Ressource in Rechnung stellen:
    /organizations/{org_name}/transactions, wobei {org_name} der Name der Organisation ist.

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

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

    Attribut 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

    Zu erhebende Einrichtungs- oder wiederkehrende Gebühr.

    Ja
    ratePlan

    ID des Tarifpakets.

    Ja
    type

    Lege dafür SETUPFEES oder RECURRINGFEES fest.

    CHARGE Ja

    Wenn Sie die Validierungsschritte überspringen und die Gebühr zwangsweise in Rechnung stellen möchten, legen Sie den Abfrageparameter force auf true fest (z. B. ?force=true). Standardmäßig werden ?force=false und die Validierungsschritte ausgeführt. Wenn beispielsweise das Guthaben eines Prepaid-Entwicklers auf null steht und die Aktivitäten im Konto ausgesetzt sind, wird der Antrag bei ?force=false während der Überprüfung abgelehnt.

    In der folgenden Anfrage wird beispielsweise dem Entwickler, der das Tarifpaket abonniert hat, eine Einrichtungsgebühr 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