norme MonetizationLimitsCheck

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Panoramica

Le norme MonetizationLimitsCheck ti consentono di applicare limiti di monetizzazione alle chiamate API effettuate dallo sviluppatore dell'app.

Di seguito sono riportati alcuni casi in cui il criterio viene attivato:

• Se uno sviluppatore di app che accede all'API monetizzata non ha acquistato un abbonamento a il prodotto API associato
• L'account dello sviluppatore non ha un saldo sufficiente.
• Lo sviluppatore ha superato il limite di volume delle transazioni.

Per informazioni su come collegare il criterio al proxy API, consulta Imporre i limiti di monetizzazione per i proxy API.

<MonetizationLimitsCheck> elemento

Specifica il criterio MonetizationLimitsCheck.

La seguente tabella fornisce una descrizione generale degli elementi secondari di <MonetizationLimitsCheck>:

L'elemento <MonetizationLimitsCheck> utilizza la seguente sintassi:

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="POLICY_NAME">
    <DisplayName>DISPLAY_NAME</DisplayName>
    <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
    <Variables>
        <Product>VARIABLE_NAME</Product>
    </Variables>
    <FaultResponse>
        <Set>
            <Payload contentType="text/xml">
                <error>
                    <messages>
                        <message>MESSAGE_TEXT</message>
                        <message>MESSAGE_TEXT</message>
                    </messages>
                </error>
            </Payload>
            <StatusCode>HTTP_STATUS</StatusCode>
            <ReasonPhrase>REASON_TEXT</ReasonPhrase>
        </Set>
    </FaultResponse>
</MonetizationLimitsCheck>

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="Monetization-Limits-Check">
    <DisplayName>Monetization Limits Check</DisplayName>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <Variables>
        <Product>myproductvar.name</Product>
    </Variables>
	<FaultResponse>
	        <Set>
	            <Payload contentType="text/xml">
	                <error>
	                    <messages>
	                        <message>Developer has reached usage quota</message>
	                        <message>Is Developer Suspended - {monetizationLimits.isDeveloperSuspended} </message>
	                    </messages>
	                </error>
	            </Payload>
	            <StatusCode>403</StatusCode>
	            <ReasonPhrase>Forbidden</ReasonPhrase>
	        </Set>
	</FaultResponse>
 </MonetizationLimitsCheck>

Questo elemento ha i seguenti attributi comuni a tutti i criteri:

Riferimento elemento secondario

<DisplayName>

Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso e più naturale.

L'elemento <DisplayName> è comune a tutti i criteri.

La sintassi dell'elemento <DisplayName> è la seguente:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

L'elemento <DisplayName> non ha attributi o elementi secondari.

<IgnoreUnresolvedVariables>

Determina se l'elaborazione del criterio deve essere interrotta quando Apigee incontra una variabile non risolta.

Per ignorare le variabili non risolte e continuare l'elaborazione, imposta il valore su true; altrimenti false. Il valore predefinito è true.

L'impostazione di <IgnoreUnresolvedVariables> su true è diversa dall'impostazione del valore dell'elemento <MonetizationLimitsCheck> Da continueOnError a true. Se imposti continueOnError su true, Apigee non ignora solo gli errori di variabile ma tutti gli errori.

L'elemento <IgnoreUnresolvedVariables> utilizza la seguente sintassi:

<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Specifica le variabili di flusso da cui desideri recuperare durante l'esecuzione del criterio.

Puoi specificare solo l'elemento <Product> all'interno dell'elemento <Variables>. Apigee ottiene Il nome del prodotto API dalla variabile di flusso specificata nell'elemento <Product>. Se non specifichi l'elemento <Variables>, Apigee per impostazione predefinita riceve il nome del prodotto API dal Variabile di contesto apiproduct.name. Utilizzando il nome del prodotto API, Apigee ottiene piano tariffario corrispondente del prodotto ed esegue il controllo dei limiti di monetizzazione.

L'elemento <Variables> utilizza la seguente sintassi:

<Variables>
    <Product>VARIABLE_NAME</Product>
</Variables>

<Variables>
    <Product>myproductvar.name</Product>
</Variables>

<Product>

Specifica la variabile con il nome del prodotto API.

L'elemento <Product> utilizza la seguente sintassi:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Definisce il messaggio di risposta restituito al client richiedente se viene generato un errore. Puoi personalizzare la risposta i messaggi in base ai tuoi requisiti. Per ulteriori informazioni e tutti i relativi elementi secondari, consulta FaultResponse.

Variabili di flusso

Se imposti il parametro <MonetizationLimitsCheck> dell'elemento ContinueOnError su true, non viene rilevato alcun errore. In questo caso, variabili di flusso, mint.limitsViolated, mint.isDeveloperSuspended e mint.limitsPolicyError vengono impostati automaticamente. Queste variabili possono essere utilizzate per gestire ulteriormente le eccezioni, se necessario.