Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
Introducción
En un plan de tarjeta de tarifas, se le cobra al desarrollador por cada transacción. Para este tipo de plan, debes proporcionar detalles adicionales, como el modelo de carga y los precios del modelo de carga.
De manera opcional, puedes especificar un plan freemium para productos individuales (en lugar de un paquete de API). Puedes hacerlo solo 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 tarifas recurrentes, así como paquetes de API (planes de paquetes y de banda de volumen), ambos de los cuales implican momentos específicos en los que se cobran las tarifas y los planes de paquetes se restablecen a cero. En la siguiente tabla, se describe cuándo se cobran las tarifas recurrentes y se restablecen los recuentos de paquetes. Si las apps de desarrollador no pueden realizar más llamadas a la API porque alcanzaron un límite de transacciones determinado, estos son los momentos en los que los recuentos de llamadas a la API se restablecen a cero y las apps pueden volver a realizar llamadas.
| Si el plan tiene... | ...ocurre lo siguiente: |
|---|---|
|
La tarifa recurrente y el restablecimiento del plan de paquete se producen el primer día del mes (configuració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 |
|
El restablecimiento de la tarifa recurrente y el plan de paquetes se produce cada 7 días después de la fecha de inicio del plan de tarifas del desarrollador. |
|
El restablecimiento de la tarifa recurrente y el plan de paquetes se produce 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 hoja de tarifas. Por ejemplo, si un desarrollador inicia un plan de tarifas el día 19 del mes y el período de agregación es de 1 mes, el uso del paquete se restablece todos los meses el día 19. Ten en cuenta que el día del mes puede no ser siempre el mismo. Por ejemplo, si un plan de tarifas comienza el 31 de diciembre, la fecha de restablecimiento se convierte en el 28 de febrero de un año no bisiesto, ya que solo hay 28 días en febrero. El 28 será el día de restablecimiento para siempre. |
Cómo configurar planes de hojas de tarifas con la IU
Configura los planes de tarifas como se describe a continuación.
Edge
Para configurar un plan 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 carga:
| Modelo de carga | Descripción |
| Tarifa plana | Al desarrollador se le cobra una tarifa fija por cada transacción. |
| Volumen con banda | Se cobra una tarifa variable al desarrollador en función del volumen de transacciones. |
| Paquetes | Se le cobra al desarrollador 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.
Nota: Esta opción no está disponible cuando seleccionas Tarifa y Porcentaje de 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 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). |
| 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 decimales que se pueden especificar para la tarifa que se cobra con la API (no con la IU). Para obtener más información, consulta Configura la cantidad de 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á USD 0.10 al desarrollador 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á USD 0.10 por transmitir la cantidad especificada de bytes). |
| Volumen seleccionado | 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 carga con bandas de volumen Se puede asignar una tarifa a cada banda de volumen. La tarifa se aplica a todas las transacciones de la banda de volumen aplicable. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior está predeterminado en más de 0).
Haz clic en +Nuevo para agregar más correas. Deja el límite superior de la banda final en blanco para indicar todas las transacciones por encima de este nivel. Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa cobrada con la API (no con la IU). Para obtener más información, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas. Por ejemplo, si especificas dos bandas de volumen en la sección Banda de volumen (>0-1000 y 1000 y superiores), puedes ingresar 0.15 para la banda de volumen >0-1000 y 0.10 para la banda de volumen 1000 y superiores. Si la moneda seleccionada es dólares estadounidenses, la tarifa para las primeras 1,000 transacciones es de USD 0.15 por cada transacción y, para más de 1,000 transacciones, la tarifa es de USD 0.10 por cada transacción. |
| Paquetes | Precios de los paquetes de API | 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). Se puede asignar un precio a cada paquete. 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 se establece de forma predeterminada en un valor superior a 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 decimales que se pueden especificar para la tarifa que se cobra con la API (no con la IU). Para obtener más información, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas. Por ejemplo, si especifica dos paquetes en la sección Tamaño del paquete (superior a 0 a 1,000 y superior a 1,000 a 2,000), puede ingresar 50 para el paquete superior a 0 hasta 1,000 y 40 para el paquete superior a 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 es 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). |
Si definiste atributos personalizados para tu producto de API, puedes configurar un parámetro de calificación personalizado para cobrarle al desarrollador de la app 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 calificación personalizado y elige el atributo personalizado de la lista desplegable. Para obtener más información, consulta Configura un plan de tarifas con atributos personalizados.
Edge clásico (nube privada)
Para configurar planes de tarjetas de tarifas con la IU de Classic Edge, haz lo siguiente:
- Sigue los pasos para crear un plan de tarifas.
- Selecciona Tarifario en el menú desplegable Tipo de plan de precios 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 de todos los productos de API.
- Haz clic en Tarjeta de tarifas para ver el plan de tarifas genérico o cada plan de tarifas específico del producto de la 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 de la tarifa.
- Configura un plan freemium para un producto de API. Un plan freemium les ofrece a los desarrolladores el uso gratuito de un producto de API durante un período o en función de la cantidad de uso.
Ingresa la siguiente información:
Campo Descripción ¿Producto freemium? La extensión del período gratuito. Elige 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 tarifa se basa en un intervalo de tiempo especificado en el campo Duración de la versión freemium.
- 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 El volumen de transacciones (o el volumen correspondiente a un atributo personalizado registrado en la política de registro de transacciones) por el que no se les cobra a los desarrolladores. El volumen se mide para el producto de API. Ingresa un número de volumen, como 5,000. Esto significa que, cuando los desarrolladores inician 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 se habilita solo si seleccionas "By Quantity" (Por cantidad) o "Cuál sea el primero" en el campo "Freemium Product?".
Duración de la prueba 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 "¿Cuál es el primero?" en el campo "Producto freemium".
- Selecciona uno de los siguientes modelos de carga:
- Tarifa plana. En este modelo, se le cobra al desarrollador una tarifa fija por cada transacción.
- Banda de volumen. En este modelo, se le cobra al desarrollador una tarifa variable según el volumen de transacciones.
- Paquetes En este modelo, 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 el paquete se use por completo o no.
Para el modelo de tarifa plana: Ingresa la siguiente información en la sección de precios de la ventana de la tarjeta de tarifas genéricas:
Campo Descripción Operador (o organización) El nombre de tu organización. Este campo se establece de antemano 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 establece de forma predeterminada 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 decimales que se pueden especificar para la tarifa cargada con la API (no con la IU). Para obtener más información, consulta Configura la cantidad de decimales para las tarifas del plan de tarifas.
Por ejemplo, si ingresas 0.10 y la moneda es dólares estadounidenses, se le cobran 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 cobran USD 0.10 por transmitir la cantidad especificada de bytes).
En el caso del modelo de bandas de volumen: La ventana de la hoja de tarifas genérica muestra campos adicionales que usas para especificar una base de agregación y para especificar "bandas de volumen", es decir, rangos de volumen de transacciones para los que puedes aplicar tarifas diferentes.
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 bandas de volumen más altas.
Ingresa la siguiente información en la ventana Generic Rate Card:
Campo Descripción Base de agregación Es el período durante el cual se agrega el volumen de transacciones (o el volumen personalizado relacionado con atributos). El volumen agregado se usa para identificar la banda de volumen y la tarifa que se aplica a cada transacción. Selecciona una cantidad de meses (de 1 a 12 meses).
Para obtener más información 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"). Se puede asignar una tarifa a cada banda de volumen (estableces esta tarifa en el campo Bandas de volumen de la sección Precios). La tarifa se aplica a todas las transacciones en la banda de volumen correspondiente. Especifica el límite superior de la primera banda, por ejemplo, hasta 1,000 (el límite inferior se establece previamente en un valor superior a 0). Haz clic en + para agregar una segunda banda, por ejemplo, mayor que 1,000 y hasta 2,000. Haz clic en + para agregar más bandas. Puedes dejar el límite superior de la banda final vacío para indicar todas las transacciones por encima de este nivel.
Precios Operador (organización) El nombre de tu organización. Este campo se establece de antemano con el valor del campo Operador (o Organización) en el perfil de la organización.
País El país en el que opera tu organización. Este campo se establece de forma predeterminada con el valor del campo País en el perfil de la organización.
Moneda La moneda "base" o de contabilidad que usa tu organización. Este campo se predetermina 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 una banda de volumen. Especifica 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 decimales que se pueden especificar para la tasa de banda de volumen con la API (no con la IU). Para obtener más información, consulta Configura la cantidad de decimales para las tarifas de los planes de tarifas.
Por ejemplo, si especificas dos bandas de volumen en la sección Bandas de volumen (>0-1,000, y 1,000 y más), puedes ingresar 0.15 para la banda de volumen >0-1000 y 0.10 para la de 1000 y superiores. Si la moneda seleccionada es dólares estadounidenses, la tarifa para las primeras 1,000 transacciones es de USD 0.15 por cada transacción y, para más de 1,000 transacciones, la tarifa es de USD 0.10 por cada transacción.
Para el modelo de paquetes: La ventana de la tarjeta de tarifas genéricas 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 de la hoja de tarifas genérica:
Campo Descripción Base de agregación Es el período en el que el desarrollador puede usar el paquete de transacciones (o usar un paquete basado en atributos personalizados). 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 más información 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). Se puede asignar un precio a cada paquete (estableces este precio 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 se establece previamente en un valor superior a 0). Haz clic en + para agregar un segundo paquete, por ejemplo, desde más de 1,000 hasta 2,000. Haz clic en + para agregar más paquetes. Debes especificar un límite superior para el último paquete, a menos que desees cobrarle al desarrollador un importe fijo por transacciones ilimitadas en el último paquete.
Precios Operador (organización) El nombre de tu organización. Este campo se establece de antemano con el valor del campo Operador (o Organización) en el perfil de la organización.
País El país en el que opera tu organización. Este campo se establece de forma predeterminada con el valor del campo País en el perfil de la organización.
Moneda La moneda "base" o de contabilidad que usa tu organización. Este campo se predetermina 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. Especifica un precio para cada paquete. Ingresa un número decimal (con hasta cuatro decimales).
Nota: Puedes configurar la cantidad de decimales que se pueden especificar para la tarifa del paquete con la API (no con la IU). Para obtener más información, consulta Configura la cantidad de 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 es 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 en el paquete).
- Haz clic en Apply and Close para guardar los detalles de la hoja de tarifas y volver a la ventana del plan de tarifas estándar.
- Para los planes de tarifas específicos de productos de API, configura los detalles del plan de tarifas para 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 hoja de tarifas con la API, como se describe en las siguientes secciones.
Especifica los detalles del plan de la hoja de tarifas con la API
Cuando creas el plan de tarifas, debes especificar los detalles. Especificas 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 carga que elijas: tarifa plana, volumen con bandas o paquetes.
Cómo especificar un modelo de cobro de tarifa plana
Para implementar el modelo de carga de tarifa plana, especifica lo siguiente en los detalles del plan de tarifas:
- Es un parámetro de calificació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 volumen o en paquetes). - Es el período en el que vence el pago (por ejemplo, 30 días).
- El ID de tu organización.
- Es la moneda "base" o contable que usa tu empresa.
- Es una tarifa del plan de tarifas que proporciona detalles sobre cómo se calcula la tarifa. Debido a que el modelo de facturación se basa en una tarifa fija, solo debes especificar una tarifa del plan de tarifas.
En la tarifa del plan de tarifas, especifica lo siguiente:
- Es el tipo de tarifa del plan de tarifas (
RATECARD). - La tarifa del plan. Por ejemplo, si especificas 0.10, y la moneda es el dólar estadounidense, se le cobrarán USD 0.10 al desarrollador 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 de bytes especificada).
- Es la unidad inicial de la aplicación de tarifas (
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, lo siguiente crea un plan de hoja de tarifas con un modelo de cobro fijo. La tarifa se establece en USD 0.10 por cada 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
Especifica un modelo de carga con bandas de volumen
En un modelo con bandas de volumen, especificas los detalles del plan de tarifas que incluyen una o más tarifas del plan de tarifas. Cada tarifa 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 bandas de volumen más altas.
Además de las tarifas del plan de tarifas, debes especificar lo siguiente en los detalles del plan de tarifas:
- Es un parámetro de calificació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. - 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 es el caso del modelo de facturación de tarifa plana). - Es el período en el que vence el pago (por ejemplo, 30 días).
- El ID de tu organización.
- Es la moneda "base" o contable que usa tu empresa.
- 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 en función del período de agregación (por ejemplo, 1 mes) para determinar la banda de volumen aplicable.
- Contadores de agregación que se usan para determinar la banda de volumen aplicable.
Para cada tarifa del plan de tarifas, especifica 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, al desarrollador se le cobra 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 cobra USD 0.15 por transmitir la cantidad especificada de bytes).
- La unidad de inicio y finalización de la banda de volumen. La unidad de inicio especifica el límite inferior de la banda de volumen, y la unidad de finalización especifica el límite superior de la banda de volumen. Por ejemplo, si especificas una unidad inicial de 0 y una 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 por hasta 1,000 transacciones en el mes.
Para conocer más detalles sobre cuándo se restablecen los paquetes, consulta ¿Cuándo se cobran 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 aplica 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 aplica 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 con bandas de volumen. La tasa 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. (Los detalles de la hoja de tarifas están destacados).
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
Especifica un modelo de carga en paquete
En un modelo de cobro en paquetes, el desarrollador paga (por adelantado) por un "paquete" de transacciones (o por un paquete basado en un atributo personalizado, como la cantidad de bytes transmitidos). Especificas una tarifa para cada paquete y una base de agregación, es decir, un período durante el cual el desarrollador puede usar el paquete.
Por ejemplo, supongamos que configuraste dos paquetes, en los que el primer tamaño es de 1 a 1,000 transacciones y el segundo 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 hoja 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 el paquete se use por completo o no. El plan vence cuando finaliza el período de agregación. Si el desarrollador quiere volver a usar el paquete, debe volver a comprar el plan (y el paquete).
Lo que especificas en los detalles del plan de tarifas es, en esencia, lo mismo que especificas en los detalles del plan de tarifas para el modelo de carga con bandas de volumen. Las diferencias se muestran a continuación:
- Cada plan de tarifas que especifiques es para un paquete (en lugar de una banda 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 carga agrupado. La tarifa es de USD 50 para el primer paquete (hasta 1,000 transacciones) y de USD 40 para el segundo (más de 1,000 y hasta 2,000 transacciones). La base de agregación es de 1 mes. El pago vencerá 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
Especifica un plan freemium para productos individuales con la API
En un plan de hoja de tarifas, puedes configurar un plan freemium para un producto individual (en lugar de un paquete de API). Un plan freemium les ofrece a los desarrolladores el uso gratuito de un producto de API durante un período o en función de la cantidad de uso.
Cuando configuras un plan freemium para un producto de API, especificas en los detalles del plan de la hoja de tarifas el período en el que el desarrollador puede usar los recursos proporcionados por el producto de API sin costo. El período puede basarse en una de las siguientes opciones:
- Es la duración, es decir, el tiempo entre una fecha de entrada en vigencia y una de finalización.
- Cantidad, como la cantidad de transacciones relacionadas con el producto de API o el volumen relacionado con un atributo personalizado registrado en la política de registro de transacciones
Si el período de prueba premium se basa en la cantidad, especifícalo como una cantidad de unidades de prueba premium. Por ejemplo, el siguiente comando 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 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