Configura el plan ajustable de notificaciones

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

Introducción

En un plan de notificaciones ajustable, el proveedor de la API puede ajustar la cantidad objetivo de transacciones para cada desarrollador de apps. Puedes configurar si se enviarán las notificaciones y cuándo se realizará en función del momento en que se alcance un porcentaje de la cantidad objetivo, como 90%, 100% o 150%. Las transacciones adicionales no se bloquean después de que se alcanza la cantidad objetivo.

Configura un plan de notificaciones ajustable con la IU

Configura planes de notificación ajustables, como se describe a continuación.

Conexión de integración

Para configurar un plan de notificaciones ajustable con la IU de Edge, cuando agregues o edites un plan de tarifas, selecciona el tipo de plan de tarifas Adjustable Notification y, en la sección Adjustable Notification, configura la siguiente información:

Campo Descripción Predeterminada
Frecuencia de cálculo Es el período en el que se calcula el volumen de transacciones (o el volumen relacionado con los atributos personalizados). Selecciona una cantidad de meses (de 1 a 24 meses). 1 mes

Si definiste atributos personalizados para tu producto de API, puedes configurar un parámetro de calificación personalizada a fin de definir un contador de transacciones basado en un atributo personalizado.

Por ejemplo, es posible que debas hacer lo siguiente:

  • Cobra a los desarrolladores un importe variable según un valor proporcionado en el mensaje de una llamada a la API.
    Por ejemplo, es posible que quieras cobrar a los desarrolladores de apps según la cantidad de bytes que se transmiten en la solicitud a la API.
  • Agrupa varias llamadas a la API en una sola transacción.
    En este caso, selecciona Usar el parámetro de calificación personalizado y elige el atributo personalizado de la lista desplegable.

Para obtener más información, consulta Configura el plan de tarifas con atributos personalizados.

Versión clásica de Edge (nube privada)

Para configurar planes de notificación ajustables con la IU clásica de Edge, haz lo siguiente:

  1. Selecciona Adjustable Notification en el campo Rate Plan Type de la pestaña Plan Details, en la ventana Rate Plan.

    Consulta Crea un plan de tarifas con la IU para obtener información sobre cómo acceder a la ventana Plan de tarifas.

  2. Establece el campo Período de renovación en la cantidad de meses en los que el plan se renueva automáticamente (a menos que el desarrollador rescinda el acuerdo antes de esa fecha). Si estableces este valor en 0, el plan seguirá vigente hasta que el desarrollador decida finalizarlo.
  3. En Plan de tarifas genéricas, haz clic en Detalles.
  4. Establece la Base de agregación en el período durante el que se agrega el volumen de transacciones. Selecciona un número entre 1 y 24 meses. El valor predeterminado es de 1 mes.
  5. Haz clic en Aplicar y cerrar.
  6. Haz clic en Guardar borrador.
  7. Publica el plan solo cuando estés absolutamente seguro de que es definitivo. Consulta Publicación de planes de tarifas para obtener información sobre cómo configurar la fecha de publicación y cómo publicar el plan.

    Después de publicar un plan de tarifas, solo puedes modificar la fecha de finalización. No puedes borrar un plan de tarifas después de publicarlo, pero puedes hacer que venza el plan de tarifas y reemplazarlo por uno futuro, como se describe en Cómo vencer un plan de tarifas publicado.

Configura un plan de notificaciones ajustable con la API

Especifica los detalles del plan de notificaciones ajustables en la propiedad ratePlanDetails en el cuerpo de la solicitud en una solicitud POST a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans.

Para especificar un plan de notificaciones ajustable, especifica los siguientes valores en ratePlanDetails del cuerpo de la solicitud:

Propiedad Valor
type Debes establecerlo en USAGE_TARGET.
meteringType Debes establecerlo en DEV_SPECIFIC.
duration Se establece en el período de la agregación, junto con durationType. En el caso de los planes de frecuencia de notificaciones ajustables, establece esto en un valor entero entre 1 y 24.
durationType

Se establece en el período de la agregación, junto con durationType. Para planes de frecuencia de notificaciones ajustables, establece este valor en MONTH.

Para obtener más información sobre las propiedades de configuración que se pueden configurar cuando se especifican los detalles del plan de notificaciones ajustables, consulta Configuración de los detalles del plan de tarifas.

Por ejemplo, lo siguiente define un plan de notificaciones ajustable con una base de agregación establecida en 1 mes.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

Cómo establecer la cantidad objetivo de transacciones para cada desarrollador de apps mediante la API

Para cada desarrollador de apps que haya aceptado el plan de frecuencia de notificaciones ajustable, debes establecer la cantidad objetivo de transacciones. Puedes configurar si se enviarán las notificaciones y cuándo se realizará en función del momento en que se alcance un porcentaje de la cantidad objetivo, como 90%, 100% o 150%. Las transacciones adicionales no se bloquean después de que se alcanza la cantidad objetivo.

Puedes establecer la cantidad objetivo de transacciones para un desarrollador de apps cuando este acepte el plan de tarifas, y puedes actualizar el valor más tarde.

Establece la cantidad objetivo de transacciones cuando se acepta el plan de tarifas

Cuando aceptes el plan de tarifas, especifica la propiedad quotaTarget en el cuerpo de una solicitud POST al recurso /organizations/{org_name}/developers/{developer_id}/developer-rateplans para establecer la cantidad objetivo de transacciones. Establece quotaTarget en un número entero positivo o 0 para inhabilitar las notificaciones para el desarrollador de apps. Si no se especifica, quotaTarget se establece de forma predeterminada en 0.

Por ejemplo, en la siguiente solicitud, se establece la cantidad objetivo de transacciones en 4,000 cuando el desarrollador de apps acepta el plan de notificaciones ajustable.

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

Establece la cantidad objetivo de transacciones cuando se actualiza el plan de tarifas aceptado

Para establecer la cantidad objetivo de transacciones, puedes actualizar el plan de tarifas aceptado y especificar la propiedad quotaTarget en el cuerpo de la solicitud PUT para el recurso /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Establece quotaTarget como un número entero positivo o 0 para inhabilitar las notificaciones para el desarrollador de apps. Si no se especifica, quotaTarget se establece de forma predeterminada en 0.

Cuando aceptas el plan de tarifas publicado, se muestra {developer_rateplan_id} en la respuesta.

Por ejemplo:

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Como alternativa, puedes obtener el {developer-rateplan-id} para el plan de tarifas del desarrollador mediante una solicitud GET a /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, en la que {developer_id} es la dirección de correo electrónico del desarrollador. Para obtener más información, consulta Visualiza todos los planes de tarifas que acepta un desarrollador.

Por ejemplo:

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}
        

La siguiente solicitud actualiza la cantidad objetivo de transacciones a 4,000.

$ cURL0email:password