Cómo configurar una notificación con un límite para un plan de tarifas

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Puedes notificar a los desarrolladores por correo electrónico cuando se acerquen a un límite determinado o lo alcancen en un plan de tarifas de bandas de volumen o de paquete que hayan comprado. Por ejemplo, si los desarrolladores compran un plan de bandas de volumen con 1,000 llamadas en un paquete, puedes notificarles cuando alcancen las 800 llamadas (80% de uso) o cuando hayan gastado USD 500 en llamadas a la API.

Para configurar una notificación de límite para un plan de tarifas con la API, sigue estos pasos:

1. Personaliza la plantilla de notificación que se usará para notificar al desarrollador.
2. Configura la condición y la acción de la notificación.

Personaliza la plantilla de notificación

A continuación, se proporciona un ejemplo de cómo personalizar la plantilla de notificación que se usará para notificar al desarrollador. Para obtener más información, consulta Administra plantillas de notificación con la API.

$ curl -H "Content-Type: application/json " -X POST -d \    
'{
    "name": "RATE_PLAN_LIMIT_TEMPLATE",
    "subject": "Nearing your rate plan limit",
    "htmlImage": "<p>Hi ${developer.name} - Wanted to let you know that you have used 800 API calls from your ${ratePlan.displayName} rate plan, which started on ${ratePlan.startDate} under the ${ratePlan.monetizationPackage.displayName} package and ${ratePlan.monetizationPackage.products.displayName} product. Just a friendly reminder that your API calls will be charged double after you cross 1000 calls. Thanks for using the API!</p>",
    "source": "Postman API call"
    }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
    -u email:password

Configura la condición y la acción de la notificación

Configura una condición y una acción de notificación con la API, como se describe en Configura condiciones y acciones de notificación con la API.

Para activar la notificación de un límite de plan de tarifas, establece los siguientes atributos:

• RATEPLAN : Es el tipo de notificación que se enviará.
• PUBLISHED : Establece este atributo en TRUE para activar las notificaciones en los planes de tarifas publicados.

Luego, especifica uno de los siguientes atributos:

• Transactions : Es la cantidad de transacciones. Por ejemplo, notifica a los desarrolladores cuando alcancen las 800 transacciones. Debe ser un valor de número entero y solo se permiten los operadores > y = permitidos.
• FeeExposure : Es la cantidad de dólares o puntos acumulados en las transacciones. Debe ser un valor de número entero y solo se permiten los operadores > y =. FeeExposure no incluye los importes de las tarifas de configuración, recurrentes ni de rescisión. Por ejemplo, notifica a los desarrolladores cuando el costo de sus transacciones de API alcance los USD 500. FeeExposure cálculos varían según la tasa impositiva.

La siguiente carga útil activa una notificación por correo electrónico cuando la cantidad de transacciones alcanza las 800:

$ curl -H "Content-Type:application/json" -X POST -d \
    '{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "{RATE_PLAN_ID}"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "Transactions",
        "value": "= 800"
      }     
    ],
   "actions": [{
          "actionAttribute": "DEV_ID",
          "value": "ANY",
          "templateId": "{EMAIL_TEMPLATE_ID}"
        }]
  }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
    -u email:password