Gutschriften ausstellen

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

Einführung

Mit der Monetarisierung haben Sie die Flexibilität, Entwicklern Guthaben zu gewähren.

Für einen Prepaid-Entwickler wird ein Guthaben als Reduzierung der Nutzung angezeigt. Dadurch erhöht oder verringert sich das Prepaid-Guthaben des Entwicklers für die Zukunft. Ähnlich wie bei der Verwendung einer Debitkarte werden Gelder vom Prepaid-Guthaben eines Entwicklers abgebucht, wenn der Entwickler ein API-Produktbundle kauft. Der Entwickler muss über ein ausreichendes Guthaben für Käufe verfügen. Weitere Informationen finden Sie unter Wie berechne ich das verbleibende Prepaid-Kontoguthaben?

Für einen Postpaid-Entwickler wird ein Guthaben als separate Position auf einer Rechnung angezeigt, wodurch die Gebühr auf einer Rechnung reduziert wird.

Seite „Gutschriften“

Wie unten beschrieben können Sie auf die Seite „Gutschriften“ zugreifen und sie sich ansehen.

Gutschrift gewähren

1. Rufen Sie die Seite „Gutschriften“ auf.
2. Klicken Sie auf + Gutschrift.
3. Geben Sie die folgenden Informationen ein:

   Feld	Beschreibung
   Abrechnungsmonat	Abrechnungsmonat, in dem die Gutschrift angewendet wird. Wählen Sie einen Monat aus der Liste aus.
   Entwickler	Name des Entwicklers oder Unternehmens, auf das die Gutschrift angewendet wird. Geben Sie den Namen in das Textfeld ein. Während der Eingabe wird in einem Drop-down-Menü eine Liste der Entwickler/Unternehmen angezeigt, die die Zeichenfolge 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, der kein Tarifpaket akzeptiert hat, können Sie keine Gutschrift gewähren.
   Produktbundle	API-Produktbundle, auf das die Gutschrift angewendet wird. Wählen Sie aus der Liste der verfügbaren API-Produktbundles aus.
   Produkt	API-Produkt im ausgewählten API-Produktbundle, auf das die Gutschrift angewendet wird. Wählen Sie Alle Produkte oder ein einzelnes API-Produkt aus der Liste aus.
   Währung	Währung, die für die Gutschrift verwendet wird. 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 Tarifpaket mehrere Währungen definiert sind, können Sie eine der Währungen auswählen.
   Menge	Betrag der Gutschrift (in der angegebenen Währung). Geben Sie einen positiven oder negativen Wert an. Der Wert darf nicht null sein.
   Community-Anmerkung	Optionaler Hinweis zur Beschreibung des Grunds für die Gutschrift.

4. Klicken Sie auf Gutschrift speichern.

Gutschriften über die API gewähren

Über die API können Sie einem Entwickler eine Gutschrift für ein API-Produktbundle als Ganzes oder für die Verwendung eines bestimmten API-Produkts in einem API-Produktbundle gewähren.

Senden Sie eine POST-Anfrage an /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, um eine Gutschrift über die API zu gewähren. Dabei definieren {package_id} und {rate-plan_id} die ID des API-Produktbundles bzw. des Tarifpakets, auf das die Gutschrift angewendet wird.

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

• Entwickler-ID (E-Mail-Adresse), auf die die Gutschrift angewendet wird.
• Betrag der Gutschrift.
• Währung, die für die Gutschrift verwendet wird.
• Hinweis zur Beschreibung des Grunds für die Gutschrift.

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

• Abrechnungsmonat, auf den die Gutschrift angewendet wird. Standardmäßig wird der aktuelle Monat verwendet.
• Abrechnungsjahr, auf das die Gutschrift angewendet wird. Standardmäßig wird das aktuelle Jahr verwendet.
• API-Produkt, auf das die Gutschrift angewendet wird. Wenn Sie keine API-Produkt ID angeben, wird die Gutschrift auf alle API-Produkte im API-Produktbundle angewendet.

Die folgende Anfrage gewährt beispielsweise eine Gutschrift von 100 $ für den Abrechnungsmonat April 2018 für einen Entwickler mit der ID dev1@myorg.com. Die Gutschrift wird auf das payment API-Produktbundle und payment_standard_plan Tarifpaket angewendet:

Eine vollständige Liste der Abfrageparameter , die Sie in einer Gutschriftanfrage angeben können, finden Sie unter Abfrageparameter für die API „Gutschriften“.

$ 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 sehen Sie einen Beispielausschnitt 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 API „Gutschriften“

Die folgenden Abfrageparameter können mit der API „Gutschriften“ verwendet werden: