Configura el plan ajustable de notificaciones

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

Introducción

En un plan de notificación ajustable, el proveedor de la API puede ajustar el número objetivo de transacciones de cada desarrollador de apps. Puedes configurar si se envían notificaciones y cuándo hacerlo cuando se alcanza un porcentaje de la cifra objetivo, como el 90%, el 100% o el 150%. Adicional las transacciones no se bloquean después de que se alcanza la cifra objetivo.

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

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

Edge

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

Campo Descripción Predeterminado
Frecuencia de cálculo Es el período en el que se calcula el volumen de transacciones (o el volumen relacionado con 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 según el número de bytes transmitidos en la solicitud a la API.
  • Agrupa varias llamadas a la API en una sola transacción.
    En ese caso, selecciona Usar parámetro de calificación personalizada y el atributo personalizado de la lista desplegable.

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

Classic Edge (nube privada)

Para configurar planes de notificaciones ajustables con la IU clásica de Edge, sigue estos pasos:

  1. Selecciona Adjustable Notification en Rate Plan Type. en la pestaña Detalles del plan de 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 Período de renovación en la cantidad de meses en los que el plan se renueve automáticamente (a menos que el desarrollador resuelva el acuerdo antes de esa fecha). Si estableces este valor en 0, el plan permanece vigente hasta que el desarrollador decida finalizarlo.
  3. En Generic Rate Plan, haz clic en Details.
  4. Configura la Base de agregación como el período de tiempo durante el cual el volumen de las transacciones de forma agregada. 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 Publicación de planes de tarifas para información sobre cómo configurar 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 una tarifa después de su publicación, pero puedes hacer que el plan de tarifas venza y reemplazarlo por una tarifa futura según se describe en Cómo vencer una tarifa publicada tradicional.

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 de una solicitud POST al /organizations/{org_name}/monetization-packages/{package_id}/rate-plans

Para determinar un plan de notificación 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 Se establece como el período para la base de agregación, junto con durationType Para los planes de tarifas de notificaciones ajustables, establece este valor en un número entero valor entre 1 y 24.
durationType

Se establece como el período para la base de agregación, junto con durationType Para los planes de tarifas de notificaciones ajustables, establece este valor a MONTH.

Para obtener más información sobre las propiedades de configuración que se pueden establecer cuando se especifica detalles del plan de notificación ajustable, consulta Detalles del plan de tarifas parámetros de configuración.

Por ejemplo, a continuación, se define un plan de notificación ajustable con una base de agregación se establece 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 configurar el objetivo la cantidad de transacciones para cada desarrollador de apps que usa la API

Para cada desarrollador de apps que haya aceptado el plan de tasa de notificaciones ajustable, debes hacer lo siguiente: establecer el objetivo de transacciones. Puedes configurar si se envían notificaciones y cuándo. según el momento en que se alcanza un porcentaje de la cifra 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 el desarrollador de apps cuando este lo acepte del 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, especifica la la propiedad quotaTarget en el cuerpo de la solicitud de una solicitud POST al Recurso /organizations/{org_name}/developers/{developer_id}/developer-rateplans. Establece quotaTarget en un número entero positivo o 0 para inhabilitar las notificaciones de la app. desarrollador. 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 la app el desarrollador acepta el plan de notificación 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 aceptadas y especificar la propiedad quotaTarget 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 0 para inhabilitarlo. para el desarrollador de la app. Si no se especifica, el valor predeterminado de quotaTarget es 0.

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 la tarifa para desarrolladores. a través del envío de una solicitud GET a /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, En el ejemplo anterior, {developer_id} es la dirección de correo electrónico del desarrollador. Para obtener más información, consulta Consultar 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.

$ curl -H "Content-Type:application/json" -X PUT -d \
{ 
   "id" : “b1c600b8-f871-496d-8173-12b9950d6ab1”,
   "developer":{
     “id”:“dev@miempresa.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