Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Einführung
Die Monetarisierung gibt dir die Flexibilität, Entwicklerguthaben auszustellen.
Für einen Prepaid-Entwickler stellt ein Guthaben eine Reduzierung der Nutzung dar. Dadurch steigt oder verringert sich das Prepaidguthaben des Entwicklers. Ähnlich wie bei einer Debitkarte wird Geld vom Prepaidguthaben eines Entwicklers abgebucht, wenn ein Entwickler ein API-Produktpaket kauft. Der Entwickler muss über ein ausreichendes Guthaben für Käufe verfügen. Siehe Wie berechne ich das verbleibende Prepaidguthaben?
Für Entwickler mit nachträglicher Zahlung wird die Gutschrift in einer Rechnung als separate Zeile aufgeführt, wodurch die Kosten auf der Rechnung reduziert werden.
Informationen zur Seite „Gutschriften“
Rufen Sie die Seite „Credits“ (Guthabenpunkte) auf, wie unten beschrieben.
Edge
So greifen Sie über die Edge-Benutzeroberfläche auf die Seite „Credits“ (Guthabenpunkte) zu:
- Melden Sie sich unter apigee.com/edge an.
- Wählen Sie in der linken Navigationsleiste Veröffentlichen > Monetarisierung > Guthaben aus.
Die Seite "Credits" (Gutschriften) wird angezeigt.
Wie in der Abbildung hervorgehoben, können Sie auf der Seite „Credits“ (Guthabenpunkte) Folgendes tun:
- Zusammenfassung der Informationen für alle Gutschriften aufrufen, darunter Name des Empfängers, Gutschriftbetrag, Datum und Uhrzeit der Einlösung des Guthabens, API-Produktpaket und API-Produkte, für die das Guthaben gilt, sowie hinzugefügte Notizen
- Guthaben ausstellen
- In der Liste der Gutschriften suchen
Classic Edge (Private Cloud)
So greifen Sie über die Classic Edge-Benutzeroberfläche auf die Seite "Credits" (Guthabenpunkte) zu:
- Melden Sie sich bei
http://ms-ip:9000
an, wobei ms-ip die IP-Adresse oder der DNS-Name des Knotens des Verwaltungsservers ist. - Wähle in der oberen Navigationsleiste Monetarisierung > Monetarisierungsberichte aus.
Auf der Seite „Gutschriften“ können Sie:
- Zusammenfassung der Informationen für alle Gutschriften aufrufen, darunter Name des Empfängers, Gutschriftbetrag, Datum und Uhrzeit der Einlösung des Guthabens, API-Produktpaket und API-Produkte, für die das Guthaben gilt, sowie hinzugefügte Notizen
- Guthaben ausstellen
- In der Liste der Gutschriften suchen
Kredit ausstellen
- Rufen Sie die Seite „Guthaben“ auf.
- Klicken Sie auf + Guthaben.
- Geben Sie die folgenden Informationen ein:
Feld Beschreibung Abrechnungsmonat Abrechnungsmonat, in dem das Guthaben gilt. Wählen Sie einen Monat aus der Liste aus.
Developer Name des Entwicklers oder Unternehmens, für den das Guthaben gilt Geben Sie den Namen in das Textfeld ein. Während der Eingabe wird eine Liste der Entwickler/Unternehmen, die die Zeichenfolge enthalten, in einem Drop-down-Menü angezeigt. Klicken Sie in der Drop-down-Liste auf den Namen des Entwicklers oder Unternehmens.
Hinweis: Nachdem Sie einen Entwickler oder ein Unternehmen ausgewählt haben, werden die restlichen Felder angezeigt. Wenn Sie ein Unternehmen oder einen Entwickler auswählen, das bzw. der keinen Preisplan akzeptiert hat, können Sie keine Gutschrift ausstellen.
Produktset API-Produktset, für das das Guthaben gilt. Wählen Sie die verfügbaren API-Produktpakete aus der Liste aus.
Produkt API-Produkt im ausgewählten API-Produktset, für das das Guthaben gilt. Wählen Sie Alle Produkte oder ein einzelnes API-Produkt aus der Liste aus.
Currency Für die Gutschrift verwendete Währung. Die Währung ist für den Preisplan im API-Produktpaket konfiguriert, das der Entwickler erworben hat, und kann nicht geändert werden. Wenn in einem Preisplan mehrere Währungen definiert sind, können Sie eine der Währungen auswählen.
Menge Höhe der Gutschrift (in der angegebenen Währung) Geben Sie einen positiven oder negativen Wert an. Der Wert darf nicht null sein.
Hinweise Optionale Notiz zur Beschreibung des Grundes für die Gutschrift.
- Klicken Sie auf Guthaben speichern.
Guthaben über die API ausstellen
Wenn Sie die API verwenden, können Sie einem Entwickler ein Guthaben für ein API-Produktpaket oder die Verwendung eines bestimmten API-Produkts in einem API-Produktpaket auszahlen.
Wenn Sie eine Gutschrift über die API ausstellen möchten, senden Sie eine POST-Anfrage an /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions
, wobei {package_id}
und {rate-plan_id}
die Identifizierung des API-Produktpakets und des Preisplans definieren, für den das Guthaben gilt.
Wenn Sie die Anfrage senden, müssen Sie folgende Abfrageparameter angeben:
- Entwickler-ID (E-Mail-Adresse), für die das Guthaben gilt.
- Die Höhe der Gutschrift.
- Für die Gutschrift verwendete Währung.
- Eine Beschreibung des Grundes für die Gutschrift.
Optional können Sie die folgenden zusätzlichen Abfrageparameter angeben:
- Abrechnungsmonat, für den das Guthaben gilt. Die Standardeinstellung für diesen Wert ist der aktuelle Monat.
- Abrechnungsjahr, für das das Guthaben gilt. Die Standardeinstellung ist das aktuelle Jahr.
- API-Produkt, für das die Gutschrift gilt. Wenn Sie keine API-Produkt-ID angeben, gilt das Guthaben für alle API-Produkte im API-Produktpaket.
Durch die folgende Anfrage wird beispielsweise einem Entwickler mit der E-Mail-Adresse dev1@myorg.com
für den Abrechnungsmonat April 2018 eine Gutschrift in Höhe von 100 $ausgestellt. Das Guthaben gilt für das API-Produktpaket payment
und den Preisplan payment_standard_plan
:
Eine vollständige Liste der Abfrageparameter, die Sie in einer Gutschriftsanfrage angeben können, finden Sie unter Abfrageparameter für Credits API.
$ curl -H "Content-Type:application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \ -u email:password
Im Folgenden finden Sie einen Beispielauszug der Antwort:
{ "currency" : "USD", "developer" : { "address" : [ { "address1" : "Dev One Address", ... } ], "approxTaxRate" : 0.0000, "billingType" : "PREPAID", "broker" : false, "developerRole" : [ ], "email" : "dev1@myorg.com", "hasSelfBilling" : false, "id" : "K4jW2QLjZ1h8GFA8", "legalName" : "DEV ONE", "name" : "Dev One", "organization" : { ... }, "registrationId" : "TestRegId", "status" : "ACTIVE", "type" : "TRUSTED" }, "endTime" : "2013-09-04 15:54:36", "environment" : "PROD", "euroExchangeRate" : 0.8107, "gbpExchangeRate" : 0.6860, "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "isVirtualCurrency" : false, "notes" : "Credit for failed transactions", "pkgId" : "myorg@@@payment", "pkgRatePlanProductName" : "Payment", "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "rate" : 100, "ratePlan" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Standard Plan", "displayName" : "Standard Plan", … "monetizationPackage" : { "description" : "Payment", ... } ], ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], "status" : "CREATED" }, "name" : "Standard Plan", "organization" : { ... }, ... }, ... }, ... }, "revenueShareAmount" : 0, "startTime" : "2013-09-04 15:54:36", "status" : "SUCCESS", "taxModel" : "UNDISCLOSED", "txProviderStatus" : "SUCCESS", "type" : "CREDIT", "usdExchangeRate" : 1.0675, "utcEndTime" : "2013-09-04 15:54:36", "utcStartTime" : "2013-09-04 15:54:36" }
Abfrageparameter für Credits API
Die folgenden Abfrageparameter können mit der Credits API verwendet werden:
Name | Beschreibung | Standard | Erforderlich? |
---|---|---|---|
billingMonth |
Abrechnungsmonat, für den das Guthaben gilt, z. B. APRIL. |
– | Nein |
billingYear |
Abrechnungsjahr, für das das Guthaben gilt, z. B. 2018. |
– | Nein |
currencyId |
Für die Gutschrift verwendete Währung. Die Währung ist für den Preisplan im API-Produktpaket konfiguriert, das der Entwickler erworben hat, und kann nicht geändert werden. |
– | Ja |
developerId |
Name des Entwicklers oder Unternehmens, für den das Guthaben gilt |
– | Ja |
productId |
API-Produkt, für das die Gutschrift gilt. Wenn Sie keine Produkt-ID angeben, gilt das Guthaben für alle API-Produkte im API-Produktpaket. |
– | Nein |
transactionAmount |
Höhe der Gutschrift (in der angegebenen Währung) Geben Sie einen positiven oder negativen Wert an. Der Wert darf nicht null sein. |
– | Ja |
transactionNote |
Geben Sie hier den Grund für die Gutschrift an. |
– | Ja |