Monetización de APIs

Monetización de APIs

Resumen

Una API monetizada es aquella cuyo diseño y configuración tiene por objetivo generar ingresos mediante el cobro de dinero, con un modelo de negocio que define cómo y cuánto pagan los usuarios por consumir sus datos y funcionalidades, a través de planes de suscripción o por transacción. Con Vor-Tex se definen los planes, se establecen límites de uso por usuario o grupo, se mide el consumo y se integran proveedores de cobro y facturación. En este video ve cómo crear un plan en el Workspace, incluir una API, asignarlo a un grupo y cómo un desarrollador lo contrata desde el Portal de Desarrolladores.

Antes de comenzar

  • Los usuarios y grupos que consumirán las APIs deben existir en el Workspace. Vea Gestionar grupos de usuarios.
  • Los límites de consultas y de megabytes por usuario o grupo acotan el consumo de cada plan. Vea Configurar límites en métodos.
  • Para cobrar y facturar, configure el proveedor en Configuraciones › Monetización: Mercado Pago o Stripe para cobros y Tus Facturas App para facturas.

Crear y gestionar planes en el Workspace

Los planes se administran en Configuraciones › Cuenta › Planes. El listado muestra cada plan con su descripción, precio, tipo, días hasta mora, APIs y métodos incluidos, grupos, usuarios y frecuencia de facturación. Con Crear nuevo plan se abre el formulario:

Opción Monetización en Configuraciones Listado de planes con Editar y grupos Configuración del plan con los métodos incluidos
  • Nombre y descripción del plan.
  • Precio, que se interpreta según el tipo de plan.
  • Días hasta mora: días que pueden transcurrir entre la fecha de cobro y la suspensión del plan; en ese período el usuario sigue consumiendo.
  • Tipo: Suscripción establece un límite de consumo por período y permite varios niveles (free, basic, premium); Transacción cobra por cada consulta a las APIs o métodos incluidos.
  • Frecuencia de facturación: diaria, mensual o anual.
  • APIs y métodos incluidos en el plan: agregue una o más APIs completas, o solo algunos métodos.

Guarde el plan. Un plan incluye una API completa o métodos sueltos: no combine ambos para la misma versión de API.

Asignar el plan a usuarios y grupos

Debajo del nombre del plan, Agregar usuario/grupo abre la ventana para pasar usuarios o grupos de Disponibles a Agregados. Al guardar, el plan aplica a los usuarios de esos grupos. También puede definirse un plan por defecto para los usuarios que se registran en el Portal de Desarrolladores.

Asignación del plan a un grupo

Contratar un plan en el Portal de Desarrolladores

Completar el perfil del usuario

Para suscribirse a un plan, el usuario edita su perfil desde el nombre de usuario, arriba a la derecha, e ingresa el correo de facturación, el tipo y número de documento y la dirección, validando con su contraseña.

Datos de facturación del usuario en el portal Validación de los datos con la contraseña

Contratar un plan

En el catálogo de APIs, al abrir una API monetizada el botón Ver planes muestra los planes disponibles con sus características. Desde esa ventana el usuario contrata un plan, cancela uno contratado o cambia de plan. Si hay una pasarela de pagos configurada, el portal lo lleva a elegir el medio de pago y completar sus datos; obtiene un código de pago y un comprobante.

Mis planes con las opciones de contratar, cancelar o cambiar Plan contratado en Mis planes

Consumir la API y monitorear los consumos

Contratado el plan, el usuario prueba los métodos y consume la API desde el portal. En Mis planes ve los planes contratados; en Consumos, las consultas realizadas a las APIs de los planes por transacción; en Facturas, las facturas emitidas con su fecha, importe, vencimiento y estado (Pendiente, Suspendido o Activo), con acceso a la pasarela para pagarlas. Si las facturas no se pagan y se supera el período de mora, el plan se suspende hasta cancelar los pagos pendientes.

Documentación del método en el portal Ejecutar el método y ver la respuesta Consumos contabilizados por el plan Facturas con los enlaces de pago

Resultado esperado

El plan queda creado con sus APIs y asignado al grupo; el desarrollador lo ve en la API, lo contrata y lo encuentra en Mis planes. En el video, sin pasarela de pagos configurada, la contratación se completa sin pasar por un cobro.

Errores frecuentes

  • El desarrollador no ve el botón Ver planes: el plan no incluye esa API o método, o está asignado a un grupo del que el usuario no forma parte.
  • Al contratar, el portal pide completar el perfil: faltan los datos de facturación del usuario.
  • El plan no se guarda: hay campos obligatorios vacíos, o se agregó una API y también uno de sus métodos.
  • El consumo no aparece en Consumos: solo se contabilizan los planes por transacción.

Artículos relacionados