Pasos para configurar la monetización

Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Más información

Antes de comenzar

Antes de comenzar a usar la monetización con tu organización de Apigee, debes realizar las siguientes tareas de requisitos previos:

  • Crea una cuenta de Apigee Edge, como se describe en Crea una cuenta de Apigee Edge.
  • Monetización de compras Inicialmente, Edge no incluye la API de monetización ni integra la monetización en la IU de administración. Debes comprar la función de monetización para incorporar la API de monetización y los componentes de la IU de monetización a Edge en tu organización de Apigee.

Después de comprar la monetización, debes realizar las siguientes tareas:

Configuración inicial con Apigee

Trabajar con el equipo de configuración de Apigee Edge para completar la configuración inicial de la monetización En función de tu entrada, el equipo de configuración establecerá lo siguiente:

  • Si tu organización es una empresa de telecomunicaciones
  • El tipo de facturación que quieres admitir para los desarrolladores que compren tus planes de tarifas: prepagado, pospago o ambos. Consulte el artículo Cuentas prepagadas frente a cuentas pospago.
  • Indica si quieres extraer datos de la monetización detallados o resumidos en tu sistema contable y el formato de datos requerido.
  • Dirección de correo electrónico de respuesta personalizada. Para las notificaciones por correo electrónico de monetización que se envían a empresas y desarrolladores, se configura una dirección noreply@apigee.com predeterminada. Debes solicitar un nombre y una dirección de respuesta personalizados para tu organización.

El equipo de configuración de Apigee ejecuta una secuencia de comandos para sincronizar la monetización con tu organización y cualquier desarrollador, aplicación y producto de API que hayas creado con Apigee Edge. La asistencia de Apigee puede solicitar que sincronices tu organización en el futuro, como se describe en Sincroniza datos de Apigee Edge con monetización para obtener más detalles. No sincronice los datos de monetización, a menos que Apigee le indique lo contrario.

Cómo configurar la monetización

En la siguiente tabla, se resumen los pasos necesarios para configurar la monetización en tu organización de Apigee.
Step Descripción
Cómo editar el perfil de tu organización Como parte de la configuración inicial de la monetización, el equipo de configuración de Apigee Edge configura el perfil de tu organización.

Debes editar el perfil de la organización para agregar o actualizar información sobre la organización, según corresponda. Por ejemplo, es posible que debas actualizar el tipo de facturación, la configuración de la moneda o el modelo fiscal.

Administra las monedas admitidas Como parte de la configuración inicial de la monetización, el equipo de configuración de Apigee Edge especifica las monedas que admite tu organización y establece la moneda predeterminada.

Puedes recuperar las monedas que admite tu organización y agregar o borrar monedas admitidas (para reflejar las que usa un desarrollador o un plan de tarifas).

Nota: La monetización ejecuta automáticamente un trabajo diario que obtiene el tipo de cambio en dólares estadounidenses para cada moneda admitida. De forma predeterminada, el trabajo se ejecuta todos los días 1 segundo después de la medianoche. Para obtener más información, consulta Cómo programar trabajos de monetización.
Especificar los Términos y Condiciones De manera opcional, puedes agregar términos y condiciones al perfil de tu organización antes de publicar planes de tarifas. Después de publicar un plan de tarifas, se mostrará la versión actual de los Términos y Condiciones en el portal para desarrolladores.

Nota: Los Términos y Condiciones no se incluyen en el perfil de tu organización. En el perfil de tu organización, especifica la ubicación (URL pública) de los Términos y Condiciones. Puede agregar varias versiones de los Términos y Condiciones para reflejar los cambios en el tiempo.
Aplica límites de monetización Adjunta la política monetizationLimitsCheck a los proxies de API para hacer cumplir los límites de monetización.

Específicamente, la política se activa en las siguientes condiciones:

  • El desarrollador que accede a la API monetizada no está registrado o no está suscrito al plan de tarifas.
  • El desarrollador superó el volumen de transacciones correspondiente al plan de tarifas al que se suscribió.
  • Se alcanzó el saldo de la cuenta prepagada del desarrollador o el límite de crédito pospago.
Configura las notificaciones Configura notificaciones para notificar a los desarrolladores o proveedores de la API sobre un evento específico, como un plan de tarifas publicado recientemente.

Monetiza tus APIs

Cuando monetizas APIs, empaquetas uno o más productos de API en un paquete de productos de API y defines el plan de tarifas asociado.

Los desarrolladores no podrán ver los paquetes de productos de API hasta que publiques un plan de tarifas para el paquete (con una fecha de inicio de la fecha actual o posterior). Los desarrolladores pueden registrar sus apps para usar un paquete de productos de API solo si compran uno de los planes de tarifas vigentes en la actualidad. Si un paquete de productos de API no tiene un plan de tarifas publicado que esté vigente en ese momento, el paquete no se monetizará.

En la siguiente tabla, se resumen los pasos necesarios para monetizar tus APIs.

Step Descripción
Administra paquetes de productos de API

Crea paquetes de productos de API para agrupar los productos de tu API.

Nota: En la IU clásica de Edge y la API de monetización, los paquetes de productos se denominan paquetes de API.

Si deseas usar la API para administrar paquetes de productos de API, consulta los siguientes artículos:
Configure la política de registro de transacciones

Configura la política de registro de transacciones para cada uno de tus productos de API. La política de registro de transacciones define lo que te gustaría capturar en los registros de transacciones de un producto de API, incluidos los atributos personalizados.

Si deseas usar la API para configurar la política de registro de transacciones, consulta los siguientes vínculos:
Cómo administrar y publicar planes de tarifas

Crea un plan de tarifas para definir el enfoque de monetización para tus APIs. Por ejemplo, independientemente de si cobra una tarifa fija o variable por el uso de su API.

Para administrar planes de tarifas con la API, consulta los siguientes artículos:

Cómo comprar un plan de tarifas publicado Compra un plan de tarifas publicado y vence o cancela un plan de tarifas comprado, si lo deseas, con la API.
Configura la monetización en el portal para desarrolladores Configura la monetización en el portal para desarrolladores a fin de brindarles a los desarrolladores acceso de autoservicio a la suscripción al plan de tarifas, el procesamiento y la facturación automáticos de pagos, informes, catálogos de productos y otras opciones de configuración específicas de la monetización.

Administrar monetización

Después de configurar la monetización y monetizar tu API, puedes realizar uno o más de los pasos que se resumen en la siguiente tabla:

Step Descripción
Administra empresas y desarrolladores Administraste las empresas y los desarrolladores que usan tus APIs. Un desarrollador es una entidad única que se identifica de forma única mediante la dirección de correo electrónico. Una empresa es un conjunto de desarrolladores que se administran como una sola entidad.
Cómo crear informes Crea informes de saldos, ingresos y variaciones prepagados. En el caso de los desarrolladores prepagados, puedes conciliar informes de saldo prepagados con depósitos bancarios.
Cómo realizar ajustes de facturación Por ejemplo, realiza ajustes de facturación para corregir las discrepancias en tus registros.
Emitir créditos Si es necesario, emite créditos de desarrollador. Para un desarrollador prepagado, un crédito aparece como una reducción en el uso que aumenta el saldo prepagado del desarrollador en el futuro. En el caso de un desarrollador de pospago, el crédito aparece en una línea separada en una factura, lo que reduce el cargo.
Administra saldos de cuentas prepagadas Consulta el saldo actual de la cuenta prepaga y vuelve a cargar las cuentas prepagadas o configura la recarga automática con un proveedor de pagos externo.
Administra saldos de pospago con límites de crédito Si agregas una moneda admitida por una organización, puedes establecer un límite de crédito para un desarrollador de pospago. El límite de crédito se aplica a todos los desarrolladores con pospago de la organización. Además, puedes establecer el límite de crédito para un desarrollador de pospago individual. En este caso, el límite de crédito anula cualquier límite establecido para la moneda solo para el desarrollador especificado.
Posterior al reembolso Publica reembolsos para los desarrolladores por transacciones de compra.
Programa trabajos de monetización La monetización proporciona un programador de trabajos y un conjunto de trabajos que están programados previamente para ejecutarse en momentos designados. Administra la programación de trabajos de monetización con la API.
Cómo ver el estado de las transacciones Consulta el estado de las transacciones que se produjeron durante un intervalo de tiempo específico mediante la API.
Sincroniza datos de Apigee Edge con monetización Si Apigee se lo indica, vuelva a sincronizar los datos con la monetización para asegurarse de que los datos estén sincronizados. Puedes sincronizar lo siguiente: organización, productos de API, desarrolladores y aplicaciones.
Cómo borrar los datos de monetización de tu organización Te recomendamos que borres los datos de monetización de tu organización para borrar una organización de prueba o hacerlo.