Estás viendo la documentación de Apigee Edge.
Ir a la documentación de
Apigee X. info
Introducción
En un plan de tarjeta de tarifas, se cobra al desarrollador por cada transacción. Para este tipo de plan, debes proporcionar detalles adicionales, como el modelo de cobro y el precio del modelo de cobro.
De manera opcional, puedes especificar un plan freemium para productos individuales (en lugar de para un paquete de API). Esto solo se puede hacer para un plan específico del producto.
¿Cuándo se cobran las tarifas recurrentes y se restablecen los planes de paquetes?
Los planes de tarifas pueden incluir cargos recurrentes y paquetes de APIs (planes de bandas de volumen y de paquetes), los cuales implican momentos específicos en los que se cobran los cargos y los planes de paquetes se restablecen a cero. En la siguiente tabla, se describe cuándo se cobran las tarifas recurrentes y cuándo se restablecen los recuentos de paquetes. Si las apps para desarrolladores no pueden realizar más llamadas a la API porque alcanzaron un límite de transacciones determinado, estos son los momentos en los que se restablecen a cero los recuentos de llamadas a la API y las apps pueden comenzar a realizar llamadas nuevamente.
| Si el plan tiene las siguientes características, | …esto sucede |
|---|---|
|
El restablecimiento de la tarifa recurrente y el plan de paquete se producen el primer día del mes (opción predeterminada). Para una recurrencia mensual en un día específico, crea un plan de tarifas con la API de administración y, luego, indica el día con una propiedad |
|
La tarifa recurrente y el restablecimiento del plan de paquete se producen cada 7 días después de la fecha de inicio del plan de tarifas del desarrollador. |
|
La tarifa recurrente y el restablecimiento del plan de paquete se producen cada X días después de la fecha de inicio del plan de tarifas del desarrollador. |
|
Los planes de paquetes se restablecen según la base de agregación definida en la tarjeta de tarifas. Por ejemplo, si un desarrollador inicia un plan de tarifas el día 19 del mes y la base de agregación es cada 1 mes, el uso del paquete se restablece todos los meses el día 19. Ten en cuenta que el día del mes no siempre será el mismo. Por ejemplo, si un plan de tarifas comienza el 31 de diciembre, la fecha de restablecimiento será el 28 de febrero en un año no bisiesto, ya que febrero solo tiene 28 días. El día 28 seguirá siendo el día de restablecimiento a partir de entonces. |
Configura planes de tarjetas de tarifas con la IU
Configura los planes de la tarjeta de tarifas, como se describe a continuación.
Edge
Para configurar un plan de tarjeta de tarifas, cuando crees o edites un plan de tarifas, selecciona el tipo de plan de tarifas Tarjeta de tarifas o Tarjeta de tarifas y reparto de ingresos y, en la sección Tarjeta de tarifas, selecciona uno de los siguientes modelos de cobro:
| Modelo de carga | Descripción |
| Tarifa plana | Se cobra al desarrollador una tarifa fija por cada transacción. |
| Con banda de volumen | Al desarrollador se le cobra una tarifa variable según el volumen de transacciones. |
| Paquetes | Al desarrollador se le cobra un importe fijo por adelantado por cada paquete de transacciones. Se le cobra al desarrollador el importe establecido, independientemente de que se use el paquete por completo o no.
Nota: Esta opción no está disponible cuando seleccionas Tarifa y participación en los ingresos. |
Luego, configura la siguiente información según el modelo de carga seleccionado.
| Modelo de carga | Campo | Descripción |
| Todos | Frecuencia de cálculo | Es el 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). |
| Tarifa plana | Tarifa plana | Es la tarifa que se cobra por cada transacción. Ingresa un número decimal (con hasta cuatro decimales).
Nota: Puedes configurar la cantidad de posiciones decimales que se pueden especificar para la tarifa cobrada con la API (no la IU). Para obtener más información, consulta Cómo configurar la cantidad de posiciones decimales para las tarifas de los planes de tarifas. Por ejemplo, si ingresas 0.10 y la moneda es dólares estadounidenses, se le cobrará al desarrollador USD 0.10 por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se le cobrará al desarrollador USD 0.10 por transmitir la cantidad especificada de bytes). |
| Con banda de volumen | Bandas de volumen | Uno o más rangos de volumen de transacciones (o basados en atributos del cliente) (cada rango es una "banda de volumen") para el modelo de precios por banda de volumen. A cada banda de volumen se le puede asignar una tarifa. La tarifa se aplica a todas las transacciones del rango de volumen aplicable. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior está preestablecido en mayor que 0).
Haz clic en + Nuevo para agregar bandas adicionales. Deja vacío el límite superior del tramo final para indicar todas las transacciones que superen este nivel. Nota: Puedes configurar la cantidad de posiciones decimales que se pueden especificar para la tarifa cobrada con la API (no la IU). Para obtener más información, consulta Cómo configurar la cantidad de posiciones decimales para las tarifas de los planes de tarifas. Por ejemplo, si especificas dos bandas de volumen en la sección Banda de volumen (de 0 a 1,000 y de 1,000 en adelante), puedes ingresar 0.15 para la banda de volumen de 0 a 1,000 y 0.10 para la banda de volumen de 1,000 en adelante. Si la moneda seleccionada es dólares estadounidenses, la tarifa para las primeras 1,000 transacciones es de USD 0.15 por transacción y, para más de 1,000 transacciones, la tarifa es de USD 0.10 por transacción. |
| Paquetes | Precios de los paquetes de API | Cantidad de transacciones en un paquete (o un número relacionado con un atributo personalizado, como la cantidad total de bytes transmitidos en un paquete). A cada paquete se le puede asignar un precio. El precio se aplica a todo el paquete. Especifica el límite superior del primer paquete, por ejemplo, hasta 1,000 (el límite inferior está preestablecido en más de 0).
Haz clic en + Nuevo para agregar paquetes adicionales. Debes especificar un límite superior para el último paquete, a menos que quieras cobrarle al desarrollador un importe fijo por transacciones ilimitadas en el último paquete. Nota: Puedes configurar la cantidad de posiciones decimales que se pueden especificar para la tarifa cobrada con la API (no la IU). Para obtener más información, consulta Cómo configurar la cantidad de posiciones decimales para las tarifas de los planes de tarifas. Por ejemplo, si especificas dos paquetes en la sección Tamaño del paquete (mayor que 0 hasta 1,000 y mayor que 1,000 hasta 2,000), puedes ingresar 50 para el paquete mayor que 0 hasta 1,000 y 40 para el paquete mayor que 1,000 hasta 2,000. Si la moneda seleccionada es el dólar estadounidense, el precio del primer paquete es de USD 50 y el del segundo, de USD 40. Al desarrollador se le cobra el precio del paquete aplicable, independientemente de la cantidad de transacciones que use dentro del paquete (es decir, se le cobra el precio del paquete en cuanto se completa la primera transacción del paquete). |
Si definiste atributos personalizados para tu producto de API, puedes configurar un parámetro de calificación personalizado para cobrarle al desarrollador de apps en función de un atributo personalizado dentro de cada transacción. Por ejemplo, si configuras un plan en el que le cobras al desarrollador por cada transacción, puedes establecer la tarifa del plan en función de un atributo personalizado, como la cantidad de bytes transmitidos en el backend, que puede variar por transacción.
En este caso, selecciona Usar parámetro de clasificación personalizado y elige el atributo personalizado en la lista desplegable. Para obtener más información, consulta Cómo configurar un plan de tarifas con atributos personalizados.
Classic Edge (nube privada)
Para configurar planes de tarjetas de tarifas con la IU clásica de Edge, haz lo siguiente:
- Sigue los pasos para crear un plan de tarifas.
- Selecciona Tarifa en el menú desplegable Tipo de plan de tarifas para configurar el modelo de ingresos.
- Si el paquete de API seleccionado incluye varios productos de API, selecciona una de las siguientes opciones:
Nota: Si el paquete de la API incluye un solo producto de API, puedes omitir este paso.
- Planes específicos del producto para configurar los detalles del plan de tarifas de cada producto de API de forma individual
- Plan genérico para todos los productos para configurar los detalles del plan de tarifas para todos los productos de API
- Haz clic en Tarifas para el plan de tarifas genérico o para cada plan de tarifas específico del producto de API.
Nota: Cuando configures planes específicos para productos de API, deberás configurar un plan de tarjeta de tarifas para cada producto de API de forma individual.
Se abrirá la ventana Tarifa.
- Configura un plan freemium para un producto de API. Un plan freemium ofrece a los desarrolladores el uso gratuito de un producto de API durante un período o según la cantidad de uso.
Ingresa la siguiente información:
Campo Descripción ¿Producto freemium? Es la extensión del período gratuito. Selecciona uno de los siguientes botones de selección:
- Por cantidad El período gratuito se basa en una cantidad especificada en el campo Volumen.
- Por duración El período de la comisión se basa en un intervalo de tiempo especificado en el campo Freemium Duration.
- Lo que ocurra primero. El período gratuito finaliza cuando se alcanza la cantidad en el campo Volumen o el intervalo de tiempo en el campo Duración de Freemium, lo que ocurra primero.
- No, este no es un plan freemium. Esta es la opción predeterminada.
Volumen de Freemium Es la cantidad de transacciones (o la cantidad relacionada con un atributo personalizado registrado en la política de registro de transacciones) por las que no se les cobra a los desarrolladores. El volumen se mide para el producto de API. Ingresa un número de volumen, como 5000. Esto significa que, cuando los desarrolladores comienzan a usar el plan, no se les cobra por las primeras 5,000 transacciones (o por los primeros 5,000 usos de un elemento relacionado con un atributo personalizado). Este campo solo se habilita si seleccionas "Por cantidad" o "Lo que ocurra primero" en el campo "¿Producto freemium?".
Duración del Freemium Es el intervalo de tiempo durante el cual no se les cobra a los desarrolladores. Ingresa un número y selecciona un período, por ejemplo, 1 mes. Esto significa que no se les cobra a los desarrolladores durante 1 mes. Este campo solo se habilita si seleccionas "Por duración" o "Lo que ocurra primero" en el campo "¿Producto freemium?".
- Selecciona uno de los siguientes modelos de carga:
- Tarifa plana. En este modelo, se cobra al desarrollador una tarifa fija por cada transacción.
- Volumen agrupado. En este modelo, al desarrollador se le cobra una tarifa variable según el volumen de transacciones.
- Paquetes En este modelo, al desarrollador se le cobra una cantidad fija (por adelantado) por cada paquete de transacciones. Se le cobra al desarrollador el importe establecido, independientemente de que el paquete se use por completo o no.
Para el modelo de tarifa plana: Ingresa la siguiente información en la sección Precios de la ventana Tarjeta de tarifas genérica:
Campo Descripción Operador (u organización) El nombre de tu organización. Este campo se preestablece con el valor del campo Operador (o Organización) en el perfil de la organización.
País Es el país en el que opera tu organización. Este campo se preestablece con el valor del campo País en el perfil de la organización.
Tarifa plana Es la tarifa que se cobra por cada transacción. Ingresa un número decimal (con hasta cuatro decimales).
Nota: Puedes configurar la cantidad de posiciones decimales que se pueden especificar para la tarifa cobrada con la API (no la IU). Para obtener más información, consulta Cómo configurar la cantidad de posiciones decimales para las tarifas de los planes de tarifas.
Por ejemplo, si ingresas 0.10 y la moneda es dólares estadounidenses, se le cobrará al desarrollador USD 0.10 por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se le cobrará al desarrollador USD 0.10 por transmitir la cantidad especificada de bytes).
Para el modelo de bandas de volumen: En la ventana Generic Rate Card, se muestran campos adicionales que puedes usar para especificar una base de agregación y especificar "bandas de volumen", es decir, rangos de volumen de transacciones para los que puedes aplicar diferentes tarifas.
Por lo general, este tipo de plan se configura para alentar a los desarrolladores a generar volúmenes más altos, ya que ofrece tarifas con descuento para los rangos de volumen más altos.
Ingresa la siguiente información en la ventana Tarifa genérica:
Campo Descripción Base de agregación Es el período durante el cual se agrega el volumen de transacciones (o el volumen relacionado con el atributo personalizado). El volumen agregado se usa para identificar la banda de volumen y la tarifa que se aplicará a cada transacción. Selecciona una cantidad de meses (de 1 a 12 meses).
Para obtener detalles sobre cuándo se restablecen los paquetes, consulta ¿Cuándo se cobran las tarifas recurrentes y se restablecen los planes de paquetes?
Bandas de volumen Uno o más rangos de volumen de transacciones (o basados en atributos del cliente; cada rango es una "banda de volumen"). A cada banda de volumen se le puede asignar una tarifa (esta tarifa se establece en el campo Bandas de volumen de la sección Precios). La tarifa se aplica a todas las transacciones del rango de volumen aplicable. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior está preestablecido en más de 0). Haz clic en + para agregar un segundo intervalo, por ejemplo, de más de 1,000 hasta 2,000. Haz clic en + para agregar más bandas. Puedes dejar vacío el límite superior de la banda final para indicar todas las transacciones por encima de este nivel.
Precios Operador (u organización) El nombre de tu organización. Este campo se preestablece con el valor del campo Operador (o Organización) en el Perfil de la organización.
País Es el país en el que opera tu organización. Este campo se preestablece con el valor del campo País en el perfil de la organización.
Moneda Es la moneda "base" o contable que usa tu organización. Este campo se preestablece con el valor del campo Moneda en el perfil de la organización, pero se puede cambiar aquí.
Bandas de volumen Es la tarifa de un rango de volumen. Especificas una tarifa para cada banda de volumen. Ingresa un número decimal para cada banda (con hasta cuatro decimales).
Nota: Puedes configurar la cantidad de posiciones decimales que se pueden especificar para la tarifa de la banda de volumen con la API (no con la IU). Para obtener más información, consulta Cómo configurar la cantidad de posiciones decimales para las tarifas de los planes de tarifas.
Por ejemplo, si especificas dos bandas de volumen en la sección Banda de volumen (de 0 a 1,000 y de 1,000 en adelante), puedes ingresar 0.15 para la banda de volumen de 0 a 1,000 y 0.10 para la banda de volumen de 1,000 en adelante. Si la moneda seleccionada son dólares estadounidenses, la tarifa para las primeras 1,000 transacciones es de USD 0.15 por transacción y, para más de 1,000 transacciones, la tarifa es de USD 0.10 por transacción.
Para el modelo agrupado: La ventana de la tarjeta de tarifas genérica muestra campos adicionales que usas para especificar una base de agregación (el período durante el cual el desarrollador puede usar el paquete de transacciones) y para especificar información relacionada con el paquete, como el tamaño de un paquete.
Ingresa la siguiente información en la ventana Tarifa genérica:
Campo Descripción Base de agregación Es el período durante el cual el desarrollador puede usar el paquete de transacciones (o usar un paquete personalizado basado en atributos). Selecciona una cantidad de meses (de 1 a 12 meses). Después de este período, el plan vence y el desarrollador debe volver a comprarlo (y los paquetes).
Para obtener detalles sobre cuándo se restablecen los paquetes, consulta ¿Cuándo se cobran las tarifas recurrentes y se restablecen los planes de paquetes?
Tamaño del paquete Es la cantidad de transacciones en un paquete (o un número relacionado con un atributo personalizado, como la cantidad total de bytes transmitidos en un paquete). A cada paquete se le puede asignar un precio (lo estableces en el campo Tamaño del paquete de la sección Precios). El precio se aplica a todo el paquete. Especifica el límite superior del primer paquete, por ejemplo, hasta 1,000 (el límite inferior está preestablecido en más de 0). Haz clic en el signo + para agregar un segundo paquete, por ejemplo, de más de 1,000 hasta 2,000. Haz clic en el signo más (+) para agregar más paquetes. Debes especificar un límite superior para el último paquete, a menos que quieras cobrarle al desarrollador un importe fijo por transacciones ilimitadas en el último paquete.
Precios Operador (u organización) El nombre de tu organización. Este campo se preestablece con el valor del campo Operador (o Organización) en el Perfil de la organización.
País Es el país en el que opera tu organización. Este campo se preestablece con el valor del campo País en el perfil de la organización.
Moneda Es la moneda "base" o contable que usa tu organización. Este campo se preestablece con el valor del campo Moneda en el perfil de la organización, pero se puede cambiar aquí.
Tamaño del paquete (precio) Es el precio de un paquete. Especificas un precio para cada paquete. Ingresa un número decimal (con hasta cuatro decimales).
Nota: Puedes configurar la cantidad de posiciones decimales que se pueden especificar para la tarifa del paquete con la API (no con la IU). Para obtener más información, consulta Cómo configurar la cantidad de posiciones decimales para las tarifas de los planes de tarifas.
Por ejemplo, si especificas dos paquetes en la sección Tamaño del paquete (mayor que 0 hasta 1,000 y mayor que 1,000 hasta 2,000), puedes ingresar 50 para el paquete mayor que 0 hasta 1,000 y 40 para el paquete mayor que 1,000 hasta 2,000. Si la moneda seleccionada es dólares estadounidenses, el precio del primer paquete es de USD 50 y el del segundo, de USD 40. Se le cobra al desarrollador el precio del paquete aplicable, independientemente de la cantidad de transacciones que use dentro del paquete (es decir, se le cobra el precio del paquete en cuanto se completa la primera transacción del paquete).
- Haz clic en Aplicar y cerrar para guardar los detalles de la tarjeta de tarifas y volver a la ventana Plan de tarifas estándar.
- En el caso de los planes de tarifas específicos de productos de API, configura los detalles del plan de tarifas para los productos de API adicionales, según sea necesario.
Cómo configurar el plan de la tarjeta de tarifas con la API
Configura los detalles del plan de la tarjeta de tarifas con la API, como se describe en las siguientes secciones.
Cómo especificar los detalles del plan de la tarjeta de tarifas con la API
Cuando creas el plan de tarifas, especificas los detalles del plan de la tarjeta de tarifas. Especifica los detalles en la propiedad ratePlanDetails dentro del cuerpo de la solicitud en una llamada a /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Lo que especifiques en la propiedad ratePlanDetails dependerá del modelo de cobro que elijas: tarifa plana, por volumen o paquetes.
Cómo especificar un modelo de precios de tarifa plana
Para implementar el modelo de cobro de tarifa plana, especifica lo siguiente en los detalles del plan de tarifas:
- Es un parámetro de clasificación que indica que el plan de tarifas se basa en transacciones (
VOLUME) o en un atributo personalizado (por ejemplo,MINT_CUSTOM_ATTRIBUTE_1).VOLUMEes el valor predeterminado. - Es un tipo de medición (
UNIT) que indica que la tarifa es fija por unidad (es decir, no se basa en el volumen de transacciones, como es el caso del modelo de cobro por paquetes o por rangos de volumen). - Es el período de vencimiento del pago (por ejemplo, 30 días).
- Es el ID de tu organización.
- Es la moneda "base" o contable que usa tu empresa.
- Es la tarifa de un plan de tarifas que proporciona detalles sobre cómo se calcula la tarifa. Dado que el modelo de cobro se basa en una tarifa fija, solo debes especificar una tarifa del plan de tarifas.
En la tarifa del plan de tarifas, debes especificar lo siguiente:
- Es el tipo de tarifa del plan de tarifas (
RATECARD). - Es la tarifa del plan. Por ejemplo, si especificas 0.10 y la moneda es dólares estadounidenses, se le cobrará al desarrollador USD 0.10 por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se le cobrará al desarrollador USD 0.10 por transmitir la cantidad especificada de bytes).
- Es la unidad inicial de la aplicación de la tarifa (
0). Esto significa que la tarifa se aplica a cada transacción, comenzando por la primera.
Consulta Configuración de detalles del plan de tarifas para obtener una lista completa de las opciones de detalles del plan de tarifas.
Por ejemplo, el siguiente comando crea un plan de tarjeta de tarifas con un modelo de cobro fijo. La tarifa se establece en USD 0.10 por transacción. El pago vence en 30 días. (Los detalles relacionados con la hoja de tarifas están destacados).
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan",
"displayName" : "Flat rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "0"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
Cómo especificar un modelo de precios por bandas de volumen
En un modelo de bandas de volumen, especificas detalles del plan de tarifas que incluyen una o más tarifas del plan, cada una de las cuales se aplica a una "banda de volumen", es decir, un rango de volumen de transacciones (o un rango basado en un atributo personalizado, como la cantidad de bytes transmitidos). Por lo general, este tipo de plan se configura para alentar a los desarrolladores a generar volúmenes más altos ofreciendo tarifas con descuento para los rangos de volúmenes más altos.
Además de las tarifas del plan de tarifas, en los detalles del plan de tarifas, debes especificar lo siguiente:
- Es un parámetro de clasificación que indica que el plan de tarifas se basa en transacciones (
VOLUME) o en un atributo personalizado (por ejemplo,CUSTOM_ATTRIBUTE_1).VOLUMEes el valor predeterminado. - Es un tipo de medición (
VOLUME) que indica que la tarifa se basa en el volumen de transacciones (es decir, no es una tarifa plana por transacción, como en el caso del modelo de cobro de tarifa plana). - Es el período de vencimiento del pago (por ejemplo, 30 días).
- Es el ID de tu organización.
- Es la moneda "base" o contable que usa tu empresa.
- Es una duración y un tipo de duración que, en conjunto, especifican el período durante el cual se agrega el volumen de transacciones (o el volumen relacionado con el atributo personalizado). Esto también se denomina "base de agregación". El volumen de transacciones se agrega según la base de agregación (por ejemplo, 1 mes) para determinar el rango de volumen aplicable.
- Son los contadores de agregación que se usan para determinar la banda de volumen aplicable.
Para cada tarifa del plan de tarifas, debes especificar lo siguiente:
- Es el tipo de tarifa del plan de tarifas (
RATECARD). - Es la tarifa del plan. Por ejemplo, si especificas 0.10 y la moneda son dólares estadounidenses, se le cobrará al desarrollador USD 0.15 por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, se le cobrará al desarrollador USD 0.15 por transmitir la cantidad especificada de bytes).
- Unidad de inicio y finalización de la banda de volumen. La unidad inicial especifica el límite inferior de la banda de volumen, y la unidad final especifica el límite superior de la banda de volumen. Por ejemplo, si especificas una unidad inicial de 0 y una unidad final de 1,000, la banda de volumen abarca hasta 1,000 transacciones en el período de agregación. Si la moneda es dólares estadounidenses, el período de agregación es de 1 mes y la tarifa para las primeras 1,000 transacciones es de 0.15, se le cobrará al desarrollador USD 0.15 por transacción hasta un máximo de 1,000 transacciones en el mes.
Para obtener detalles sobre cuándo se restablecen los paquetes, consulta ¿Cuándo se cobran las tarifas recurrentes y se restablecen los planes de paquetes?
Si no especificas una unidad final para la banda de volumen final, la tarifa de esa banda se aplicará a todas las transacciones después de que la cantidad de transacciones supere la unidad inicial de esa banda. Por ejemplo, si la unidad inicial de la última banda es 1,000 y no especificas una unidad final para esa banda, la tarifa de la banda se aplicará a todas las transacciones después de 1,000 transacciones en el período de agregación.
Consulta Configuración de detalles del plan de tarifas para obtener una lista completa de las opciones de detalles del plan de tarifas.
Por ejemplo, el siguiente comando crea un plan de tarjeta de tarifas con un modelo de carga por bandas de volumen. La tarifa se establece en USD 0.15 para las primeras 1,000 transacciones y en USD 0.10 para todas las transacciones superiores a 1,000. La base de agregación es de 1 mes. El pago vence en 30 días. (Se destacan los detalles de la hoja de tarifas).
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Volume banded rate card plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Volume banded rate card plan",
"displayName" : "Volume banded rate card plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.15",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "1000"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
Cómo especificar un modelo de carga en paquete
En un modelo de cobro agrupado, el desarrollador paga (por adelantado) un "paquete" de transacciones (o un paquete basado en un atributo personalizado, como la cantidad de bytes transmitidos). Especificas una tarifa para cada paquete y bases de agregación, es decir, un período durante el cual el desarrollador puede usar el paquete.
Por ejemplo, supongamos que configuras dos paquetes, en los que el tamaño del primer paquete es de 1 a 1,000 transacciones y el tamaño del segundo paquete es de 1,001 a 2,000 transacciones. La tarifa es de USD 50 para el primer paquete y de USD 40 para el segundo, y la base de agregación es 1. Si el desarrollador compra un plan de tarjeta de tarifas para el primer paquete, paga USD 50 (por adelantado) por 1,000 transacciones en un mes. Se le cobra al desarrollador el importe establecido, independientemente de que se use todo el paquete o no. Una vez que finaliza el período de agregación, vence el plan. Si el desarrollador quiere volver a usar el paquete, debe comprar el plan (y el paquete) de nuevo.
Lo que especificas en los detalles del plan de tarifas es básicamente lo mismo que especificas en los detalles del plan de tarifas para el modelo de cobro por bandas de volumen. Las diferencias se muestran a continuación:
- Cada plan de tarifas que especifiques es para un paquete (en lugar de un rango de volumen).
- Debes especificar un límite superior para el último paquete, a menos que quieras cobrarle al desarrollador un importe fijo por transacciones ilimitadas en el último paquete.
Consulta Configuración de detalles del plan de tarifas para obtener una lista completa de las opciones de detalles del plan de tarifas.
Por ejemplo, el siguiente comando crea un plan de tarjeta de tarifas con un modelo de cobro agrupado. La tarifa se establece en USD 50 para el primer paquete (hasta 1,000 transacciones) y en USD 40 para el segundo paquete (más de 1,000 y hasta 2,000 transacciones). La base de agregación es de 1 mes. El pago vence en 30 días.
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Bundled rate plan",
"developer":null,
"developerCategory":null,
"currency": {
"id" : "usd"
},
"frequencyDuration": "30",
"description": "Bundled rate plan",
"displayName" : "Bundled rate plan",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "true",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id" : "usd"
},
"aggregateStandardCounters": true,
"paymentDueDays": "30",
"duration": "1",
"durationType": "MONTH",
"meteringType": "STAIR_STEP",
"organization": {
"id": "{org_name}"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "50",
"startUnit": "0",
"endUnit": "1000"
},
{
"type": "RATECARD",
"rate": "40",
"startUnit": "1000",
"endUnit": "2000"
}
],
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password
Cómo especificar un plan freemium para productos individuales con la API
En un plan de tarjeta de tarifas, puedes configurar un plan freemium para un producto individual (en lugar de para un paquete de APIs). Un plan freemium ofrece a los desarrolladores el uso gratuito de un producto de API durante un período o según la cantidad de uso.
Cuando configuras un plan freemium para un producto de API, especificas en los detalles del plan de la tarjeta de tarifas el período en el que el desarrollador puede usar los recursos que proporciona el producto de API sin cargo. El período puede basarse en uno de los siguientes elementos:
- Duración, es decir, el tiempo entre una fecha de entrada en vigencia y una fecha de finalización
- Cantidad, como la cantidad de transacciones que involucran el producto de API o el volumen correspondiente a un atributo personalizado registrado en la política de registro de transacciones.
Si el período freemium se basa en la cantidad, especifícalo como una cantidad de unidades freemium. Por ejemplo, el siguiente código crea un plan de tarjeta de tarifas con un plan freemium basado en un volumen de 5,000 unidades (se destacan las especificaciones relacionadas con el plan freemium).
curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flat rate card plan with freemium period",
"developer":null,
"developerCategory":null,
"advance": "false",
"currency": {
"id" : "usd"
},
"description": "Flat rate card plan with freemium period",
"displayName" : "Flat rate card plan with freemium period",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "myorg"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "false",
"ratePlanDetails": [
{
"currency": {
"aggregateFreemiumCounters" : true,
"aggregateStandardCounters" : true,
"id" : "usd"
},
"product" : {
"id" : "location",
"displayName":"Location"
},
"paymentDueDays": "30",
"meteringType": "UNIT",
"organization": {
"id": "myorg"
},
"ratePlanRates": [
{
"type": "RATECARD",
"rate": "0.10",
"startUnit": "0"
}
],
"freemiumUnit": "5000",
"freemiumDuration": "0",
"freemiumDurationType": "DAY",
"ratingParameterUnit":"MB",
"customPaymentTerm": "false",
"ratingParameter": "VOLUME",
"type": "RATECARD"
}],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"recurringFee": "10",
"setUpFee": "10",
"startDate": "2013-09-15 00:00:00",
"type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password