Descripción general de la monetización de Apigee

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

Consulta la documentación de Apigee Edge.

Esta sección es una introducción a la monetización de Apigee.

Monetiza la API con la monetización de Apigee

Como proveedor de API, necesitas una manera fácil y flexible de monetizar tus API para que puedas generar ingresos cada vez que se usen tus API. Con la función de monetización de Apigee, puedes agregar un plan de tarifas a un producto de API. El plan de tarifas te permite cobrar a los desarrolladores por usar tus API. También puedes configurar el plan de tarifas para compartir tus ingresos de API con los desarrolladores.

El proveedor de la API crea un producto de API que define los proxies de API y los planes de tarifas que los desarrolladores de apps pueden comprar. Los desarrolladores de apps proporcionan una clave de API cuando compran un plan de tarifas. Los proveedores de API pueden generar informes de uso para el análisis y la facturación.

Como proveedor de API, debes monetizar tus API. Para ello, habilita la monetización de Apigee en tu organización y configura los componentes que se definen en la siguiente tabla.

Componente	Descripción
Proxies de API	Cuando desarrollas proxies de API para usar con los productos de API monetizados, puedes adjuntar las siguientes políticas: Política VerifyAPIKey o la operación VerifyAccessToken de la política OAuth2 para determinar si una solicitud entrante es monetizable mediante la verificación del plan de tarifas publicado activo. Para obtener más información, consulta Cómo agregar una política de autenticación. Política de MonetizationLimitsCheck para validar si el desarrollador compró el producto de API asociado y tiene suficiente saldo en la cartera. Para obtener más información, consulta Aplica suscripciones de desarrollador a productos de API. La política de cuotas para usar la configuración de cuota definida con el producto de API. Para obtener más información, consulta Aplica cuotas de monetización. Política DataCapture para anular los datos de uso relacionados con la monetización. Para obtener más información, consulta Captura datos de monetización.
Producto de API	Define la colección de proxies de API que deseas proporcionar a los desarrolladores de apps como un paquete monetizado. El producto de API configura los límites de acceso (cuotas), el método de aprobación de la clave de API, el plan de tarifas (que se describe a continuación) y otros detalles para los proxies de API agrupados. Para obtener más información, consulta ¿Qué es un producto de API? y Aplica cuotas de monetización en productos de API. Nota: Si usas el producto de API con la monetización de Apigee, el nombre del producto no debe contener ningún espacio final.
Plan de tarifa	Define la configuración de facturación, las tarifas y los cargos que se generan por el uso de las APIs que se ofrecen en un paquete de productos de API monetizado. Por ejemplo, puedes compartir los ingresos de la API con tus desarrolladores. Si deseas obtener más información, consulta Administra planes de tarifas para productos de API. Nota: Si se asocia un plan de tarifas activo con un producto de API, se considera que el producto de API está monetizado. Un producto de API puede tener varios planes de tarifas asociados, pero solo un plan de tarifas puede estar activo en cualquier momento.

Componente

Descripción

Proxies de API

Cuando desarrollas proxies de API para usar con los productos de API monetizados, puedes adjuntar las siguientes políticas:

Política VerifyAPIKey o la operación VerifyAccessToken de la política OAuth2 para determinar si una solicitud entrante es monetizable mediante la verificación del plan de tarifas publicado activo. Para obtener más información, consulta Cómo agregar una política de autenticación.
Política de MonetizationLimitsCheck para validar si el desarrollador compró el producto de API asociado y tiene suficiente saldo en la cartera. Para obtener más información, consulta Aplica suscripciones de desarrollador a productos de API.
La política de cuotas para usar la configuración de cuota definida con el producto de API. Para obtener más información, consulta Aplica cuotas de monetización.
Política DataCapture para anular los datos de uso relacionados con la monetización. Para obtener más información, consulta Captura datos de monetización.

Producto de API

Define la colección de proxies de API que deseas proporcionar a los desarrolladores de apps como un paquete monetizado. El producto de API configura los límites de acceso (cuotas), el método de aprobación de la clave de API, el plan de tarifas (que se describe a continuación) y otros detalles para los proxies de API agrupados. Para obtener más información, consulta ¿Qué es un producto de API? y Aplica cuotas de monetización en productos de API.

Plan de tarifa

Define la configuración de facturación, las tarifas y los cargos que se generan por el uso de las APIs que se ofrecen en un paquete de productos de API monetizado. Por ejemplo, puedes compartir los ingresos de la API con tus desarrolladores. Si deseas obtener más información, consulta Administra planes de tarifas para productos de API.

Administra las suscripciones a productos de API de desarrolladores de apps

Para acceder a una API en un producto de API monetizado, los desarrolladores de apps deben tener una suscripción al producto de API y obtener claves de API para enviar con solicitudes a la API.

Los desarrolladores de apps pueden obtener suscripciones con cualquiera de los siguientes métodos:

Directamente, obteniendo una suscripción al producto de API En este caso, tú, como proveedor de API, debes proporcionar un método para que los desarrolladores de aplicaciones compren suscripciones a tus productos de API. Una de estas opciones:
- Integra la monetización de Apigee a tu portal para desarrolladores basado en Drupal
- Crea una interfaz personalizada para el portal y compra y administra suscripciones a productos de API mediante la API
A través de una membresía en un AppGroup. Si deseas obtener información para administrar suscripciones con AppGroups, consulta Usa AppGroups para administrar suscripciones a productos de API.

Usa AppGroups para administrar suscripciones a productos de API

Apigee admite el uso de AppGroups para administrar las suscripciones a productos de API y la monetización por el uso de esos productos de API. Si un desarrollador de apps es miembro de un AppGroup que tiene una suscripción a un producto de API, ese desarrollador de apps automáticamente tendrá la misma suscripción al producto de API.

Los AppGroups en la monetización admiten las siguientes funciones:

Son los AppGroups suscritos a productos de API con planes de tarifas.
Tipos de facturación de AppGroup: PREPAID o POSTPAID.
Las billeteras de AppGroup prepagadas se debitan según el plan de tarifas del producto de API suscrito.
Recargas para los saldos de cuentas prepagadas de AppGroup.
Ajuste manual por parte del administrador de los saldos de AppGroups.
Se registran los cargos por consumo y participación en los ingresos de los AppGroups, de manera similar a los desarrolladores.

Para usar AppGroups con la monetización, proporciona uno de los métodos de suscripción que se indican en Permite que los desarrolladores de aplicaciones compren suscripciones a productos de API y, luego, incluye la administración de AppGroup en la interfaz.

Si deseas obtener información sobre la administración general de AppGroups, consulta Visualiza y administra AppGroups.

Información sobre las cuotas de monetización

Una cuota define la cantidad de solicitudes permitidas para un producto de API durante un período determinado. Las cuotas pueden proteger tus servidores de backend de las altas variaciones del tráfico y diferenciar tu línea del producto.

Cuando creas tus productos de API, puedes configurar cuotas a nivel empresarial para controlar el acceso a las API. Para obtener más información sobre las cuotas definidas en el nivel de producto de la API, consulta Cuotas.

Adjunta las políticas de cuotas a los proxies de API en tu producto de API monetizado para asegurarte de que se use la cuota definida en el nivel de producto de la API. Para obtener más información, consulta Aplica cuotas de monetización.

Información sobre la facturación de los productos de API monetizados

La monetización de Apigee admite cuentas de facturación post pagas y prepagas.

Facturación pospago: En la facturación pospago, los desarrolladores de apps no realizan ningún pago por adelantado. Se les factura a los desarrolladores de apps después de usar tus productos de API.
Apigee no proporciona ninguna funcionalidad específica de generación de facturas para la facturación. Tú controlas el acuerdo de facturación con tus desarrolladores.
Facturación prepaga: En la facturación prepaga, los desarrolladores de apps pagan por adelantado antes de usar tus productos de API. El pago por adelantado que realizan los desarrolladores está disponible en la cartera del desarrollador. Según el uso, el costo por transacción se deduce de la billetera.
La tarifa de configuración (si existe), el costo por transacción y las tarifas recurrentes se deducen de la billetera. Si la billetera del desarrollador contiene menos que la cantidad de cualquier tarifa de configuración en el momento del intento de compra del producto de API, la compra fallará con un error que indica fondos insuficientes.

Cuando creas un plan de tarifas, debes configurar la moneda y la frecuencia de facturación, cualquier tarifa de configuración y recurrente, y las tarifas basadas en el consumo. Según la configuración del plan de tarifas y la clave de API única del desarrollador que se usa para acceder a tus API, puedes recopilar datos para análisis y generar informes de monetización. Luego, puedes usar los datos recopilados para generar tus facturas.