Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. 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 Edge no incluye inicialmente 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 para tu organización de Apigee.
Después de comprar la monetización, debes realizar las siguientes tareas:
- Trabaja con el equipo de configuración de Apigee para completar la configuración inicial de la monetización. Consulta Configuración inicial con Apigee.
- Configura la monetización. Consulta Cómo configurar la monetización.
- Monetiza tus APIs. Consulta Monetiza tus APIs.
- Administra la monetización mediante la creación de informes, la administración de saldos de cuentas, etc. Consulta Cómo administrar la monetización.
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. Según tus datos, el equipo de configuración configurará 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 Cuentas prepagadas frente a cuentas de pospago.
- Si quieres datos detallados o resumidos de la monetización 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 con los desarrolladores, las aplicaciones y los productos de API que creaste 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 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 en tu organización de Apigee.| Step | Descripción |
|---|---|
| Edita 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 tu organización, según corresponda. Por ejemplo, es posible que debas actualizar el tipo de facturación, la configuración de moneda o el modelo de impuestos. |
| 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 admitidas por tu organización y agregar o borrar las que admite (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 Programa trabajos de monetización. |
| Especifica los Términos y Condiciones | De manera opcional, puedes agregar términos y condiciones al perfil de tu organización antes de publicar los 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, debes especificar 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 en el tiempo. |
| Aplica límites de monetización | Adjunta la política 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:
|
| Configura las notificaciones | Configura las notificaciones para notificar a los desarrolladores o proveedores de la API sobre un evento específico, como un plan de tarifas recién publicado. |
Monetiza tus APIs
Cuando monetizas las 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 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 posterior). Los desarrolladores pueden registrar sus apps para usar un paquete de productos de API únicamente mediante la compra de uno de los planes de tarifas vigentes en la actualidad. Si un paquete de productos de API no tiene un plan de tarifas publicado actualmente vigente, el paquete no se monetiza.
En la siguiente tabla, se resumen los pasos necesarios para monetizar tus APIs.
| Step | Descripción |
|---|---|
| Administrar paquetes de productos de API | Crea paquetes de productos de API para agrupar tus productos de API. Nota: En la IU clásica de Edge y en 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:
|
| Configura 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 deseas 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: |
| 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 tasa fija o variable por el uso de tu API. Para administrar planes de tarifas con la API, consulta los siguientes vínculos: |
| Compra un plan de tarifas publicado | Compra un plan de tarifas publicado y, si lo deseas, vence o cancela un plan de tarifas comprado con la API. |
| Configura la monetización en el portal para desarrolladores | Configura la monetización en tu 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 de pagos automáticos, los informes, los catálogos de productos y otros parámetros de configuración específicos 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 grupo de desarrolladores administrados como una sola entidad. |
| Cómo crear informes | Crea informes de saldo prepagado, ingresos y variación. 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, puedes realizar ajustes de facturación para corregir las discrepancias en tus registros. |
| Emitir créditos | Emite créditos de desarrollador, si es necesario. Para un desarrollador prepagado, el 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 como una línea separada en una factura, lo que reduce el cargo. |
| Administra saldos de cuentas prepagados | Consulta el saldo de cuenta prepagado actual y vuelve a cargar las cuentas prepagadas o configura la recarga automática con un proveedor de pagos de terceros. |
| Administra 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 de pospago. El límite de crédito se aplica a todos los desarrolladores 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 a los reembolsos | Publicar 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 están programados previamente para ejecutarse en momentos designados. Administrar la programación de trabajos de monetización con la API |
| Cómo consultar 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 te lo indica, vuelve a sincronizar los datos con la monetización para garantizar 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 borrar los datos de monetización de tu organización para borrar una organización de prueba o una existente. |