Administrar planes de tarifas para productos de API

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Con los planes de tarifas, los propietarios de productos de API pueden monetizar sus productos de API mediante la configuración de lo siguiente:

  • El modelo de cuenta de facturación
  • La moneda que se usa para la facturación
  • La frecuencia con la que se factura a los clientes (solo un mes)
  • Las tarifas de configuración iniciales para usar un producto de API
  • Los cargos basados en el consumo para usar un producto de API
  • Las tarifas recurrentes que no se basan en el consumo, como las tarifas mensuales por acceder a tu producto de API
  • El intervalo de tiempo durante el cual el plan de tarifas está vigente para un producto de API (tiempo de vencimiento y activación del plan de tarifas)
  • Reparto de ingresos con socios desarrolladores

Administra los planes de tarifas para tus productos de API como se describe en las siguientes secciones.

Visualiza planes de tarifas

Consulta los planes de tarifas de tu organización como se describe en las siguientes secciones.

IU de Apigee

Consulta los planes de tarifas mediante la IU como se describe en las siguientes secciones:

Visualiza planes de tarifas definidos para tu organización

Consulta los planes de tarifas definidos para tu organización en la página Planes de tarifas.

Para acceder a la página de planes de tarifas, haz lo siguiente:

  1. Accede a la IU de Apigee.
  2. Selecciona Publicar > Monetización > Planes de tarifas en la barra de navegación lateral.

Se abrirá la página Planes de tarifas y se mostrarán los planes actuales.

Lista de planes de tarifas que muestran el nombre del plan de tarifas, el producto de API y los tiempos de activación y vencimiento de cada uno, además del menú desplegable que se puede usar para administrar el plan de tarifas

Como se destacó en la figura anterior, la página Planes de tarifas te permite hacer lo siguiente:

Visualiza planes de tarifas asociados con un producto de API

Cuando administras un producto de API, puedes ver y administrar los planes de tarifas asociados con un producto de API, como se muestra en la siguiente figura.

Página Productos de API con la sección Planes de tarifas destacada

API de Apigee

En las siguientes secciones, se describe cómo ver los planes de tarifas de una organización mediante la API:

Ve una lista de los planes de tarifas para un producto de API mediante la API

Para ver una lista de los planes de tarifas de la organización, envía una solicitud GET a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

Por ejemplo, con curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans?expand=true" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Para obtener una descripción de las variables de entorno utilizadas, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta, incluidos los dos planes de tarifas, myrateplan1 y myrateplan2 asociados con el producto de la API HelloworldProduct:

{
    "ratePlans": [
        {
            "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan2",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "setupFee": {
                "currencyCode": "USD",
                "units": "20"
            },
            "fixedRecurringFee": {
                "currencyCode": "USD",
                "units": "25"
            },
            "fixedFeeFrequency": 1,
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "nanos": 500000000
                    }
                }
            ],
            "revenueShareType": "FIXED",
            "revenueShareRates": [
                {
                    "sharePercentage": 2
                }
            ],
            "state": "DRAFT"
        },
        {
            "name": "8c0b527c-ba2f-45f1-ac1c-b9e891546fc2",
            "apiproduct": "HelloworldProduct",
            "displayName": "myrateplan1",
            "billingPeriod": "MONTHLY",
            "currencyCode": "USD",
            "consumptionPricingType": "FIXED_PER_UNIT",
            "consumptionPricingRates": [
                {
                    "fee": {
                        "currencyCode": "USD",
                        "units": "3"
                    }
                }
            ],
            "state": "PUBLISHED",
            "startTime": "1617302588000"
        }
    ]
}

Para obtener más información sobre la API y su carga útil de respuesta, consulta la API de planes de tarifas de lista.

Visualiza los detalles de un plan de tarifas mediante la API

Para ver los detalles de un plan de tarifas, envía una solicitud GET a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME

Para determinar el nombre del plan de tarifas que se pasará en la ruta de acceso del recurso, consulta Ver una lista de los planes de tarifas en una organización.

Por ejemplo, con curl:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans/$RATEPLAN_NAME" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Para obtener una descripción de las variables de entorno utilizadas, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta para el plan de tarifas con el nombre 6b51b501-ac15-41b7-bb3e-621edb849e13 y el nombre comercial myrateplan2:

{
    "name": "6b51b501-ac15-41b7-bb3e-621edb849e13",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan2",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "20"
    },
    "fixedRecurringFee": {
        "currencyCode": "USD",
        "units": "25"
    },
    "fixedFeeFrequency": 1,
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "nanos": 500000000
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 2
        }
    ],
    "state": "DRAFT"
}

Para obtener más información sobre la API y su carga útil de respuesta, consulta la API de obtención de planes de tarifas.

Crea planes de tarifas

Crea planes de tarifas como se describe en las siguientes secciones.

IU de Apigee

Para crear un plan de tarifas con la IU, haz lo siguiente:

  1. Realiza una de las siguientes tareas:
    • Selecciona Publicar > Monetización > Planes de tarifas en la barra de navegación lateral y haz clic en Crear plan de tarifas.
    • Edita un producto de API y haz clic en Botón para agregar en la sección Planes de tarifas.
  2. Ingresa los detalles del plan de tarifas de la siguiente manera:
    Campo Descripción
    Nombre del plan de tarifas Ingresa el nombre del plan de tarifas.
    Producto de API En el menú desplegable, selecciona un producto de la API con el que deseas asociar el plan de tarifas.
  3. Haga clic en Next.
  4. Ingresa los detalles de Facturación, de la siguiente manera:
    Campo Descripción Predeterminada
    Moneda de facturación Selecciona la moneda que se usará para la facturación en el menú desplegable. USD
    Período de facturación En el menú desplegable, selecciona la frecuencia con la que se facturará al cliente. Mensual
    Modelo de financiación de pagos Selecciona el modelo de pago que se usa para las cuentas de fondos. Postpaid es la única opción válida en esta versión. Pospago
    Tarifa de inicialización

    Una tarifa única que se cobra a cada desarrollador en la fecha de inicio del plan de tarifas (es decir, la fecha en la que el desarrollador compra el producto de API).

    Si deseas cobrar la tarifa de inicialización, selecciona Cobrar tarifa de inicialización y, luego, ingresa el importe que se cobrará en el campo Initialization fee.

    Inhabilitada
  5. Haga clic en Next.
  6. Ingresa los detalles de precio como se indica a continuación.
    Campo Descripción Predeterminado
    Tarifa recurrente fija Habilita una tarifa fija recurrente por unidad:
    1. Selecciona Cargo de tarifa fija recurrente.
    2. Configura el importe de la Tarifa fija recurrente y la Frecuencia de tarifas.

    La tarifa se prorrateará para el primer período de facturación.

    Si se habilita, puedes obtener una vista previa de los efectos que tendrá la tarifa fija recurrente en los cargos detallados y totales, como se describe en Obtén una vista previa del plan de tarifas.

    Para inhabilitar la tarifa, anula la selección de Cargos fijos y recurrentes.

    Inhabilitada
    Tarifas basadas en el consumo Habilita los precios basados en el consumo:
    1. Selecciona Cargar tarifa por consumo.
    2. Selecciona una de las opciones siguientes:
      • Tarifa fija por unidad (tarifa fija por unidad consumida)
      • Por banda (una tarifa variable por unidad consumida, determinada por los rangos de consumo)
    • Tarifa fija por unidad: Se cobra una tarifa fija por cada transacción monetizada. Ingresa un valor en el campo Tarifa fija por unidad que se debe cobrar por cada transacción.

    • Por banda: se cobra una tarifa variable por cada transacción monetizada. La banda de la transacción y el consumo determinan las tarifas de una transacción. Una banda hace referencia a un rango de consumo de API, y cada banda tiene una tarifa diferente. En la sección Ranges of unit consumption, puedes especificar los rangos de la banda y las tarifas correspondientes para la banda. Para especificar cuántas bandas quieres, haz clic en + BAND.

      Ejemplo: Supongamos que deseas cobrar las primeras 1,000 llamadas a la API con un costo de $2 por llamada y todas las llamadas posteriores a la API a $1 por llamada. Para configurar esto, especifica las siguientes dos bandas en la sección Ranges of unit consumption:

      • En la primera fila, ingresa los siguientes valores:
        • Inicio: 0
        • Fin: 1000
        • Tarifa: 2
      • En la segunda fila, ingresa los siguientes valores:
        • Inicio: 1001
        • Fin: unidades ilimitadas
        • Tarifa: 1

      En este ejemplo, si un desarrollador consume 1,500 API, las tarifas totales serán de $2,500 ((1000 * 2) + (500 * 1)).

    Si habilitas las tarifas basadas en el consumo, puedes obtener una vista previa de los efectos del tipo de tarifa seleccionado sobre los ingresos generales, como se describe en Obtén una vista previa del plan de tarifas.

    Para inhabilitar la tarifa, anula la selección de Modelo de precios basado en el consumo de cargos.

    Si configuraste la variable de monetización perUnitPriceMultiplier en tu política de DataCapture, el costo por transacción especificado en cualquier tipo (tarifa fija por unidad o banda) de tarifas basadas en el consumo se multiplica por el valor de perUnitPriceMultiplier.

    Inhabilitado
  7. Haga clic en Next.
  8. Ingresa los detalles de Porcentaje de ingresos de la siguiente manera:
    Campo Descripción Predeterminada
    Porcentaje de ingresos Habilita el porcentaje de ingresos para compartir un porcentaje de los ingresos con los socios desarrolladores.
    1. Selecciona Habilitar el porcentaje de ingresos.
    2. Ingresa un porcentaje de ingresos que desees compartir en el campo Porcentaje (%) de ingresos que se compartirán con el desarrollador.

    Puedes obtener los ingresos compartidos para cada transacción monetizada mediante la configuración de la variable de monetización revShareGrossPrice en tu política de DataCapture. Para obtener más información, consulta Variables de monetización.

    Si habilitas el porcentaje de ingresos, puedes obtener una vista previa de los efectos del valor Porcentaje (%) en los cargos detallados y totales, como se describe en Vista previa del plan de tarifas. .

    Para inhabilitar la tarifa, anula la selección de Habilitar el porcentaje de ingresos.

    Inhabilitado
  9. Haga clic en Next.
  10. Haz clic en una de las siguientes opciones:
    • Guardar y publicar para guardar y publicar el plan de tarifas. Se te solicitará una fecha de activación. A fin de obtener más información, consulta Configura la fecha de activación para tu plan de tarifas.
    • Guardar para guardar un borrador del plan de tarifas.
    • Cancelar para cancelar.

API de Apigee

Para crear un plan de tarifas, envía una solicitud POST a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/$APIPRODUCT/rateplans

Para configurar el plan de tarifas, transfiere los campos obligatorios en el cuerpo de la solicitud, como se describe en Recurso: RatePlans.

En la siguiente tabla, se resumen los campos obligatorios para crear un borrador y un plan de tarifas publicados.

Campos obligatorios para el plan de tarifas de borrador Campos obligatorios para el plan de tarifas publicado
  • apiproduct
  • displayName
  • state
  • apiproduct
  • billingPeriod
  • currencyCode
  • displayName
  • paymentFundingModel (obligatorio solo para Apigee Hybrid 1.5)
  • startTime
  • state

Por ejemplo, la siguiente llamada a la API crea un plan de tarifas en borrador llamado myrateplan5 asociado con el producto de API HelloworldProduct:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apiproducts/HelloworldProduct/rateplans" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "apiproduct":"HelloworldProduct",
    "billingPeriod":"MONTHLY",
    "consumptionPricingType":"FIXED_PER_UNIT",
    "consumptionPricingRates":[{
       "fee":{
          "units":"3",
          "nanos":0
        }
    }],
    "currencyCode":"USD",
    "displayName":"myrateplan5",
    "revenueShareType":"FIXED",
    "revenueShareRates":[{
       "sharePercentage":"1"
    }],
    "setupFee":{
       "units":"10",
       "nanos":0
     },
	 "state":"DRAFT"
    }'

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Si deseas obtener una descripción de las variables de entorno que se usaron, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta:

{
    "name": "4403a3a5-b366-44f0-aa4d-bd54dcfd3239",
    "apiproduct": "HelloworldProduct",
    "displayName": "myrateplan5",
    "billingPeriod": "MONTHLY",
    "currencyCode": "USD",
    "setupFee": {
        "currencyCode": "USD",
        "units": "10"
    },
    "consumptionPricingType": "FIXED_PER_UNIT",
    "consumptionPricingRates": [
        {
            "fee": {
                "currencyCode": "USD",
                "units": "3"
            }
        }
    ],
    "revenueShareType": "FIXED",
    "revenueShareRates": [
        {
            "sharePercentage": 1
        }
    ],
    "state": "DRAFT"
}

Para obtener más información, consulta la API para crear planes de tarifas.

Obtén una vista previa del plan de tarifas en la IU

Según tu configuración de precios y porcentaje de ingresos, puedes obtener una vista previa de los cargos detallados y los totales facturados en la sección Vista previa del plan de tarifas de la página Plan de tarifas, como se muestra en la siguiente figura.

Ingresa valores de ejemplo; consulta los resultados en la vista previa del plan de tarifas

Actualiza el campo Consumo de unidades de API en la sección Datos del consumidor de ejemplo para cambiar las estimaciones en la vista previa. Los cargos detallados y los totales se actualizan según tu entrada.

Actualiza los siguientes campos en la sección Ejemplo de datos de consumidor:

  • Consumo de unidades de API
    Si se selecciona Cobrar tarifa por consumo en Precios.
  • Ingresos
    Si la opción Habilitar porcentaje de ingresos está seleccionada en Porcentaje de ingresos.

Configura los tiempos de activación y vencimiento de los planes de tarifas

Establece los tiempos de activación y vencimiento de un plan de tarifas a fin de indicar cuándo un plan de tarifas publicado está activo y que el producto de API asociado está disponible para que los desarrolladores lo usen en sus apps.