Gutschriften ausstellen

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

Einführung

Durch die Monetarisierung hast du die Flexibilität, Entwicklern Gutschriften zu erteilen.

Bei einem Prepaid-Entwickler wird eine Gutschrift als Verringerung der Nutzung angezeigt. Dadurch erhöht oder verringert sich das Prepaid-Guthaben des Entwicklers. Ähnlich wie bei einer Debitkarte werden die Gelder vom Prepaid-Guthaben eines Entwicklers abgezogen, wenn er ein API-Produktset kauft. Der Entwickler muss über ein ausreichendes Guthaben für Käufe verfügen. Weitere Informationen finden Sie unter Wie berechne ich das verbleibende Guthaben auf meinem Prepaid-Konto?

Bei Entwicklern mit nachträglicher Zahlung wird das Guthaben als separate Zeile in der Rechnung angezeigt, um die Kosten der Rechnung zu reduzieren.

Die Seite „Mitwirkende“

Rufe die Seite „Mitwirkende“ wie unten beschrieben auf.

Gutschrift ausstellen

1. Rufen Sie die Seite „Guthaben“ auf.
2. Klicke auf + Kreditur.
3. Geben Sie die folgenden Informationen ein:

   Feld	Beschreibung
   Abrechnungsmonat	Der Abrechnungsmonat, in dem das Guthaben gilt. Wählen Sie einen Monat aus der Liste aus.
   Entwickler	Name des Entwicklers oder Unternehmens, auf das sich der Gutschriftbetrag bezieht. Geben Sie den Namen in das Textfeld ein. Während Sie tippen, wird in einem Drop-down-Menü eine Liste der Entwickler/Unternehmen angezeigt, die den String enthalten. 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 verbleibenden Felder angezeigt. Wenn Sie ein Unternehmen oder einen Entwickler auswählen, das keinen Preisplan akzeptiert hat, können Sie keine Gutschrift ausstellen.
   Produktset	API-Produktpaket, auf das der Gutschriftbetrag angewendet wird. Wählen Sie aus der Liste der verfügbaren API-Produktpakete aus.
   Produkt	API-Produkt im ausgewählten API-Produktset, für das die Gutschrift gilt. Wählen Sie Alle Produkte oder ein einzelnes API-Produkt aus der Liste aus.
   Währung	Die für das Guthaben verwendete Währung. Die Währung ist für das Tarifpaket im API-Produktbundle konfiguriert, das der Entwickler gekauft hat, und kann nicht geändert werden. Wenn in einem Preisplan mehrere Währungen definiert sind, können Sie eine davon auswählen.
   Menge	Der Betrag des Guthabens (in der angegebenen Währung). Geben Sie einen positiven oder negativen Wert an. Der Wert darf nicht null sein.
   Hinweis	Optionale Notiz zur Beschreibung des Grundes für die Gutschrift.

4. Klicken Sie auf Guthaben speichern.

Guthaben über die API ausstellen

Über die API können Sie einem Entwickler Guthaben für ein API-Produktpaket als Ganzes oder für die Nutzung eines bestimmten API-Produkts in einem API-Produktpaket gutschreiben.

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 Tarifs definieren, für die das Guthaben gilt.

Wenn Sie die Anfrage senden, müssen Sie als Abfrageparameter Folgendes angeben:

• Die Entwickler-ID (E-Mail-Adresse), auf die das Guthaben angewendet werden soll.
• Höhe des Guthabens.
• Währung, in der das Guthaben gutgeschrieben wird.
• Notiz, in der der Grund für den Gutschriftbetrag beschrieben wird.

Optional können Sie die folgenden zusätzlichen Abfrageparameter angeben:

• Der Abrechnungszeitraum, auf den sich die Gutschrift bezieht. Der Standardwert ist der aktuelle Monat.
• Abrechnungsjahr, für das das Guthaben gilt. Standardmäßig ist das aktuelle Jahr festgelegt.
• API-Produkt, auf das die Gutschrift angewendet wird. Wenn Sie keine API-Produkt-ID angeben, wird die Gutschrift auf alle API-Produkte im API-Produktset angerechnet.

Bei der folgenden Anfrage wird beispielsweise einem als dev1@myorg.com identifizierten Entwickler ein Guthaben von 100 $für den Abrechnungsmonat April 2018 ausgestellt. Das Guthaben gilt für das payment API-Produktbundle und den payment_standard_plan Tarif:

Eine vollständige Liste der Abfrageparameter, die du in einer Gutschriftanfrage angeben kannst, findest du unter Abfrageparameter für die 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 aus 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 die 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	Währung, in der das Guthaben gutgeschrieben wird. Die Währung ist für das Tarifpaket im API-Produktbundle konfiguriert, das der Entwickler gekauft hat, und kann nicht geändert werden.	–	Ja
developerId	Name des Entwicklers oder Unternehmens, für das das Guthaben gilt.	–	Ja
productId	API-Produkt, auf das die Gutschrift angewendet wird. Wenn Sie keine Produkt-ID angeben, gilt der Gutschriftbetrag für alle API-Produkte im API-Produktbundle.	–	Nein
transactionAmount	Der Betrag des Guthabens (in der angegebenen Währung). Geben Sie einen positiven oder negativen Wert an. Der Wert darf nicht null sein.	–	Ja
transactionNote	Notiz, in der der Grund für die Gutschrift beschrieben wird.	–	Ja