Resumen

Una API monetizada es aquella en la cual su diseño y configuración tiene por objetivo generar ingresos mediante el cobro de dinero, incorporando un modelo de negocio cuyas definiciones delimitan cómo y cuánto pagarán los usuarios por consumir los datos y funcionalidades de una API, mediante distintos formatos de planes como los de suscripción y transacción.   

Con Vor-Tex la configuración de este tipo de funcionalidades cuenta con la posibilidad de establecer distintos límites de uso y acceso, incorporar mecanismos de autenticación, autorización y limitación del consumo según el tipo de plan o nivel de suscripción del usuario. A su vez, este tipo de APIs miden el consumo realizado y se integran con sistemas de facturación y gestión de pagos.  

En esta documentación se proporcionan las indicaciones para poder gestionar el módulo de monetización de Vor-Tex que incluye los siguientes contenidos: 

• La creación y gestión de planes de suscripción y transacción

• La configuración de la pasarela de pagos

• La configuración del sistema de facturación

• La consulta de consumos y facturas desde el portal de desarrolladores
  

Crear y configurar el plan

La creación y configuración de planes se realiza desde Configuraciones > Cuenta > Planes.

A su vez, en esta misma sección se puede proceder a crear un nuevo plan, seleccionando el botón verde “Crear Nuevo Plan” que se encuentra arriba a la derecha. De allí se abrirá una ventana sobre la cual se deben realizar las siguientes configuraciones: 

• Definir un nombre y una descripción

• Precio del plan (que estará relacionado al tipo del plan)

• Días de mora: refiere a los días que pueden transcurrir entre la fecha de cobro y la suspensión del plan contratado por el usuario; en ese período, el usuario podrá continuar utilizando las funcionalidades provistas por el tipo de plan seleccionado. 

• Seleccionar tipo de plan:

• Suscripción: este plan establece un límite de consumo determinado y se pueden crear distintos niveles de suscripción, por ejemplo (free, basic, premium, gold). 

• Transacción: este tipo de plan establece el cobro por cada consulta realizada a las APIs y/o métodos incluídos en el plan. 

• Frecuencia de facturación (que puede ser diaria, mensual o anual). 

• Agregar API o las APIs que estarán incluídas en el plan (puede ser una o más de una API) 

• Agregar método o métodos que estarán incluídos en el plan (puede ser uno o más de un método). 

• Guardar las configuraciones realizadas.
  

Configurar la asignación de planes a usuarios y grupos de usuarios

Una vez creado el tipo de plan seleccionado, es posible agregar los grupos previamente definidos. Para hacerlo, seleccione la opción “Agregar usuario/grupo” que se encuentra debajo del nombre del plan en la sección "Planes" dentro de la configuración de cuenta en el Workspace. Esto abrirá una ventana con la lista de grupos disponibles para su selección. Al guardar esta selección, el plan quedará configurado con los grupos agregados impactando sobre los usuarios que son parte de dichos grupos. En el ejemplo que se presenta a continuación, el grupo seleccionado es “Agentes”: 

Contratar un plan en el Portal de Desarrolladores de Vor-Tex. 

Completar el perfil del usuario

Para suscribirse a un plan, los usuarios deben hacerlo desde el Portal de Desarrolladores. Una vez dentro, pueden editar su perfil haciendo clic en el nombre de usuario en la esquina superior derecha. En esta sección, será necesario ingresar un correo electrónico de facturación, número de CUIT, dirección, y validar los datos ingresando la contraseña.

En segundo lugar, en el catálogo de APIs públicas o compartidas con el usuario, se debe seleccionar la API que se desea consumir.

A continuación, se pueden visualizar los distintos planes que incluyen esa API haciendo clic en el botón “Ver planes”, el cual abrirá una ventana con los planes disponibles, junto con sus características y especificaciones. En esta misma ventana, el usuario también tendrá la opción de cancelar un plan previamente contratado o cambiar de plan.

Consumir la API y monitorear los consumos realizados

Consultar factura y pagar

Dentro de la misma sección, al seleccionar la opción “Facturas” en el menú de la izquierda, el usuario podrá ver un listado de todas las facturas emitidas por los consumos realizados, ya sea en planes de suscripción o transacción. 

En este listado, se podrá verificar la fecha de facturación, el importe abonado, las fechas de creación y vencimiento, así como el estado actual de cada factura, que puede ser “Pendiente”, “Suspendido” o “Activo.” Además, el usuario podrá consultar los detalles de cada factura y acceder a la pasarela de pagos para realizar el pago, mediante los enlaces disponibles en cada columna correspondiente.