Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
Introducción
En un plan de reparto de ingresos, el proveedor de la API comparte con el desarrollador un porcentaje de los ingresos generados a partir de cada transacción (según el precio bruto o neto de una transacción). Cuando creas un plan de reparto de ingresos, debes indicar un modelo de uso compartido, que puede ser fijo o flexible, y una base de precios (por ejemplo, si el reparto de ingresos se basa en el precio bruto o neto de una transacción). Cuando creas la política de registro de transacciones, estableces el precio bruto o neto de la transacción.
En el modelo de reparto fijo, compartes con el desarrollador un porcentaje fijo de los ingresos generados a partir de cada transacción (según el precio bruto o neto de una transacción). En el modelo de reparto flexible, compartes con el desarrollador un porcentaje variable de los ingresos. El porcentaje de ingresos depende de los ingresos generados durante un período. El porcentaje que se usa en el cálculo del porcentaje de ingresos puede variar según el importe de los ingresos que generan las transacciones.
Especifica los detalles del plan de porcentaje de ingresos con la IU
Configura los planes de porcentaje de ingresos, como se describe a continuación.
Edge
Para configurar un plan de porcentaje de ingresos con la IU de Edge, cuando crees o edites un plan de tarifas, selecciona el tipo de plan de tarifas Porcentaje de ingresos o Hoja de tarifas y reparto de ingresos y, en la sección Porcentaje de ingresos, configura la siguiente información:
| Campo | Descripción |
| Modelo de cálculo | Selecciona uno de los siguientes tipos de precios:
|
| Frecuencia de cálculo | Es el período durante el cual se calcula el volumen de transacciones (o el volumen relacionado con los atributos personalizados). Selecciona una cantidad de meses (entre 1 y 24 meses). |
| Modelo de uso compartido | Selecciona uno de los siguientes modelos de participación de ingresos:
|
| Porcentaje de ingresos fijo | Para el modelo de uso compartido fijo, especifica el porcentaje que se usa para calcular el reparto de ingresos. Ingresa un número decimal (con hasta cuatro decimales). Por ejemplo, si ingresas 80.5555, el porcentaje de ingresos es del 80.5555%, es decir, como proveedor de la API, le pagas al desarrollador el 80.5555% del precio cobrado por cada transacción. |
| Bandas de porcentaje de ingresos | Para el modelo de reparto flexible, uno o más rangos de ingresos por transacciones (cada rango es una "banda de ingresos"). A cada banda de ingresos se le puede asignar un porcentaje de porcentaje de ingresos. Las transacciones se agregan sobre la base de agregación para calcular los ingresos totales y la banda de ingresos de la transacción. El porcentaje de porcentaje de ingresos que se aplica a cada transacción depende de su banda de ingresos. 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 vacío el límite superior de la banda final para indicar todas las transacciones una vez que los ingresos agregados hayan superado este nivel. Por ejemplo, si especificas dos tramos de ingresos en la sección Rango de ingresos (>0-1,000 y 1,000 y más), puedes ingresar 80.5555 para el tramo de ingresos >0-1,000 y 90.5 para el tramo de ingresos de 1,000 y más. Supongamos también que la moneda es dólares estadounidenses. Luego, para las transacciones que generan hasta USD 1,000 en ingresos, el porcentaje de ingresos es del 80.5555% del precio de la transacción y, para las transacciones que generan más de USD 1,000 en ingresos, el porcentaje de ingresos es del 90.5% del precio de la transacción. |
Edge clásico (nube privada)
Para configurar planes de reparto de ingresos con la IU de Edge clásica, haz lo siguiente:
- Sigue los pasos para crear un plan de tarifas.
- Selecciona Reparto de ingresos 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 de todos los productos de API.
- Haz clic en Reparto de ingresos para ver el plan de tarifas genérico o cada plan de tarifas específico de un producto de API.
Nota: Cuando configures planes específicos para productos de API, deberás configurar un plan de participación de ingresos para cada producto de API de forma individual.
Se abrirá la ventana Repartición de ingresos.
- Selecciona uno de los siguientes modelos de uso compartido:
- Fijo: En este modelo, el proveedor de la API comparte con el desarrollador un porcentaje fijo de los ingresos generados a partir de cada transacción (según el precio bruto o neto de una transacción).
- Flexible: En este modelo, el proveedor de la API comparte con el desarrollador un porcentaje variable de los ingresos. El porcentaje de ingresos depende de los ingresos generados durante un período. El porcentaje que se usa en el cálculo del porcentaje de ingresos puede variar según el importe de los ingresos que generan las transacciones.
Para el modelo de uso compartido fijo:
Si seleccionas el modelo de reparto fijo, ingresa la siguiente información en la sección de precios de la ventana de reparto de ingresos genéricos:
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.
Moneda Es la moneda "base" o contable que usa tu empresa. Este campo se establece de forma predeterminada con el valor del campo Moneda en el perfil de la organización.
Tipo de precios Es la base del porcentaje de ingresos. Selecciona Bruto o Neto. Si seleccionas Bruto, el porcentaje de ingresos se basa en un porcentaje del precio bruto de una transacción. Si seleccionas Neto, el porcentaje de ingresos se basa en un porcentaje del precio neto de una transacción. Nota: El precio bruto o neto de la transacción se establece cuando creas la política de registro de transacciones.
Porcentaje de participación fija Es el porcentaje que se usa para calcular el porcentaje de ingresos. Ingresa un número decimal (con hasta cuatro decimales). Por ejemplo, si ingresas 80.5555, el porcentaje de ingresos es de un 80.5555%, es decir, como proveedor de la API, le pagas al desarrollador el 80.5555% del precio que se cobra por cada transacción.
En el caso del modelo de reparto flexible, sigue estos pasos:
Si seleccionas el modelo de uso compartido flexible, verás que la ventana Generic Revenue Share (Reparto de ingresos genérico) muestra campos adicionales. Usa estos campos para especificar una base de agregación y para especificar "bandas de ingresos", es decir, rangos de ingresos generados por transacciones para los que puedes aplicar diferentes porcentajes de reparto de ingresos.
Ingresa la siguiente información en la ventana Porcentaje de ingresos genérico:
Campo Descripción Base de agregación Es el período en el que se agregan los ingresos. Los ingresos agregados se usan para calcular el tramo de ingresos de cada transacción (y el porcentaje de ingresos aplicable). Selecciona una cantidad de meses (entre 1 y 12).
Bandas de ingresos Uno o más rangos de ingresos por transacciones (cada rango es una "banda de ingresos"). Se puede asignar un porcentaje de reparto de ingresos a cada banda de ingresos (estableces este porcentaje en el campo Bandas de ingresos de la sección Precios). Las transacciones se agregan en función de la base de agregación para calcular los ingresos totales y la banda de ingresos de la transacción. El porcentaje de ingresos que se aplica a cada transacción depende de su banda de ingresos.
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, de más de 1,000 y hasta de 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 después de que los ingresos agregados superen 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 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.
Moneda La moneda "base" o de contabilidad que usa tu organización. Este campo se preestablece con el valor del campo Moneda en el perfil de la organización.
Tipo de precios Es la base del porcentaje de ingresos. Selecciona Bruto o Neto. Si seleccionas Bruto, el porcentaje de ingresos se basa en un porcentaje del precio bruto de una transacción. Si seleccionas Neto, el porcentaje de ingresos se basa en un porcentaje del precio neto de una transacción. Nota: Estableces el precio bruto o neto de la transacción cuando creas la política de registro de transacciones.
Porcentaje de ingresos por bandas de ingresos Es el porcentaje que se usa para calcular el porcentaje de ingresos de las transacciones en cada tramo de ingresos. Especifica un porcentaje para cada banda. Ingresa un número decimal (con hasta cuatro decimales). Por ejemplo, si especificas dos tramos de ingresos en la sección Rango de ingresos (>0-1,000 y 1,000 y más), puedes ingresar 80.5555 para el tramo de ingresos >0-1,000 y 90.5 para el tramo de ingresos de 1,000 y más. También supongamos que la moneda es dólares estadounidenses. Por lo tanto, para las transacciones que generan hasta $1,000 de ingresos, el porcentaje de ingresos es del 80.5555% del precio de la transacción y, para las transacciones que generan más de $1,000 de ingresos, el porcentaje de ingresos es del 90.5% del precio de la transacción.
- Haz clic en Aplicar y cerrar para guardar los detalles del reparto de ingresos 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.
Especifica los detalles del plan de reparto de ingresos con la API
Especificas los detalles del plan de reparto de ingresos cuando creas el plan de tarifas. 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 depende del modelo de uso compartido que elijas:
fijo o flexible.
Especifica los detalles del plan de porcentaje de ingresos para un modelo de reparto fijo
Para implementar el modelo de uso compartido fijo, 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).VOLUMEes el valor predeterminado. - Un tipo de medición (
UNIT) que indica que el porcentaje de ingresos es fijo por unidad (es decir, no se basa en el volumen de transacciones, como es el caso del modelo de uso compartido flexible). - El tipo de ingresos (
GROSSoNET). Indica si el reparto de ingresos se basa en el precio bruto o neto de una transacción. - 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 tarifa del plan de tarifas que proporciona detalles sobre cómo se calcula el porcentaje de ingresos. Debido a que el modelo de uso compartido se basa en una tarifa fija, solo debes especificar una tarifa del plan de tarifas.
Consulta Propiedades de configuración para los detalles de los planes de tarifas para obtener una lista completa de las propiedades de detalles de los planes de tarifas.
En la tarifa del plan de tarifas, debes especificar lo siguiente:
- El tipo de tarifa del plan de tarifas (
REVSHARE). - Es el porcentaje que se usa para calcular el porcentaje de ingresos. Por ejemplo, si especificas 80.5555, el porcentaje de ingresos es del 80.5555%, es decir, como proveedor de API debes pagar al desarrollador el 80.5555% del precio cobrado por cada transacción (o, si se basa en un atributo personalizado, como la cantidad de bytes transmitidos en una transacción, debes pagar al desarrollador el 80.5555% del precio de transmisión especificado).
- 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 Propiedades de configuración de los planes de tarifas para obtener una lista completa de las propiedades de los planes de tarifas.
Por ejemplo, el siguiente comando crea un plan de participación de ingresos con un modelo de participación fijo. El porcentaje de reparto de ingresos es del 80.5555%. El porcentaje de ingresos se basa en el precio neto de una transacción. El contrato entrará en vigencia el 15 de septiembre de 2013 y el pago deberá realizarse en un plazo de 30 días. (Los detalles relacionados con el reparto de ingresos están destacados).
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Fixed share plan",
"developer":null,
"developerCategory":null,
"advance": false,
"currency": {
"id": "usd"
},
"description": "Fixed share plan",
"displayName": "Fixed share plan",
"earlyTerminationFee": 10,
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": false,
"published": true,
"ratePlanDetails": [
{
"aggregateStandardCounters": true,
"currency": {
"id": "usd"
},
"duration": 1,
"durationType": "MONTH",
"meteringType": "UNIT",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates": [
{
"revshare": 80.8555,
"startUnit": 0,
"type": "REVSHARE"
}
],
"ratingParameter": "VOLUME",
"revenueType": "NET",
"type": "REVSHARE"
}
],
"recurringStartUnit": 1,
"recurringType": "CALENDAR",
"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
La respuesta debería verse de la siguiente manera (solo se muestra una parte de la respuesta):
{
"advance" : false,
"currency" : {
"id" : "usd",
"name" : "USD",
...
"organization" : {
...
},
...
},
"description" : "Fixed share plan",
"displayName" : "Fixed share plan",
"earlyTerminationFee" : 10,
"id" : "location_fixed_share_plan",
"monetizationPackage" : {
"description" : "Location",
"displayName" : "Location",
"id" : "location",
"name" : "Location",
"organization" : {
...
},
"product" : [ {
"customAtt1Name" : "user",
"description" : "Location",
"displayName" : "Location",
"id" : "location",
"name" : "location",
"organization" : {
...
},
"status" : "CREATED"
} ],
"status" : "CREATED"
},
"name" : "Fixed share plan",
"organization" : {
...
},
"paymentDueDays" : "30",
"prorate" : false,
"published" : true,
"ratePlanDetails" : [ {
"aggregateFreemiumCounters" : true,
"aggregateStandardCounters" : true,
"currency" : {
"id" : "usd",
"name" : "USD",
...
"organization" : {
...
},
...
},
"duration" : 1,
"durationType" : "MONTH",
"id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
"meteringType" : "UNIT",
"organization" : {
...
},
"paymentDueDays" : "30",
"ratePlanRates" : [ {
"id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
"revshare" : 80.8555,
"startUnit" : 0,
"type" : "REVSHARE"
} ],
"ratingParameter" : "VOLUME",
"revenueType" : "NET",
"type" : "REVSHARE"
} ],
"recurringStartUnit" : 1,
"recurringType" : "CALENDAR",
"setUpFee" : 10,
"startDate" : "2013-09-15 00:00:00",
"type" : "STANDARD"
}
Especifica los detalles del plan de porcentaje de ingresos para un modelo de reparto flexible
En un modelo de uso compartido flexible, puedes especificar los detalles del plan de tarifas que incluyan una o más tarifas del plan de tarifas. Cada tarifa del plan de tarifas abarca un rango de ingresos por transacciones (cada rango se denomina "banda de ingresos"). Asignas un porcentaje de participación de ingresos para cada tramo de ingresos.
Además de las tarifas del plan de tarifas, debes especificar lo siguiente en los detalles del plan de tarifas:
- Un parámetro de calificación que indica que el plan de tarifas se basa en las transacciones (
VOLUME).VOLUMEes el valor predeterminado. - Es un tipo de medición (
VOLUME) que indica que el porcentaje de ingresos no se basa en el volumen de transacciones (es decir, no es fijo, como es el caso del modelo de uso compartido fijo). - El tipo de ingresos (
GROSSoNET). Indica si el reparto de ingresos se basa en el precio bruto o neto de una transacción. - 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 un tipo de duración y duración que, en conjunto, especifican el período durante el cual se agregan los ingresos (esto también se denomina "base de agregación"). Las transacciones se agregan en función del período de agregación (por ejemplo, 1 mes) para calcular los ingresos totales y el intervalo de ingresos aplicable. El porcentaje de ingresos que se aplica a cada transacción depende de su banda de ingresos.
- Contadores de agregación que se usan para determinar la banda de ingresos aplicable.
Consulta Propiedades de configuración para los detalles de los planes de tarifas para obtener una lista completa de las propiedades de detalles de los planes de tarifas.
Para cada tarifa del plan de tarifas, especifica lo siguiente:
- Es el tipo de tarifa del plan de tarifas para el tramo de ingresos (
REVSHARE). - Es el porcentaje que se usa para calcular el porcentaje de ingresos de la banda de ingresos. Por ejemplo, si especificas 80.5555, el porcentaje de ingresos de la banda de ingresos es del 80.5555%, es decir, como proveedor de la API, le pagas al desarrollador el 80.5555% del precio cobrado por cada transacción en esa banda de ingresos.
- La unidad de inicio y finalización de la banda de ingresos. La unidad inicial especifica el límite inferior de una banda de ingresos, y la unidad final especifica el límite superior de la banda de ingresos. Por ejemplo, si especificas una unidad inicial de 0 y una unidad final de 1,000, el rango de ingresos abarca los ingresos por transacciones superiores a 0 y hasta 1,000 en la moneda especificada. Si la moneda es el dólar estadounidense, la base de agregación es 1 mes y el porcentaje para la banda de ingresos es del 80.5555%; entonces, para las transacciones que generan hasta $1,000 en ingresos en un mes, el porcentaje de ingresos es del 80.5555% del precio de la transacción.
Si no especificas una unidad final para la banda de ingresos final, el porcentaje de participación correspondiente se aplicará a todas las transacciones después de que los ingresos agregados hayan superado la unidad inicial de esa banda. Por ejemplo, si la unidad inicial de la última banda es 1,000 (suponiendo dólares estadounidenses) y no especificas una unidad final para esa banda, el porcentaje de ingresos de la banda se aplica a todas las transacciones superiores a USD 1,000 de ingresos durante el período agregado.
Consulta Propiedades de configuración de los planes de tarifas para obtener una lista completa de las propiedades de los planes de tarifas.
Por ejemplo, el siguiente comando crea un plan de participación de ingresos con un modelo de uso compartido flexible. Especifica dos bandas de ingresos. La primera franja abarca los ingresos por transacciones superiores a USD 1,000. La segunda banda cubre los ingresos por transacciones superiores a USD 1,000. El porcentaje de participación de ingresos es del 80.5555% para la primera banda de ingresos y del 90.5% para la segunda. El porcentaje de ingresos se basa en el precio neto de una transacción. La base de agregación es de 1 mes. El período del contrato entrará en vigencia el 15 de septiembre de 2013, y el pago deberá realizarse en un plazo de 30 días. (Los detalles relacionados con el porcentaje de ingresos están destacados).
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Flexible share plan",
"developer":null,
"developerCategory":null,
"advance": "true",
"currency": {
"id": "usd"
},
"description": "Flexible share plan",
"displayName": "Flexible share plan",
"frequencyDuration": "30",
"frequencyDurationType": "DAY",
"earlyTerminationFee": "10",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"prorate": "false",
"published": "true",
"ratePlanDetails": [
{
"currency": {
"id": "usd"
},
"duration": "1",
"durationType": "MONTH",
"meteringType": "VOLUME",
"organization": {
"id": "{org_name}"
},
"paymentDueDays": "30",
"ratePlanRates" : [ {
"endUnit" : 1000,
"revshare" : 80.5555,
"startUnit" : 0,
"type" : "REVSHARE"
}, {
"revshare" : 90.5,
"startUnit" : 1000,
"type" : "REVSHARE"
} ],
"ratingParameter" : "VOLUME",
"revenueType" : "NET",
"type" : "REVSHARE"
} ],
"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
La respuesta debería verse de la siguiente manera (solo se muestra una parte de la respuesta):
{
"advance" : true,
"currency" : {
"id" : "usd",
"name" : "USD",
"organization" : {
...
},
...
},
"description" : "Flexible share plan",
"displayName" : "Flexible share plan",
"earlyTerminationFee" : 10,
"frequencyDuration" : 30,
"frequencyDurationType" : "DAY",
"id" : "location_flexible_share_plan",
"monetizationPackage" : {
"description" : "Location",
"displayName" : "Location",
"id" : "location",
"name" : "Location",
"organization" : {
...
},
"product" : [ {
"customAtt1Name" : "user",
"description" : "Location",
"displayName" : "Location",
"id" : "location",
"name" : "location",
"organization" : {
...
},
"status" : "CREATED"
} ],
"status" : "CREATED"
},
"name" : "Flexible share plan",
"organization" : {
...
},
"paymentDueDays" : "30",
"prorate" : false,
"published" : false,
"ratePlanDetails" : [ {
"aggregateFreemiumCounters" : true,
"aggregateStandardCounters" : true,
"currency" : {
"id" : "usd",
"name" : "USD",
…
"organization" : {
...
},
...
},
"duration" : 1,
"durationType" : "MONTH",
"id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
"meteringType" : "VOLUME",
"organization" : {
...
},
"paymentDueDays" : "30",
"ratePlanRates" : [ {
"endUnit" : 1000,
"id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
"revshare" : 80.5555,
"startUnit" : 0,
"type" : "REVSHARE"
}, {
"id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
"revshare" : 90.5,
"startUnit" : 1000,
"type" : "REVSHARE"
} ],
"ratingParameter" : "VOLUME",
"revenueType" : "NET",
"type" : "REVSHARE"
} ],
"recurringFee" : 10,
"recurringStartUnit" : 1,
"recurringType" : "CALENDAR",
"setUpFee" : 10,
"startDate" : "2013-09-15 00:00:00",
"type" : "STANDARD"
}