Configura el plan ajustable de notificaciones

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

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 envían notificaciones y cuándo se envían en función de cuándo se alcanza un porcentaje de la cantidad objetivo, como el 90%, el 100% o el 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 los planes de notificaciones ajustables como se describe a continuación.

Edge

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 Notificación ajustable y, en la sección Notificación ajustable, configura la siguiente información:

Campo Descripción Predeterminado
Frecuencia de cálculo Período durante el cual se calcula el volumen de transacciones (o el volumen relacionado con el atributo personalizado). 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 personalizado para definir un contador de transacciones basado en un atributo personalizado.

Por ejemplo, es posible que debas hacer lo siguiente:

  • Cobrar a los desarrolladores un importe variable en función de un valor proporcionado en el mensaje de una llamada a la API.
    Por ejemplo, es posible que desees cobrar a los desarrolladores de apps en función de la cantidad de bytes transmitidos en la solicitud a la API.
  • Agrupar varias llamadas a la API en una sola transacción.
    En este caso, selecciona Usar parámetro de calificación personalizado y selecciona el atributo personalizado de la lista desplegable.

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

Classic Edge (nube privada)

Para configurar planes de notificaciones ajustables con la IU de Classic Edge, haz lo siguiente:

  1. Selecciona Notificación ajustable en el campo Tipo de plan de tarifas de la pestaña Detalles del plan en la ventana Plan de tarifas.

    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 Plazo de renovación en la cantidad de meses en la 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 permanecerá vigente hasta que el desarrollador decida finalizarlo.
  3. Haz clic en Detalles en Plan de tarifas genérico.
  4. Establece la Base de agregación en el período durante el cual se agrega el volumen de transacciones. Selecciona un número entre 1 y 24 meses. El valor predeterminado es 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 Publica planes de tarifas para información sobre cómo establecer la fecha de publicación y 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 que se publica, pero puedes hacer que venza y reemplazarlo por un plan de tarifas futuro, como se describe en Haz que venza un plan de tarifas publicado.

Configura un plan de notificaciones ajustable con la API

Especifica los detalles del plan de notificaciones ajustable 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 el ratePlanDetails del cuerpo de la solicitud:

Propiedad Valor
type Debes establecerlo en USAGE_TARGET.
meteringType Debes establecerlo en DEV_SPECIFIC.
duration Debes establecerlo en el período de la base de agregación, junto con durationType. Para los planes de tarifas de notificaciones ajustables, establece este valor en un número entero entre 1 y 24.
durationType

Debes establecerlo en el período de la base de agregación, junto con durationType. Para los planes de tarifas de notificaciones ajustables, establece este valor en MONTH.

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

Por ejemplo, en el siguiente ejemplo, se 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

Establece la cantidad objetivo de transacciones para cada desarrollador de apps con la API

Para cada desarrollador de apps que haya aceptado el plan de tarifas de notificaciones ajustable, debes establecer la cantidad objetivo de transacciones. Puedes configurar si se envían notificaciones y cuándo se envían en función de cuándo se alcanza un porcentaje de la cantidad objetivo, como el 90%, el 100% o el 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 acepta el plan de tarifas y puedes actualizar el valor más adelante.

Establece la cantidad objetivo de transacciones cuando aceptes el plan de tarifas

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

Por ejemplo, la siguiente solicitud 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 actualices el plan de tarifas aceptado

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

Se muestra {developer_rateplan_id} en la respuesta cuando aceptas el plan de tarifas publicado.

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 enviando una solicitud GET a /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, donde {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 aceptados por 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.

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password