Gutschriften ausstellen

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation.
Weitere Informationen

Einführung

Bei der Monetarisierung haben Sie die Möglichkeit, Entwicklerguthaben flexibel auszugeben.

Für Entwickler mit Prepaid-Tarif Das Guthaben wird als reduzierte Nutzung angezeigt. Dadurch erhöht oder verringert sich das Prepaidguthaben des Entwicklers in Zukunft. Ähnlich wie mit einer Debitkarte wird das Guthaben des Entwicklers in den folgenden Fällen vom Prepaidguthaben des Entwicklers abgebucht, ein API-Produktset erwirbt. Der Entwickler muss ein ausreichendes Guthaben Käufe. Weitere Informationen finden Sie unter Wie berechne ich das verbleibende Vorauszahlungsguthaben?

Bei Entwicklern mit nachträglicher Zahlung werden Guthaben wie folgt angezeigt: eine separate Zeile in einer Rechnung erstellen, wodurch die Kosten der Rechnung reduziert werden.

Informationen zur Seite „Guthabenpunkte“

Rufen Sie die Seite „Guthabenpunkte“ wie unten beschrieben auf.

Edge

So greifen Sie über die Edge-Benutzeroberfläche auf die Seite „Credits“ (Guthabenpunkte) zu:

  1. Melden Sie sich bei apigee.com/edge an.
  2. Wählen Sie Veröffentlichen > Monetarisierung > Gutschriften.

Die Seite „Gutschriften“ wird angezeigt.

Wie in der Abbildung hervorgehoben, können Sie auf der Seite „Guthabenpunkte“ Folgendes tun:

  • Zeigen Sie eine Zusammenfassung aller Guthaben an, einschließlich Name des Empfängers, Gutschriftbetrag, Datum und Uhrzeit der Gutschrift API-Produktpaket und API-Produkte, für die das Guthaben gilt, sowie alle hinzugefügten Hinweise
  • Gutschrift 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:

  1. Melden Sie sich in http://ms-ip:9000 an. ms-ip ist hierbei IP-Adresse oder DNS-Name des Verwaltungsserverknotens.
  2. Wähle Monetarisierung > Monetarisierungsberichte.

Auf der Seite „Gutschriften“ haben Sie folgende Möglichkeiten:

  • Zeigen Sie eine Zusammenfassung aller Guthaben an, einschließlich Name des Empfängers, Gutschriftbetrag, Datum und Uhrzeit der Gutschrift API-Produktpaket und API-Produkte, für die das Guthaben gilt, sowie alle hinzugefügten Hinweise
  • Gutschrift ausstellen
  • In der Liste der Gutschriften suchen

Kredite ausstellen

  1. Rufen Sie die Seite „Guthabenpunkte“ auf.
  2. Klicken Sie auf + Guthaben.
  3. Geben Sie die folgenden Informationen ein:
    Feld Beschreibung
    Abrechnungsmonat

    Abrechnungsmonat, in dem das Guthaben angewendet wird. Wählen Sie einen Monat aus der Liste aus.

    Entwickler

    Name des Entwicklers oder Unternehmens, für das das Guthaben gilt. Geben Sie den Namen in das Textfeld ein. Während der Eingabe wird eine Liste der Entwickler/Unternehmen, die den String enthalten, in einem Drop-down-Menü angezeigt. Klicken Sie in der Drop-down-Liste auf den Namen des Entwicklers oder des 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-Produktset, für das das Guthaben gilt. Wählen Sie ein API-Produktpaket aus der Liste aus.

    Produkt

    API-Produkt im ausgewählten API-Produktset, für das die Gutschrift gilt. Auswählen Alle Produkte oder ein einzelnes API-Produkt aus der Liste.

    Währung

    Die für das Guthaben verwendete Währung. Die Währung ist für den Preisplan im API-Produktpaket konfiguriert, das vom Entwickler erworben und kann nicht geändert werden. Wenn in einem Preisplan mehrere Währungen definiert sind, können Sie eine davon 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.

    Hinweis

    Optionale Notiz zur Erläuterung 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-Produktset als Ganzes zuweisen oder eines bestimmten API-Produkts in einem API-Produktset.

Um eine Gutschrift über die API auszustellen, 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 ID des API-Produktpakets und des Tarifs, auf den das Guthaben angewendet wird.

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

  • Die Entwickler-ID (E-Mail-Adresse), für die das Guthaben verwendet wird.
  • Höhe der Gutschrift
  • Die für das Guthaben verwendete Währung.
  • Eine Notiz mit dem Grund für die Gutschrift.

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

  • Abrechnungsmonat, für den das Guthaben gilt. Standardmäßig wird der aktuelle Wert Monat.
  • Abrechnungsjahr, für das das Guthaben gilt. Die Standardeinstellung für diesen Wert ist das aktuelle Jahr.
  • API-Produkt, für das das Guthaben gilt. Wenn Sie kein API-Produkt angeben ID verwenden, gilt das Guthaben für alle API-Produkte im API-Produktset.

Bei der folgenden Anfrage wird beispielsweise eine Gutschrift von 100 $für den Abrechnungsmonat April 2018 ausgestellt. an einen Entwickler gesendet, der als dev1@myorg.com identifiziert wurde. Die Gutschrift gilt für API-Produktpaket payment und Preisplan für payment_standard_plan:

Eine vollständige Liste der Abfrageparameter finden Sie unter Abfrageparameter für die Credits API. die Sie in einer Gutschriftanforderung angeben können.

$ 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

Die für das Guthaben verwendete Währung. Die Währung ist für den Preisplan im API-Produktpaket konfiguriert, das vom Entwickler erworben und kann nicht geändert werden.

Ja
developerId

Name des Entwicklers oder Unternehmens, für das das Guthaben gilt.

Ja
productId

API-Produkt, für das das Guthaben gilt. Wenn Sie keine Produkt-ID angeben, Das Guthaben gilt für alle API-Produkte im API-Produktset.

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

Hier wird der Grund für die Gutschrift genannt.

Ja