Estás viendo la documentación de Apigee Edge.
Ve a la
Documentación de Apigee X. información
Introducción
En un plan de reparto de ingresos, el proveedor de la API comparte con el desarrollador un porcentaje del ingresos generados por cada transacción (según el precio bruto o neto de la transacción) Cuándo Para crear 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 bruto o en el neto el precio de una transacción). Debes establecer el precio bruto o neto de la transacción cuando creas la política de registro de transacciones.
En el modelo de uso compartido 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 la transacción). En la Con un modelo de uso compartido flexible, compartes con el desarrollador un porcentaje variable de los ingresos. El el porcentaje de ingresos depende de los ingresos generados durante un período de tiempo. El porcentaje utilizado en el el cálculo del porcentaje de ingresos puede variar en función de la cantidad de ingresos generados por las transacciones.
Especificación de los detalles del plan de reparto de ingresos con la IU
Configura los planes de reparto de ingresos como se describe a continuación.
Edge
Para configurar un plan de reparto de ingresos con la IU de Edge durante la creación o la edición un plan de tarifas, selecciona el tipo de plan Reparto de ingresos o Hoja de tarifas y Reparto de ingresos y, en la sección Reparto 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 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). |
| Modelo de uso compartido | Selecciona uno de los siguientes modelos de reparto de ingresos:
|
| Reparto 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 APIs, debes pagar al desarrollador el 80.5555% del precio que se cobra por cada transacción. |
| Bandas de porcentaje de ingresos | Para el modelo de uso compartido flexible, hay 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 bandas de ingresos en la sección Banda de ingresos (>0-1,000 y 1,000 y más), podrías ingresar 80.5555 para la banda de ingresos >0-1000 y 90.5 para la banda de ingresos de 1,000 y más. Además, imagina que la moneda está expresada en dólares estadounidenses. Por lo tanto, para las transacciones que generan hasta USD 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 USD 1,000 de ingresos, el porcentaje de ingresos es del 90.5% del precio de la transacción. |
Classic Edge (nube privada)
Para configurar planes de reparto de ingresos con la IU clásica de Edge, sigue estos pasos:
- 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 API incluye un solo producto de API, puedes omitir este paso.
- Planes específicos por producto para configurar los detalles de los planes de tarifas para 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 de productos de API, deberás establecer un plan de reparto de ingresos. para cada producto de API de forma individual.
Se abrirá la ventana de Reparto 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 por 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 una variable porcentaje de los ingresos. El porcentaje de ingresos depende de los ingresos generados durante un período un plazo determinado. El porcentaje que se usa para calcular el porcentaje de ingresos puede variar en función del importe de los ingresos generados por transacciones.
Para el modelo de uso compartido fijo:
Si seleccionas el modelo de uso compartido fijo, ingresa la siguiente información en el campo Precios de la ventana Generic Revenue Share (Porcentaje de ingresos genérico):
Campo Descripción Operador (organización) El nombre de tu organización. Este campo se ajusta de forma predeterminada usando el 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 ajusta de forma predeterminada con el Valor del campo Country en el perfil de la organización.
Moneda La "base" o con la moneda de contabilidad que usa tu empresa. Este campo está predeterminado con el valor del campo Moneda del perfil de la organización.
Tipo de precios 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 seleccione Neto, el reparto 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 uso compartido fijo Es el porcentaje que se usa para calcular el porcentaje de ingresos. Ingresa un número decimal (con con hasta cuatro decimales). Por ejemplo, si ingresas 80.5555, el porcentaje de ingresos es 80.5555%. Es decir, como proveedor de API, pagas al desarrollador el 80.5555% del precio. cobra por cada transacción.
Para el modelo de uso compartido flexible:
Si seleccionas el modelo de uso compartido flexible, verás la ventana de reparto de ingresos genérico. muestra campos adicionales. Usarás 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 Generic Revenue Share (Porcentaje de ingresos genérico):
Campo Descripción Base de agregación Es el período durante el cual se agregan los ingresos. Los ingresos agregados son que se usa para calcular la banda de ingresos de cada transacción (y los ingresos porcentaje de participación). Selecciona una cantidad de meses (entre 1 y 12).
Bandas de ingresos Uno o más intervalos de ingresos por transacciones (cada rango es una "banda de ingresos"). Cada a la banda de ingresos se le puede asignar un porcentaje de porcentaje de ingresos (establece este porcentaje en el campo Bandas de ingresos de la sección Precios). Las transacciones se agregan durante el de agregación para calcular los ingresos totales y la banda de ingresos del transacción. El porcentaje de reparto 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 valor el límite está predeterminado en un valor superior a 0). Haz clic en + para agregar una segunda banda, por ejemplo, superior a 1,000 y hasta 2,000. Haz clic en + para agregar más correas. Puedes dejar el panel límite de la banda final vacío para indicar todas las transacciones después del agregado los ingresos están por encima de este nivel.
Precios Operador (organización) El nombre de tu organización. Este campo se ajusta de forma predeterminada usando el 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 ajusta de forma predeterminada con el Valor del campo Country en el perfil de la organización.
Moneda La "base" o la moneda de contabilidad que usa tu organización. Este campo es con el valor del campo Moneda del perfil de la organización.
Tipo de precios 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 seleccione Neto, el reparto 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 reparto para los intervalos de ingresos El porcentaje que se usa para calcular el reparto de ingresos de las transacciones en cada banda de ingresos. Debes especificar un porcentaje para cada banda. Ingresa un número decimal (con hasta con cuatro decimales). Por ejemplo, si especificas dos bandas de ingresos en el campo Ingresos En la sección Banda (>0-1,000, y 1,000 y más), puedes ingresar 80.5555 para el Banda de ingresos >0-1000, y 90.5 para la banda de ingresos de 1000 y más. También supón y la moneda está en dólares estadounidenses. Luego, para las transacciones que generan hasta $1,000 en ingresos, el porcentaje de ingresos es del 80.5555% del precio de la transacción y para el que generan más de USD 1,000 de ingresos, el porcentaje de ingresos es del 90.5% de el precio de la transacción.
- Haga clic en Aplicar y cerrar para guardar los detalles del porcentaje de ingresos y volver a la tarifa estándar. Período del plan.
- En el caso de los planes de tarifas específicos de los productos de API, configura los detalles del plan de tarifas para productos de API adicionales, según sea necesario.
Cómo especificar los detalles del plan de reparto de ingresos mediante la API
Debes especificar los detalles del plan de reparto de ingresos cuando lo crees. Tú 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
que se especifica en la propiedad ratePlanDetails, según el modelo de uso compartido que elijas:
fijas o flexibles.
Especificación de los detalles del plan de reparto de ingresos para un modelo de uso compartido fijo
Para implementar el modelo de uso compartido fijo, 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. - 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 sucede con los de uso compartido). - El tipo de ingresos (
GROSSoNET). Esto indica si el porcentaje de ingresos se basa en el precio bruto o neto de una transacción. - El período límite del pago (por ejemplo, 30 días)
- El ID de tu organización.
- La "base" o con la moneda de contabilidad que usa tu empresa.
- Una tarifa del plan de tarifas que proporciona detalles sobre cómo se calcula el porcentaje de ingresos. Porque El modelo de uso compartido se basa en una tarifa fija, solo se especifica una tarifa del plan de tarifas.
Consulta Propiedades de configuración de los detalles del plan de tarifas para obtener una lista completa de las propiedades de detalles del plan 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 APIs, le pagas al desarrollador el 80.5555% de el precio que se cobra por cada transacción (o si se basa en un atributo personalizado, como el número de de bytes transmitidos en una transacción, pagas al desarrollador el 80.5555% del precio que se cobra transmitir la cantidad especificada de bytes).
- La unidad inicial de la aplicación de tarifas (
0). Esto significa que la tasa es se aplican a cada transacción, empezando 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, lo siguiente crea un plan de reparto de ingresos con un modelo de uso compartido fijo. El el porcentaje de ingresos es del 80.5555%. El porcentaje de ingresos se basa en el precio neto de un transacción. El contrato entra en vigencia el 15 de septiembre de 2013 y el pago vence en 30 días. (El 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 ser similar a la siguiente (solo se muestra una parte):
{ "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" }
Especificación de los detalles del plan de reparto de ingresos para un modelo de uso compartido flexible
En un modelo de uso compartido flexible, puedes especificar los detalles del plan de tarifas que incluyen uno o más planes de tarifas. y tasas de cambio. Cada tarifa del plan de tarifas abarca un rango de ingresos por transacciones (cada rango se denomina “ingresos "). Debes asignar un porcentaje de porcentaje de ingresos para cada banda 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. - 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 sucede con el uso compartido fijo, automático). - El tipo de ingresos (
GROSSoNET). Esto indica si el porcentaje de ingresos se basa en el precio bruto o neto de una transacción. - El período límite del pago (por ejemplo, 30 días)
- El ID de tu organización.
- La "base" o con la moneda de contabilidad que usa tu empresa.
- Es un tipo de duración y duración que, en conjunto, especifican el período durante el cual se generan los ingresos agregadas (esto también se denomina “base de agregación”). Las transacciones se agregan durante el de agregación (por ejemplo, 1 mes) para calcular los ingresos totales y las banda de ingresos. El porcentaje de reparto de ingresos que se aplica a cada transacción depende de sus ingresos correa.
- Contadores de agregación que se usan para determinar la banda de ingresos aplicable.
Consulta Propiedades de configuración de los detalles del plan de tarifas para obtener una lista completa de las propiedades de detalles del plan de tarifas.
Para cada tarifa del plan de tarifas, debes especificar lo siguiente:
- El tipo de tarifa del plan de tarifas para la banda de ingresos (
REVSHARE). - Es el porcentaje que se usa para calcular el porcentaje de ingresos de la banda de ingresos. Por ejemplo, especificas 80.5555, el porcentaje de ingresos para la banda de ingresos es del 80.5555%, es decir, como una API le pagas al desarrollador el 80.5555% del precio cobrado por cada transacción banda de ingresos.
- Unidad inicial y final de la banda de ingresos. La unidad inicial especifica el valor
límite de una banda de ingresos y la unidad final especifica el límite superior de esa banda. Para
Por ejemplo, si especificas una unidad inicial de 0 y una final de 1,000, la banda de ingresos
abarca ingresos por transacciones superiores a 0 y hasta 1,000 en la moneda especificada. Si el botón
la moneda es el dólar estadounidense, la base de agregación es 1 mes y el porcentaje de los ingresos
banda es de 80.5555%; entonces, para las transacciones que generan hasta $1,000 de ingresos en un mes, el
el porcentaje de ingresos es del 80.5555% del precio de la transacción.
Si no especifica una unidad final para la banda de ingresos final, se aplicará el porcentaje de esa banda se aplica a todas las transacciones después de que los ingresos agregados superan el unidad inicial de esa banda. Por ejemplo, si la unidad inicial para la última banda es 1,000. (supongamos en dólares estadounidenses) y no especificas una unidad final para esa banda, los ingresos el porcentaje para la banda se aplica a todas las transacciones superiores a $1000 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, lo siguiente crea un plan de reparto de ingresos con un modelo de uso compartido flexible. Integra especifica dos bandas de ingresos. La primera banda abarca los ingresos por transacciones superiores a 1,000 dólares estadounidenses. La segunda banda abarca los ingresos por transacciones superiores a 1,000 dólares estadounidenses. Los ingresos es de 80.5555% para la primera banda de ingresos y 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 1 mes. El período del contrato entra en vigencia el 15 de septiembre de 2013 y el pago vence en 30 días. (los ingresos los detalles relacionados con el uso compartido están resaltados).
$ 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 ser similar a la siguiente (solo se muestra una parte):
{ "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" }