Richtlinien für die Transaktionsaufzeichnung konfigurieren

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

Konfigurieren Sie die Richtlinien für die Transaktionsaufzeichnung für jedes API-Produkt in Ihrem API-Produktset, wie in den folgenden Abschnitten beschrieben.

Einführung

Eine Richtlinie zur Transaktionsaufzeichnung ermöglicht der Monetarisierung, Transaktionsparameter und benutzerdefinierte Attribute. Die Monetarisierung benötigt diese Informationen für die Verarbeitung der Monetarisierung. z. B. die Anwendung von Tarifplänen.

Wenn Sie beispielsweise einen Tarifplan für die Umsatzbeteiligung einrichten, des Umsatzes aus jeder Transaktion mit deinem monetarisierten API-Produkt wird geteilt mit dem Entwickler der App, die die Anfrage stellt. Die Umsatzbeteiligung basiert auf den Netto- oder Bruttowerten Preis der Transaktion (Sie geben an), d. h. ein Prozentsatz des Brutto- oder Nettopreises wird zur Ermittlung der Umsatzbeteiligung verwendet. Daher müssen die Monetarisierungsanforderungen um den Brutto- oder Nettopreis einer Transaktion zu erfahren. Er ermittelt den Brutto- oder Nettopreis von den Einstellungen, die Sie in der Richtlinie zur Transaktionsaufzeichnung vornehmen.

Wenn Sie eine Preisliste Tarif, bei dem Sie dem Entwickler jede Transaktion in Rechnung stellen, können Sie den Preis für den Plan festlegen. basierend auf einem benutzerdefinierten Attribut wie der Anzahl der bei einer Transaktion übertragenen Byte. Bei der Monetarisierung muss klar sein, was das benutzerdefinierte Attribut ist und wo es zu finden ist. Sie müssen also das benutzerdefinierte Attribut in der Richtlinie zur Transaktionsaufzeichnung angeben.

Neben der Angabe von Transaktionsattributen in der Richtlinie zur Transaktionsaufzeichnung können Sie Erfolgskriterien für Transaktionen angeben, um zu bestimmen, wann eine Transaktion erfolgreich ist (für zu Ladezwecken). Beispiele für das Festlegen von Kriterien für den Erfolg von Transaktionen finden Sie unter Beispiele für das Festlegen von Erfolgskriterien für Transaktionen in einer Transaktionsaufzeichnung. . Sie können auch benutzerdefinierte Attribute für ein API-Produkt angeben, auf dem Ihre Basis-Rate basiert. Tarif).

Richtlinie für Transaktionsaufzeichnung konfigurieren

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

Transaktionsattribute konfigurieren

Geben Sie im Abschnitt Transaktionsattribute die Kriterien für eine erfolgreiche Monetarisierungstransaktion an.

1. Geben Sie im Feld Erfolgskriterien für Transaktionen den Ausdruck basierend auf dem Wert des Statusattributs an. (als Nächstes beschrieben), um festzustellen, wann die Transaktion erfolgreich ist (zu Abrechnungszwecken). Fehlgeschlagene Transaktionen (das heißt, sie erfüllen nicht die Kriterien im Ausdruck) aufgezeichnet, aber nicht auf sie angewendet werden. Beispiel:

   txProviderStatus == 'OK'

2. Das Attribut Status enthält den Wert, der von dem Ausdruck verwendet wird, der in Das Feld Success Criteria der Transaktion aus. Konfigurieren Sie das Attribut Status, indem Sie die folgenden Felder definieren:

   Feld	Beschreibung
   API-Ressource	URI-Muster, die im API-Produkt definiert sind und zur Identifizierung monetarisierter Transaktionen verwendet werden.
   Antwortort	Position der Antwort, an der das Attribut angegeben ist. Gültige Werte sind: Flow Variable, Header, JSON Body und XML Body.
   Wert	Wert der Antwort. Wenn Sie mehrere Werte angeben möchten, klicken Sie auf + x hinzufügen, z. B. auf + Ablaufvariable hinzufügen.

3. Zum Konfigurieren optionaler Transaktionsattribute aktivieren Sie die Ein/Aus-Schaltfläche Optionale Attribute verwenden und konfigurieren Sie eines der in der folgenden Tabelle definierten Transaktionsattribute.

   Attribut	Beschreibung
   Bruttopreis	Dieses Attribut gilt nur für Preispläne, die das Umsatzbeteiligungsmodell verwenden. Für diese Preispläne ist entweder der Bruttopreis oder der Nettopreis obligatorisch. Stellen Sie sicher, dass der wird als String ausgedrückt. Bruttopreis für eine Transaktion. Für Umsatzbeteiligungsmodellen verwenden, müssen Sie entweder das Bruttopreisattribut oder den Nettopreis . Welches Attribut erforderlich ist, hängt von der Umsatzbeteiligung ab. Für Sie können beispielsweise einen Tarifplan einrichten, der auf dem Bruttopreis eines Transaktion. In diesem Fall ist das Feld Bruttopreis erforderlich.
   Nettopreis	Dieses Attribut gilt nur für Preispläne, die das Umsatzbeteiligungsmodell verwenden. Für diese Preispläne ist entweder der Bruttopreis oder der Nettopreis obligatorisch. Stellen Sie sicher, dass der wird als String ausgedrückt. Nettopreis für eine Transaktion. Für Umsatzbeteiligungsplänen müssen Sie entweder das Feld "Nettopreis" oder den Bruttopreis ein. Welches Feld erforderlich ist, hängt von der Umsatzbeteiligung ab. Beispiel: können Sie einen Preisplan für die Umsatzbeteiligung einrichten, der auf dem Nettopreis einer Transaktion basiert. In diesem Fall ist das Feld „Nettopreis“ erforderlich.
   Währung	Dieses Attribut ist für Preispläne erforderlich, die das Umsatzbeteiligungsmodell verwenden. Art der Währung, die für die Transaktion gilt.
   Fehlercode	Mit der Transaktion verknüpfter Fehlercode. Sie bietet weitere Informationen zu einer fehlgeschlagenen Transaktion.
   Artikelbeschreibung	Beschreibung der Transaktion.
   Steuern	Dieses Attribut ist nur für Modelle zur Umsatzbeteiligung relevant und nur dann, wenn wird der Steuerbetrag in den API-Aufrufen erfasst. Der numerische Wert muss angegeben werden als Stringtyp angegeben. Steuerbetrag für den Kauf. Nettopreis plus Steuern = Bruttopreis

Wenn Sie beispielsweise die folgenden Werte festlegen, erhält die Monetarisierung den Wert der Flussvariablen aus der Nachrichtenantwort in einem Variable namens response.reason.phrase. Wenn der Wert OK ist und die Richtlinie zur Überprüfung der Monetarisierungseinschränkungen mit der API-Proxy-ProxyEndpoint-Anfrage verknüpft ist, zählt die Monetarisierung als Transaktion.

Benutzerdefinierte Attribute konfigurieren

Im Abschnitt Benutzerdefinierte Attribute legen Sie fest, welche benutzerdefinierten Attribute in die Richtlinie zur Transaktionsaufzeichnung. Wenn Sie z. B. einen Preislistenplan einrichten, bei dem Sie dem Entwickler Transaktion können Sie den Preis für den Plan anhand eines benutzerdefinierten Attributs festlegen, z. B. der Anzahl der Bytes übertragen werden. Anschließend müssen Sie dieses benutzerdefinierte Attribut in den Richtlinie zur Transaktionsaufzeichnung.

Jedes dieser Attribute wird im Transaktionsprotokoll gespeichert, das Sie abfragen können. Sie sind auch wird angezeigt, wenn Sie einen Tarifplan erstellen (damit Sie eines oder mehrere dieser Attribute auf der als Grundlage für den Preis für den Plan dient.

Sie können Ihrem Umsatz benutzerdefinierte Attribute hinzufügen, die in der Richtlinie zur Transaktionsaufzeichnung definiert sind zusammenfassende Berichte, wie in Mit benutzerdefinierter Transaktion Attribute in zusammenfassenden Berichten zum Umsatz

Um benutzerdefinierte Attribute zu konfigurieren, aktivieren Sie die Ein/Aus-Schaltfläche Benutzerdefinierte Attribute verwenden und definieren Sie bis zu 10 benutzerdefinierte Attribute. Führen Sie für jedes benutzerdefinierte Attribut, das Sie in die Richtlinie zur Transaktionsaufzeichnung aufnehmen, müssen Sie die folgenden Informationen angeben.

Ressourcen mit eindeutiger Transaktions-ID verknüpfen

Einige Transaktionen sind einfach und umfassen einen API-Aufruf an eine Ressource. Andere können Transaktionen komplexer sein. Beispiel: Eine Transaktion zum Kauf einer In-App- in einer mobilen Spiele-App beinhaltet mehrere Ressourcenaufrufe:

• Ein Aufruf einer Reserve API, mit der sichergestellt wird, dass ein Prepaid-Nutzer genügend Guthaben für den Kauf der und weist die Mittel für den Kauf zu (reserviert).
• Ein Aufruf einer Gebühren-API, bei der die Zahlung vom Konto des Prepaid-Nutzers abgezogen wird.

Um die gesamte Transaktion zu verarbeiten, muss die Monetarisierung über eine Möglichkeit verfügen, die erste Ressource (den Aufruf und Antwort an und von der Reserve API) mit der zweiten Ressource (dem Aufruf und der Antwort an und von der Charge API). Dazu stützt er sich auf Informationen, die Sie in den Bereich Ressourcen mit eindeutiger Transaktions-ID verknüpfen.

Um benutzerdefinierte Attribute zu konfigurieren, aktivieren Sie die Ein/Aus-Schaltfläche Eindeutige Transaktions-IDs verwenden und verknüpfen Sie Transaktionen. Für jede Transaktion geben Sie eine Ressource, einen Antwortort und einen Attributwert an, der die mit den entsprechenden Werten im Transaktionen.

Angenommen, der Reserve API-Aufruf und der Charge API-Aufruf sind wie folgt verknüpft: Das Feld namens session_id im Antwortheader der Reserve API entspricht einem Antwortheader mit dem Namen reference_id von der Charge API. In diesem Fall können Sie die Einträge im Abschnitt Ressourcen mit eindeutiger Transaktions-ID verknüpfen:

Erstattungen konfigurieren

Im Abschnitt Erstattungen geben Sie Attribute an, die wie die Monetarisierung bei Erstattungen verwendet wird.

Angenommen, eine nutzende Person kauft ein Produkt von einem mobile App, die Ihre monetarisierten APIs verwendet. Die Transaktion wird basierend auf dem Ihren Umsatzplan. Nehmen wir jedoch an, die nutzende Person ist mit dem Produkt unzufrieden und möchte es zurückgeben. Wenn die Produkt über einen Aufruf an deine API erstattet wird, die die Erstattung vornimmt, notwendige Anpassungen der Monetarisierung. Dies geschieht anhand der Informationen, die Sie in den Im Abschnitt „Erstattungen“ der Richtlinie zur Transaktionsaufzeichnung.

Um Erstattungen zu konfigurieren, aktivieren Sie die Ein/Aus-Schaltfläche Erstattungsattribute verwenden und legen Sie die Erstattungsdetails fest:

1. Definieren Sie die Erstattungskriterien, indem Sie die folgenden Felder definieren:

   Feld	Beschreibung
   Antwortort	Ressource für die Erstattungstransaktion. Wenn das API-Produkt mehrere Ressourcen haben, können Sie nur die Ressource auswählen, von der die Erstattung durchgeführt wird.
   Erfolgskriterien für Erstattungen	Ausdruck basierend auf dem Wert von das Statusattribut (nachfolgend beschrieben), um festzustellen, wann eine Rückerstattung erfolgreich ist (bei der Belastung) . Nicht erfolgreiche Erstattungen, d. h., sie erfüllen nicht die Kriterien im Ausdruck) erfasst, aber nicht auf sie angewendet. Beispiel: txProviderStatus == 'OK'

2. Konfigurieren Sie das Attribut Status, indem Sie die folgenden Felder definieren:

   Feld	Beschreibung
   Antwortort	Position der Antwort, an der das Attribut angegeben ist. Gültige Werte sind: Flow Variable, Header, JSON Body und XML Body.
   Wert	Wert der Antwort. Wenn Sie mehrere Werte angeben möchten, klicken Sie auf + x hinzufügen, z. B. auf + Ablaufvariable hinzufügen.

3. Konfigurieren Sie das Attribut Übergeordnete ID, indem Sie die folgenden Felder definieren:

   Feld	Beschreibung
   Antwortort	Position der Antwort, an der das Attribut angegeben ist. Gültige Werte sind: Flow Variable, Header, JSON Body und XML Body.
   Wert	ID der Transaktion, für die eine Erstattung verarbeitet wurde. Wenn ein Nutzer beispielsweise ein Produkt kauft und dann eine Erstattung beantragt, Die ID der übergeordneten Transaktion ist die ID der Kauftransaktion. Wenn Sie mehrere Werte angeben möchten, klicken Sie auf + x hinzufügen, z. B. auf + Ablaufvariable hinzufügen.

4. Um optionale Erstattungsattribute zu konfigurieren, aktivieren Sie die Ein/Aus-Schaltfläche Optionale Erstattungsattribute verwenden und konfigurieren Sie die Attribute. Die optionalen Erstattungsattribute sind dieselben wie die optionalen Transaktionsattribute gemäß Definition unter Transaktionsattribute konfigurieren

Richtlinien für die Transaktionsaufzeichnung über die API verwalten

In den folgenden Abschnitten wird beschrieben, wie Sie Richtlinien für die Transaktionsaufzeichnung mithilfe der API verwalten.

Richtlinie zur Transaktionsaufzeichnung mit der API erstellen

Sie geben eine Richtlinie zur Transaktionsaufzeichnung als Attribut eines API-Produkts an. Der Wert der Eigenschaft steht für Folgendes:

• Das URI-Suffix der Produktressource, für die die Richtlinie zur Transaktionsaufzeichnung gilt angehängt. Das Suffix enthält eine Mustervariable, die in geschweifte Klammern eingeschlossen ist. Das Muster Variable wird zur Laufzeit von API-Diensten ausgewertet. Beispielsweise würde das folgende URI-Suffix enthält die Mustervariable {id}.

  /reserve/{id}**
  

  In diesem Fall wertet API Services das URI-Suffix der Ressource als /reserve, gefolgt von einem beliebigen Unterverzeichnis, das mit einer von der API definierten ID beginnt Dienstanbieter.

• Die Ressource in der Antwort, an die sie angehängt ist. Ein API-Produkt kann mehrere und jede Ressource kann eine Richtlinie zur Transaktionsaufzeichnung an eine Antwort von für diese Ressource.
• Eine Richtlinie zum Extrahieren von Variablen, die es der Richtlinie zur Transaktionsaufzeichnung ermöglicht, Inhalte zu extrahieren aus einer Antwortnachricht für die Transaktionsparameter, die Sie erfassen möchten.

Sie fügen einem API-Produkt das Richtlinienattribut „Transaktionsaufzeichnung“ hinzu, indem Sie eine PUT-Anfrage ausgeben. mit der Verwaltungs-API https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} und nicht an eine Monetarisierungs-API.

Erfolgskriterien für Transaktionen mithilfe der API angeben

Sie können Erfolgskriterien für Transaktionen angeben, um zu bestimmen, wann eine Transaktion erfolgreich ist (zu Abrechnungszwecken). Transaktionen, die nicht erfolgreich sind, d. h. die Kriterien erfüllen im Ausdruck) erfasst, aber nicht auf sie angewendet. Beispiele für die Einstellung Erfolgskriterien für Transaktionen, siehe Beispiele für das Festlegen von Kriterien für den Erfolg von Transaktionen in einer Richtlinie zur Transaktionsaufzeichnung

Sie geben die Erfolgskriterien für Transaktionen als Attribut eines API-Produkts an. Vorgehensweise Senden einer PUT-Anfrage an die Verwaltungs-API https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} und nicht an die Monetarisierungs-API.

In der folgenden Anfrage ist eine Transaktion beispielsweise erfolgreich, wenn der Wert von txProviderStatus ist success (die Erfolgskriterien für Transaktionen). sind hervorgehoben).

$ curl -H "Content-Type: application/json" -X PUT -d \ 
'{
        "apiResources": [
        "/reserve/{id}**"       
        ],
        "approvalType": "auto",
        "attributes": [                         
        {
                "name": "MINT_TRANSACTION_SUCCESS_CRITERIA",
                "value": "txProviderStatus == 'OK'"
        }
        ],
        "description": "Payment",
        "displayName": "Payment",
        "environments": [
        "dev"
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
        ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

Benutzerdefinierte Attribute mithilfe der API angeben

Sie können benutzerdefinierte Attribute für ein API-Produkt angeben, für das Sie einen Basispreisplan bezahlen. Für Wenn Sie beispielsweise einen Preislistenplan einrichten, bei dem Sie dem Entwickler jede Transaktion in Rechnung stellen, kann den Preis für den Tarif anhand eines benutzerdefinierten Attributs wie der Anzahl der übertragenen Byte festlegen in einer Transaktion. Wenn Sie einen Preisplan erstellen, können Sie ein oder mehrere benutzerdefinierte Attribute auf auf dem Ihr Tarif für den Plan basiert. Für ein bestimmtes Produkt in einem Preisplan Ein benutzerdefiniertes Attribut, auf dem der Preis für den Plan basieren soll.

Sie geben benutzerdefinierte Attribute als Attribute eines API-Produkts an. Dazu stellen Sie eine PUT-Anfrage Anfrage an die Verwaltungs-API https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} und nicht an die Monetarisierungs-API.

Für jedes benutzerdefinierte Attribut, das Sie einem API-Produkt hinzufügen, müssen Sie einen Namen und ein Attributwert Der Name muss das Format MINT_CUSTOM_ATTRIBUTE_{num} haben, wobei {num} ist eine Ganzzahl.

Die folgende Anfrage gibt beispielsweise drei benutzerdefinierte Attribute an.

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
        "apiResources": [
        "/reserve/{id}**",
        "/charge/{id}**"
        ],
        "approvalType": "auto",
        "attributes": [
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_1",
                "value": "test1"
        },
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_2",
                "value": "test2"
        }
 
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
                ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

Beispiele für das Festlegen von Erfolgskriterien für Transaktionen in einer Transaktion Aufzeichnungsrichtlinie

Die folgende Tabelle enthält Beispiele für erfolgreiche und fehlgeschlagene Transaktionen basierend auf den Ausdruck der Erfolgskriterien der Transaktion und den zurückgegebenen Wert txProviderStatus durch den API-Proxy. txProviderStatus ist die interne Variable, die bei der Monetarisierung verwendet wird um den Transaktionserfolg zu ermitteln.