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

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Puedes notificar a los desarrolladores por correo electrónico cuando se acerquen a un determinado límite de un plan de hoja de tarifas por paquete o por volumen que hayan comprado o cuando se acerquen a él. Por ejemplo, si los desarrolladores compran un plan por bandas de volumen con 1,000 llamadas en un paquete, puedes notificarles cuando alcancen las 800 llamadas (80% de uso) o cuando gasten $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 notificaciones que se usará para notificar al desarrollador.
  2. Configura la acción y la condició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 notificaciones 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 acción y la condición de la notificación

Configura una condición y acción de notificación mediante la API, como se describe en Cómo configurar las condiciones y acciones de notificación mediante la API.

Para activar la notificación sobre el límite del plan de tarifas, configura los siguientes atributos:

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

Luego, especifica uno de los siguientes atributos:

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

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