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

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

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

Si quieres 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 lo siguiente: notificar al desarrollador.
  2. Configura la condición y la acción de la notificación.

Cómo personalizar la plantilla de notificaciones

A continuación, se muestra un ejemplo de cómo personalizar la plantilla de notificación que se que se usa para notificar al desarrollador. Para obtener más información, consulta Administra plantillas de notificaciones 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 mediante la API, como se describe en Cómo configurar y las acciones de notificación con la API.

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

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

Luego, especifica uno de los siguientes atributos:

  • Transactions: Número de transacciones. Por ejemplo, notifica a los desarrolladores cuando llegan a las 800 transacciones. Debe ser un número entero y solo > y = son por lo que está permitido.
  • FeeExposure: Importe de dólares o puntos acumulados en transacciones. Debe ser un número entero > y =. FeeExposure no incluye los importes de la configuración, las tarifas recurrentes ni la tarifa de rescisión. Por ejemplo, notifica a los desarrolladores cuando el costo de sus transacciones de API llega a $500. FeeExposure cálculos varían según la tasa impositiva.

La siguiente carga útil activa una notificación por correo electrónico cuando se alcanza la cantidad de transacciones. 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