Norme relative a MonetizationLimitsCheck

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Panoramica

La policy MonetizationLimitsCheck consente di applicare limiti di monetizzazione alle chiamate API effettuate dallo sviluppatore di app.

Alcuni dei casi in cui viene attivata la policy sono:

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

Per informazioni su come collegare la policy al proxy API, consulta Applicare limiti di monetizzazione ai proxy API.

Elemento <MonetizationLimitsCheck>

Specifica la policy MonetizationLimitsCheck.

La tabella seguente fornisce una descrizione di alto livello 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 agli elementi secondari

<DisplayName>

Utilizza questo attributo in aggiunta 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.

L'elemento <DisplayName> utilizza la seguente sintassi:

<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 della policy deve essere interrotta quando Apigee rileva una variabile non risolta.

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

L'impostazione di <IgnoreUnresolvedVariables> su true è diversa dall'impostazione di continueOnError dell'elemento <MonetizationLimitsCheck> su true. Se imposti continueOnError su true, Apigee ignora non solo gli errori delle variabili, 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 vuoi recuperare i nomi di entità o risorse durante l'esecuzione della policy.

Puoi specificare solo l'elemento <Product> all'interno dell'elemento <Variables>. Apigee recupera il nome del prodotto API dalla variabile di flusso specificata nell'elemento <Product>. Se non specifichi l'elemento <Variables>, Apigee recupera per impostazione predefinita il nome del prodotto API dalla variabile di contesto apiproduct.name. Utilizzando il nome del prodotto API, Apigee recupera il piano tariffario corrispondente per il 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 i messaggi di risposta in base alle tue esigenze. Per ulteriori informazioni sull' elemento e su tutti i relativi elementi secondari, consulta FaultResponse.

Variabili di flusso

Se imposti l'attributo ContinueOnError dell'elemento <MonetizationLimitsCheck> su true, non viene generato alcun errore. In questo caso, le variabili di flusso mint.limitsViolated, mint.isDeveloperSuspended e mint.limitsPolicyError vengono impostate automaticamente. Queste variabili possono essere utilizzate per eseguire un'ulteriore gestione delle eccezioni, se necessario.