Pasos para configurar la monetización

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

Antes de comenzar

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

  • Crea una cuenta de Apigee Edge, como se describe en Crea una cuenta de Apigee Edge.
  • Monetización de compras En un principio, Edge no incluye la API de monetización ni la integra 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 en Edge para tu organización de Apigee.

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

Configuración inicial con Apigee

Trabaja con el equipo de configuración de Apigee Edge para completar la configuración inicial de la monetización. En función de tus entradas, el equipo de configuración establecerá lo siguiente:

  • Si tu organización es una empresa de telecomunicaciones.
  • Tipo de facturación que deseas admitir para los desarrolladores que compran tus planes de tarifas: prepago, pospago o ambos. Consulta Cuentas prepagas y pospagas.
  • Si deseas datos detallados o de resumen extraídos de la monetización en tu sistema de contabilidad y el formato de datos requerido.
  • Dirección de respuesta de correo electrónico 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 con los desarrolladores, las aplicaciones y los productos de API que creaste con Apigee Edge. Es posible que el equipo de asistencia de Apigee te solicite que sincronices tu organización en el futuro. Para obtener más información, consulta Cómo sincronizar los datos de Apigee Edge con la monetización. No sincronices los datos de monetización, a menos que Apigee te lo indique.

Configura la monetización

En la siguiente tabla, se resumen los pasos necesarios para configurar la monetización de tu organización de Apigee.
Paso 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 ella, según corresponda. Por ejemplo, es posible que debas actualizar el tipo de facturación, la configuración de la moneda o el modelo de impuestos.

Cómo administrar 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 quitar monedas admitidas (para reflejar las monedas 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, la tarea se ejecuta todos los días a 1 segundo después de la medianoche. Para obtener más información, consulta Cómo programar trabajos de monetización.
Especifica los Términos y Condiciones De manera opcional, puedes agregar términos y condiciones a tu perfil de organización antes de publicar los planes de tarifas. Después de publicar un plan de tarifas, la versión actual de los términos y condiciones se muestra en el portal para desarrolladores.

Nota: Los Términos y Condiciones no se encuentran en el perfil de tu organización. En el perfil de tu organización, especificas la ubicación (URL pública) de los Términos y Condiciones. Puedes agregar varias versiones de los términos y condiciones para reflejar los cambios a lo largo del tiempo.
Aplica los límites de monetización Adjunta la política de MonetizationLimitsCheck a los proxies de API para aplicar 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 se suscribió al plan de tarifas.
  • El desarrollador superó el volumen de transacciones del plan de tarifas al que se suscribió.
  • Se alcanzó el saldo de la cuenta prepagada o el límite de crédito pospago del desarrollador.
Configura las notificaciones Configura notificaciones para informar 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, agrupas 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 un paquete de productos de API hasta que publiques un plan de tarifas para el paquete (con una fecha de inicio de la fecha actual o una fecha futura). Los desarrolladores pueden registrar sus apps para usar un paquete de productos de API solo si compran uno de los planes de tarifas vigentes. Si un paquete de productos de API no tiene un plan de tarifas publicado que esté vigente, el paquete no se monetiza.

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

Paso Descripción
Administra paquetes de productos de API

Crea paquetes de productos de API para agruparlos.

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

Para usar la API y administrar paquetes de productos de API, consulta lo siguiente:
Configura la política de grabación 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 deseas capturar en los registros de transacciones de un producto de API, incluidos los atributos personalizados.

Para usar la API y configurar la política de registro de transacciones, consulta lo siguiente:
Administra y publica planes de tarifas

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

Para administrar planes de tarifas con la API, consulta lo siguiente:

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 tu portal de desarrolladores para brindar a los desarrolladores acceso de autoservicio a la suscripción de planes de tarifas, el procesamiento de pagos automáticos y facturación, informes, catálogos de productos y otras configuraciones específicas de 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:

Paso Descripción
Administra empresas y desarrolladores Administrar las empresas y los desarrolladores que usan tus APIs Un desarrollador es una sola entidad, que se identifica de forma única por la dirección de correo electrónico. Una empresa es un grupo de desarrolladores que se administra como una sola entidad.
Cómo crear informes Crear informes de saldos, ingresos y variaciones de prepago En el caso de los desarrolladores de prepago, puedes conciliar los informes de saldo prepagado con los depósitos bancarios.
Realiza ajustes de facturación Por ejemplo, puedes realizar ajustes de facturación para corregir discrepancias en tus registros.
Créditos de los problemas Emite créditos para desarrolladores, si es necesario. En el caso de un desarrollador prepago, 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, un crédito aparece como una línea independiente en una factura, lo que reduce el cargo en una factura.
Administra los saldos de las cuentas prepagas Consulta el saldo actual de la cuenta prepagada y recárgala, o bien configura la recarga automática con un proveedor de pagos externo.
Administra los saldos de pospago con límites de crédito Cuando agregas una moneda admitida para una organización, puedes establecer un límite de crédito para un desarrollador pospago. El límite de crédito se aplica a todos los desarrolladores de pospago de la organización. Además, puedes establecer el límite de crédito de 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.
Publica reembolsos Publica reembolsos a 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 se programan previamente para ejecutarse en horarios designados. Administra la programación de trabajos de monetización con la API.
Consulta el estado de las transacciones Consulta el estado de las transacciones que se produjeron durante un período específico mediante la API.
Cómo sincronizar datos de Apigee Edge con la monetización Si Apigee te solicita que lo hagas, vuelve a sincronizar los datos con la monetización para asegurarte de que 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 Es posible que desees borrar los datos de monetización de tu organización para borrar una organización de prueba o eliminarla.