Esta página se ha traducido con Cloud Translation API.

Política MonetizationLimitsCheck

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Información general

La política MonetizationLimitsCheck te permite aplicar límites de monetización.

En concreto, la política se activa si el desarrollador de la aplicación que accede a la API monetizada no ha comprado una suscripción al producto de API asociado o si no tiene saldo suficiente. En este caso, la política MonetizationLimitsCheck generará un error y bloqueará una llamada a la API. Para obtener más información, consulta el artículo sobre cómo obligar a los desarrolladores a suscribirse a productos de API.

Cuando adjuntas la política MonetizationLimitsCheck a un proxy de API, se rellenan las variables de flujo mint.limitscheck.* y mint.subscription_*, tal como se describe en la referencia de la variable de flujo mint.

Esta política es una política extensible y su uso puede tener implicaciones en cuanto a costes o utilización, en función de tu licencia de Apigee. Para obtener información sobre los tipos de políticas y las implicaciones de uso, consulta Tipos de políticas.

`<MonetizationLimitsCheck>`

Define la política MonetizationLimitsCheck.

Valor predeterminado	N/A
¿Es obligatorio?	Obligatorio
Tipo	Tipo complejo
Elemento principal	N/A
Elementos secundarios	`<DisplayName>` `<FaultResponse>` `<IgnoreUnresolvedVariables>`

En la siguiente tabla se ofrece una descripción general de los elementos secundarios de <MonetizationLimitsCheck>:

Elemento secundario	¿Es obligatorio?	Descripción
`<DisplayName>`	Opcional	Un nombre personalizado para la política.
`<FaultResponse>`	Opcional	Define el mensaje de respuesta que se devuelve al cliente que ha enviado la solicitud.
`<IgnoreUnresolvedVariables>`	Opcional	Ignora cualquier error de variable sin resolver en el flujo.

El elemento <MonetizationLimitsCheck> utiliza la siguiente sintaxis:

Sintaxis

<?xml version="1.0" encoding="UTF-8" standalone="no"?><MonetizationLimitsCheck continueOnError="[true|false]" enabled="[true|false]" name="policy_name">
   <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
   <FaultResponse>
        <AssignVariable>
          <Name/>
          <Value/>
        </AssignVariable>
        <Add>
            <Headers/>
        </Add>
        <Copy source="request">
            <Headers/>
            <StatusCode/>
       </Copy>
        <Remove>
            <Headers/>
        </Remove>
        <Set>
            <Headers/>
            <Payload/>
            <StatusCode/>
        </Set>
    </FaultResponse>
    <IgnoreUnresolvedVariables>VALUE</IgnoreUnresolvedVariables>
</MonetizationLimitsCheck>

Ejemplo

En el siguiente ejemplo, si un desarrollador no ha comprado una suscripción al producto de API asociado, se bloqueará el acceso a la API monetizada y se devolverá el estado 403 con un mensaje personalizado.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<MonetizationLimitsCheck continueOnError="false" enabled="true" name="MonetizationLimitsCheck-1">
  <DisplayName>Monetization-Limits-Check-1</DisplayName>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <FaultResponse>
    <Set>
      <Payload contentType="text/xml">
        <error>
          <messages>
            <message>Usage has been exceeded ({mint.limitscheck.isRequestBlocked}) or app developer has been suspended</message>
          </messages>
        </error>
      </Payload>
      <StatusCode>403</StatusCode>
    </Set>
  </FaultResponse>
</MonetizationLimitsCheck>

This element has the following attributes that are common to all policies:

Attribute	Default	Required?	Description
`name`	N/A	Required	The internal name of the policy. The value of the `name` attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters. Optionally, use the `<DisplayName>` element to label the policy in the management UI proxy editor with a different, natural-language name.
`continueOnError`	false	Optional	Set to `false` to return an error when a policy fails. This is expected behavior for most policies. Set to `true` to have flow execution continue even after a policy fails. See also: Fault rules are triggered ONLY in an error state (about continueOnError) Handling faults within the current flow
`enabled`	true	Optional	Set to `true` to enforce the policy. Set to `false` to turn off the policy. The policy will not be enforced even if it remains attached to a flow.
`async`	false	Deprecated	This attribute is deprecated.

Referencia de elemento secundario

En esta sección se describen los elementos secundarios de <MonetizationLimitsCheck>.

`<DisplayName>`

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, more natural-sounding name.

The <DisplayName> element is common to all policies.

Default Value	N/A
Required?	Optional. If you omit `<DisplayName>`, the value of the policy's `name` attribute is used.
Type	String
Parent Element	<`PolicyElement`>
Child Elements	None

The <DisplayName> element uses the following syntax:

Syntax

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Example

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

The <DisplayName> element has no attributes or child elements.

`<FaultResponse>`

Define el mensaje de respuesta que se devuelve al cliente que ha enviado la solicitud. FaultResponse usa los mismos ajustes que el elemento <FaultResponse> de la política RaiseFault.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<MonetizationLimitsCheck>`
Elementos secundarios	`<AssignVariable>` `<Add>` `<Copy>` `<Remove>` `<Set>`

`<AssignVariable>`

Asigna un valor a una variable de flujo de destino. Si la variable de flujo no existe, AssignVariable la crea.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<FaultResponse>`
Elementos secundarios	`<Name>` `<Value>`

Por ejemplo, usa el siguiente código para definir la variable llamada myFaultVar en la política MonetizationLimitsCheck:

<FaultResponse>
<AssignVariable>
  <Name>myFaultVar</Name>
  <Value>42</Value>
</AssignVariable>
</FaultResponse>

Una política de una regla de error puede acceder a la variable. Por ejemplo, la siguiente política AssignMessage usa la variable para definir un encabezado en la respuesta de error:

<AssignMessage enabled="true" name="Assign-Message-1">
<Add>
  <Headers>
    <Header name="newvar">{myFaultVar}</Header>
  </Headers>
</Add>
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

<AssignVariable> en la política MonetizationLimitsCheck usa la misma sintaxis que el elemento <AssignVariable> en la política AssignMessage.

`<Name>`

Nombre de la variable. Para obtener más información, consulta el elemento Name de la política AssignMessage.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Cadena
Elemento principal	`<AssignVariable>`
Elementos secundarios	Ninguno

`<Value>`

Valor de la variable. Para obtener más información, consulta el elemento Value de la política AssignMessage.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Cadena
Elemento principal	`<AssignVariable>`
Elementos secundarios	Ninguno

`<Add>`

Añade encabezados HTTP al mensaje de error.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<FaultResponse>`
Elementos secundarios	`<Headers>`

`<Headers>`

Especifica el encabezado HTTP que se va a añadir, definir, copiar o quitar.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<Add>` `<Copy>` `<Remove>` `<Set>`
Elementos secundarios	Ninguno

Ejemplos:

Añadir encabezado

En el siguiente ejemplo, se copia el valor de la variable de flujo request.user.agent en el encabezado:

<Add>
    <Headers>
        <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
</Add>

Definir encabezado

En el siguiente ejemplo se asigna la cabecera user-agent a la variable de mensaje especificada con el elemento <AssignTo>.

<Set>
    <Headers>
        <Header name="user-agent">{request.header.user-agent}</Header>
    </Headers>
</Set>

Copiar encabezado - 1

En el siguiente ejemplo se copia el headerA de la solicitud:

<Copy source='request'>
    <Headers>
        <Header name="headerA"/>
    </Headers>
</Copy>

Copiar encabezado - 2

En el siguiente ejemplo se copian varios encabezados:

<Copy source='request'>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Copy>

En este ejemplo, se copian "h1", "h2" y el segundo valor de "h3". Si "h3" solo tiene un valor, no se copia.

Quitar encabezado - 1

En el siguiente ejemplo se elimina un encabezado:

<Remove>
    <Headers>
        <Header name="user-agent"/>
    </Headers>
</Remove>

Quitar encabezado - 2

En el siguiente ejemplo se eliminan varios encabezados:

<Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Remove>

En este ejemplo, se eliminan "h1", "h2" y el segundo valor de "h3". Si "h3" solo tiene un valor, no se elimina.

`<Copy>`

Copia la información de el mensaje especificado por el atributo source en el mensaje de error.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<FaultResponse>`
Elementos secundarios	`<Headers>` `<StatusCode>`

En la siguiente tabla se describen los atributos de <Copy>:

Atributo	¿Es obligatorio?	Tipo	Descripción
fuente	Opcional	Cadena	Especifica el objeto de origen de la copia. Si no se especifica source, se trata como un mensaje simple. Por ejemplo, si la política está en el flujo de solicitud, la fuente se asigna de forma predeterminada al objeto request. Si la política se encuentra en el flujo de respuesta, se asigna de forma predeterminada al objeto response. Si omite source, puede usar una referencia absoluta a una variable de flujo como origen de la copia. Por ejemplo, especifique el valor {request.header.user-agent}. Si no se puede resolver la variable de origen o se resuelve en un tipo que no es de mensaje, se produce un error en <Copy>.

Atributo

¿Es obligatorio?

Tipo

Descripción

fuente

Opcional

Cadena

Especifica el objeto de origen de la copia.

Si no se especifica source, se trata como un mensaje simple. Por ejemplo, si la política está en el flujo de solicitud, la fuente se asigna de forma predeterminada al objeto request. Si la política se encuentra en el flujo de respuesta, se asigna de forma predeterminada al objeto response. Si omite source, puede usar una referencia absoluta a una variable de flujo como origen de la copia. Por ejemplo, especifique el valor {request.header.user-agent}.
Si no se puede resolver la variable de origen o se resuelve en un tipo que no es de mensaje, se produce un error en <Copy>.

`<StatusCode>`

Especifica el código de estado HTTP en el mensaje de error. Puede copiar o definir el valor de para el objeto especificado por el atributo source.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<Copy>` `<Set>`
Elementos secundarios	Ninguno

Ejemplo:

Copiar código de estado

<Copy source='response'>
    <StatusCode>404</StatusCode>
</Copy>

Definir código de estado

<Set source='request'>
    <StatusCode>404</StatusCode>
</Set>

`<Remove>`

Elimina los encabezados HTTP especificados del mensaje de error. Para quitar todos los encabezados, especifica <Remove><Headers/></Remove>.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<FaultResponse>`
Elementos secundarios	`<Headers>`

`<Set>`

Define la información del mensaje de error.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Tipo complejo
Elemento principal	`<FaultResponse>`
Elementos secundarios	`<Headers>` `<Payload>` `<StatusCode>`

`<Payload>`

Define la carga útil del mensaje de error.

Valor predeterminado	N/A
¿Es obligatorio?	Opcional
Tipo	Cadena
Elemento principal	`<Set>`
Elementos secundarios	Ninguno

Ejemplos:

Definir carga útil de texto

<Set>
    <Payload contentType="text/plain">test1234</Payload>
</Set>

Definir carga útil de JSON (1)

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"bar"}
    </Payload>
</Set>

Definir carga útil de JSON (2)

<Set>
    <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
        {"name":"foo", "type":"@variable_name#"}
    </Payload>
</Set>

En este ejemplo se insertan variables mediante los atributos variablePrefix y variableSuffix con caracteres delimitadores.

Definir carga útil de JSON (3)

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"{variable_name}"}
    </Payload>
</Set>

En este ejemplo se insertan variables mediante llaves. Puedes usar llaves a partir de la versión del 17/08/2016.

Definir la carga útil XML

<Set>
    <Payload contentType="text/xml">
        <root>
          <e1>sunday</e1>
          <e2>funday</e2>
          <e3>{var1}</e3>
    </Payload>
</Set>

En este ejemplo se insertan variables mediante llaves. Puedes usar llaves a partir de la versión del 17/08/2016.

`<IgnoreUnresolvedVariables>`

Determina si el procesamiento se detiene cuando se encuentra una variable sin resolver.

Asigna el valor true para ignorar las variables sin resolver y continuar con el procesamiento. De lo contrario, asigna el valor false. El valor predeterminado es true.

Asignar el valor true a <IgnoreUnresolvedVariables> no es lo mismo que asignar el valor true a continueOnError de <MonetizationLimitsCheck>. Si asigna el valor true a continueOnError, Apigee ignora todos los errores, no solo los de las variables.

El elemento <IgnoreUnresolvedVariables> utiliza la siguiente sintaxis:

Sintaxis

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

Ejemplo

En el siguiente ejemplo se asigna false a <IgnoreUnresolvedVariables>:

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

Códigos de error

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`mint.service.subscription_not_found_for_developer`	`500`	This error occurs when a developer does not have a subscription to the API Product.
`mint.service.wallet_not_found_for_developer`	`500`	This error occurs when a prepaid developer attempts to consume a monetized API without maintaining a wallet for the currency specified in rate plan.
`mint.service.developer_usage_exceeds_balance`	`500`	This error occurs when a prepaid developer's usage exceeds the wallet balance.
`mint.service.wallet_blocked_due_to_inactivity`	`500`	This error occurs when a prepaid developer's wallet is not topped up in over 1.5 years and the developer attempts to consume an API.

Fault variables

Whenever there are execution errors in a policy, Apigee generates error messages. You can view these error messages in the error response. Many a time, system generated error messages might not be relevant in the context of your product. You might want to customize the error messages based on the type of error to make the messages more meaningful.

To customize the error messages, you can use either fault rules or the RaiseFault policy. For information about differences between fault rules and the RaiseFault policy, see FaultRules vs. the RaiseFault policy. You must check for conditions using the Condition element in both the fault rules and the RaiseFault policy. Apigee provides fault variables unique to each policy and the values of the fault variables are set when a policy triggers runtime errors. By using these variables, you can check for specific error conditions and take appropriate actions. For more information about checking error conditions, see Building conditions.

Variables	Where	Example
`fault.name`	The `fault.name` can match to any of the faults listed in the Runtime errors table. The fault name is the last part of the fault code.	`fault.name Matches "UnresolvedVariable"`
`MonetizationLimitsCheck.POLICY_NAME.failed`	`POLICY_NAME` is the user-specified name of the policy that threw the fault.	`MonetizationLimitsCheck.monetization-limits-check-1.failed = true`

For more information about policy errors, see What you need to know about policy errors

Variables de flujo

Las siguientes variables de flujo predefinidas se rellenan automáticamente cuando se ejecuta la política MonetizationLimitsCheck. Para obtener más información, consulta las variables de flujo mint.

Variable de flujo	Descripción
`mint.limitscheck.is_request_blocked`	`true` para las solicitudes bloqueadas.
`mint.limitscheck.is_subscription_found`	`true` si se encuentra una suscripción a la API.
`mint.limitscheck.purchased_product_name`	Nombre del producto de API comprado. Por ejemplo: `MyProduct`.
`mint.limitscheck.status_message`	Mensaje de estado. Se pueden devolver los siguientes valores: `limits_check_success`: comprobación de límites correcta. `apiproduct_name_and_developer_email_not_available` - No se puede determinar el desarrollador de la API ni el nombre del producto de la API para comprobar los límites. `apiproduct_name_not_available` - No se ha podido determinar el nombre del producto de la API para comprobar los límites. `developer_email_not_available` - No se ha podido determinar el correo del desarrollador de la API para comprobar los límites. `developer_usage_exceeds_balance` - El saldo de prepago del desarrollador es demasiado bajo. `rateplan_not_available` - Producto de API sin plan de tarifas, sin errores. `subscription_not_available` - El desarrollador de la API que es propietario de la aplicación no tiene una suscripción. `wallet_disabled_due_to_inactivity`: el desarrollador no ha usado su cartera en más de un año. Para reactivarla, debes añadir al menos una unidad (en dólares, sería 0,01 USD). `wallet_not_found`: el desarrollador no tiene una cartera. Esto puede ocurrir cuando no se ha realizado ninguna recarga para ese desarrollador.
`mint.subscription_end_time_ms`	Hora de finalización de la suscripción al producto de API.
`mint.subscription_start_time_ms`	Hora de inicio de la suscripción al producto de API. Por ejemplo: `1618433956209`.

Política MonetizationLimitsCheck Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Información general

<MonetizationLimitsCheck>

Sintaxis

Ejemplo

Referencia de elemento secundario

<DisplayName>

Syntax

Example

<FaultResponse>

<AssignVariable>

<Name>

<Value>

<Add>

<Headers>

Añadir encabezado

Definir encabezado

Copiar encabezado - 1

Copiar encabezado - 2

Quitar encabezado - 1

Quitar encabezado - 2

<Copy>

<StatusCode>

Copiar código de estado

Definir código de estado

<Remove>

<Set>

<Payload>

Definir carga útil de texto

Definir carga útil de JSON (1)

Definir carga útil de JSON (2)

Definir carga útil de JSON (3)

Definir la carga útil XML

<IgnoreUnresolvedVariables>

Sintaxis

Ejemplo

Códigos de error

Runtime errors

Fault variables

Variables de flujo

Política MonetizationLimitsCheck

`<MonetizationLimitsCheck>`

`<DisplayName>`

`<FaultResponse>`

`<AssignVariable>`

`<Name>`

`<Value>`

`<Add>`

`<Headers>`

`<Copy>`

`<StatusCode>`

`<Remove>`

`<Set>`

`<Payload>`

`<IgnoreUnresolvedVariables>`