Norme di MonetizeLimitsCheck

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Panoramica

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

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

• Se uno sviluppatore di app che accede all'API monetizzato non ha acquistato un abbonamento al prodotto API associato
• Il saldo dell'account dello sviluppatore è insufficiente.
• Lo sviluppatore ha superato il limite di volume di transazioni.

Per informazioni su come collegare il criterio al proxy API, consulta la pagina Applicare limiti di monetizzazione sui proxy API.

Elemento <MonetizationLimitsCheck>

Specifica la norma MonetizationLimitsCheck.

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

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

<?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 per l'elemento secondario

<DisplayName>

Utilizzalo in aggiunta all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso e dal suono 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 del criterio 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, altrimenti 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 anche tutti gli errori.

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

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Specifica le variabili di flusso da cui vuoi recuperare i nomi delle entità o delle risorse 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 dalla variabile di contesto apiproduct.name. Utilizzando il nome del prodotto API, Apigee ottiene il piano tariffario corrispondente per il prodotto ed esegue il controllo dei limiti di monetizzazione.

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

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

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

<Product>

Specifica la variabile con il nome del prodotto API.

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

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Definisce il messaggio di risposta restituito al client richiedente in caso di 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.