Se usó la API de Cloud Translation para traducir esta página.

Configura el plan ajustable de notificaciones

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

Introducción

En un plan de notificaciones ajustable, el proveedor de API puede ajustar el número objetivo de transacciones para cada desarrollador de apps. Puedes configurar si se envían notificaciones y cuándo, según el momento en que se alcance un porcentaje de la cantidad objetivo, como el 90%, el 100% o el 150%. Las transacciones adicionales no se bloquean después de alcanzar la cantidad objetivo.

Cómo configurar un plan de notificaciones ajustable con la IU

Configura 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 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 durante el cual se calcula el volumen de transacciones (o el volumen relacionado con los atributos personalizados). Selecciona una cantidad de meses (entre 1 y 24 meses).	1 mes

Si definiste atributos personalizados para el producto de API, puedes configurar un parámetro de calificación personalizada 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.
Agrupa varias llamadas a la API en una sola transacción.
En este caso, selecciona Usar 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.

Edge clásico (nube privada)

Para configurar planes de notificaciones ajustables con la IU de Edge clásico, haz lo siguiente:

Selecciona Adjustable Notification en el campo Rate Plan Type de la pestaña Plan Details, en la ventana Rate Plan.
Consulta Cómo crear un plan de tarifas con la IU para obtener información sobre cómo acceder a la ventana Plan de tarifas.

Nota: Las pestañas Tarifas y Freemium estarán inhabilitadas después de que selecciones el tipo de notificación ajustable, ya que no son aplicables a los planes de notificaciones ajustables.
Establece el campo Plazo de renovación en la cantidad de meses en la que se renueva automáticamente el plan (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.
Haz clic en Detalles en Plan de tarifas genérico.
Establece el Período 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.
Haz clic en Aplicar y cerrar.
Haz clic en Guardar borrador.
Publica el plan solo cuando estés absolutamente seguro de que es definitivo. Consulta Publica planes de tarifas para obtener 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 publicarlo, pero puedes vencerlo y reemplazarlo por un plan de tarifas 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 el campo ratePlanDetails del cuerpo de la solicitud:

Propiedad	Valor
`type`	Debes establecerlo en `USAGE_TARGET`.
`meteringType`	Debes establecerlo en `DEV_SPECIFIC`.
`duration`	Establece el período para la base de agregación, junto con `durationType`. Para los planes de frecuencia de notificaciones ajustables, establece este valor en un número entero entre 1 y 24.
`durationType`	Establece el período para 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 Parámetros de 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

Configura la cantidad objetivo de transacciones para cada desarrollador de apps que usa la API

Para cada desarrollador de apps que haya aceptado el plan de tarifas de notificaciones ajustables, debes establecer la cantidad objetivo de transacciones. Puedes configurar si se envían notificaciones y cuándo se envían según cuándo se alcance 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 acepte el plan de tarifas y puedes actualizar el valor más adelante.

Cómo establecer la cantidad objetivo de transacciones cuando aceptas 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 la app. Si no se especifica, el valor predeterminado de quotaTarget es 0.

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

Cómo establecer 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 en una solicitud PUT al recurso /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id}. Establece quotaTarget en un número entero positivo o 0 para inhabilitar las notificaciones del desarrollador de la app. Si no se especifica, el valor predeterminado de quotaTarget es 0.

El {developer_rateplan_id} se muestra 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} del plan de tarifas del desarrollador si emites 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 Cómo ver todos los planes de tarifas que aceptó 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