Aplica límites de monetización en proxies de API

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

Consulta la documentación de Apigee Edge.

Adjunta límites de monetización mediante la vinculación de políticas a los proxies de API asociados con un producto de API monetizado, como se describe en las siguientes secciones.

Agrega una política de autenticación

La monetización de Apigee usa la política de VerifyAPIKey o VerifyAccessToken para determinar si una solicitud entrante se puede monetizar mediante la verificación del plan de tarifas publicado activo.

Adjunta la política de VerifyAPIKey o VerifyAccessToken a un proxy de API de una de las siguientes maneras:

  • Cuando creas un proxy de API en el asistente para crear proxy, selecciona Clave de API o OAuth 2.0 en la sección Seguridad: Autorización en la página Políticas comunes. Por ejemplo:

    Página de políticas comunes del asistente de creación de proxy con la clave de API seleccionada

  • Cuando desarrolles un proxy de API, adjunta la política de VerifyAPIKey o VerifyAccessToken al flujo de solicitud como la primera política en el flujo previo del proxy de API. Por ejemplo:

    Pestaña Desarrollador en el editor de proxy de API que muestra la política de VerifyAPIKey adjunta al flujo previo

Para obtener más información, consulte:

Aplica suscripciones de desarrollador a productos de API

Adjunta la política de MonetizationLimitsCheck a los proxies de API para aplicar las suscripciones de los desarrolladores al producto de API. Específicamente, la política se activa si el desarrollador de apps que accede a la API no compró una suscripción para el producto asociado de la API. En este caso, la política MonetizationLimitsCheck genera una falla y bloquea la llamada a la API.

Si no existe un plan de tarifa de monetización para el producto de API recuperado durante la ejecución de la llamada al proxy, el producto se considera no monetizado, la política MonetizationLimitsCheck no recupera más datos y la política no surte efecto.

Cuando adjuntas la política MonetizationLimitsCheck a un proxy de API, las variables del flujo mint.limitscheck.* y mint.subscription_* se propagan las variables de flujo, como se describe en Cómo depurar la política MonetizationLimitsCheck y la referencia de la variable del flujo mint.

Adjunta la política de MonetizationLimitsCheck a un proxy de API de una de las siguientes maneras:

  • Cuando creas un proxy de API mediante el asistente para crear proxy, selecciona Aplicar límites de monetización en la página Políticas comunes, como se muestra en la figura siguiente.

    Página de políticas comunes del asistente para crear proxy con la opción de verificación de aplicación de límites seleccionada

  • Cuando desarrolles un proxy de API, adjunta la MonetizationLimitsCheckPolicy al flujo de solicitudes en el preFlow de proxy de API después de la política VerifyAPIKey o VerifyAccessToken, como se muestra en la siguiente figura.

    Pestaña Desarrollador del editor de proxy de API que muestra la política MonetizationLimitsCheck adjunta a la política de PreFlow después de la política VerifyAPI

Para obtener más información, consulte:

Aplica cuotas de monetización en proxies de API

Una cuota define la cantidad de solicitudes permitidas para un producto de API durante un período determinado. Para aplicar las cuotas a la monetización, te recomendamos que establezcas el valor de la cuota cuando crees un producto de API.

Definir un valor de cuota para un producto de API no aplica automáticamente restricciones en la cantidad de llamadas que se pueden realizar a través del producto de API. También debes agregar políticas de cuotas a los proxies de API a los que hace referencia el producto de API para garantizar que se aplique el valor de la cuota definido en el nivel de producto de la API.

Adjunta la política de Quota a un proxy de API de una de las siguientes maneras:

  • Cuando crees un proxy de API mediante el asistente de creación de proxy, selecciona Cuotas implícitas por app en la sección Cuotas en Políticas comunes, como se muestra en la siguiente figura.

    Página de políticas comunes del asistente de creación de proxy con cuotas de imposición por app seleccionada

  • Cuando desarrolles un proxy de API, adjunta la Quota al flujo de solicitudes en el preFlow de proxy de API después de la política VerifyAPIKey o VerifyAccessToken, como se muestra en la siguiente figura.

    Pestaña Desarrollador en el editor de proxy de API que muestra las políticas de cuota adjuntas el flujo de flujo previo

Edita la política de cuotas para habilitar el elemento <UseQuotaConfigInAPIProduct> a fin de usar la configuración de cuota definida en el nivel de producto de la API.

Por ejemplo:

<Quota continueOnError="false" enabled="true" name="impose-quota">
    <DisplayName>Impose Quota</DisplayName>
    <UseQuotaConfigInAPIProduct stepName="verify-api-key">
        <DefaultConfig>
            <Allow>10000</Allow>
            <Interval>1</Interval>
            <TimeUnit>week</TimeUnit>
        </DefaultConfig>
    </UseQuotaConfigInAPIProduct>
    <Distributed>true</Distributed>
    <Synchronous>true</Synchronous>
    <StartTime>2021-01-01 12:00:00</StartTime>
</Quota>

Cuando adjuntas la política de cuota a un proxy de API, se propagan las variables de flujo ratelimit.*, como se describe en Cómo depurar la política de cuotas y la referencia de las variables de flujo de la política de cuotas.

Para obtener más información, consulte: