Conceptos básicos acerca del uso de nuestra API
Dentro de ABC EVO, en la sección Integraciones accederán al card API donde encontrarán la Documentación para el Desarrollador que lista todas las opciones para obtener información desde evo, o para incluir información dentro del sistema.
Para poder acceder a los datos, solo será necesario generar el token con los permisos de acceso necesarios, ya que se trata de una API abierta. ⤵️
Aquí encontrarás guías prácticas, ejemplos y referencias detalladas para empezar a utilizar nuestra API de forma rápida, eficiente y segura.
Navega por la sección de introducción para comprender los primeros pasos o ve directamente a la Referencia de la API y explora todos nuestros puntos finales.
Algunos conceptos que necesitas conocer
ENDPOINT
Un endpoint API es una ubicación específica y direccionable dentro de una interfaz de programación de aplicaciones (API) donde un cliente puede enviar solicitudes a un servidor para acceder a recursos o realizar acciones. Funciona como el punto de interacción entre el cliente y el servidor, definiendo la URL o ruta precisa que los clientes utilizan para comunicarse con la API.
[GET] se utiliza para obtener información mediante la API
[POST] habitualmente se utilizan para incluir datos dentro de la plataforma
[PUT/ PATCH] habitualmente se utiliza para actualizar información ya existente
[DEL] se utiliza para borrar o eliminar registros
WEBHOOK
Un webhook es una función automática que permite a dos aplicaciones comunicarse a través de internet cuando ocurre un evento específico, enviando una notificación instantánea desde una aplicación a otra en lugar de que la segunda aplicación tenga que consultar periódicamente a la primera. Se conocen como "API basadas en eventos" y son eficientes para notificar eventos que desencadenarán acciones como por ejemplo la consulta de un ENDPOINT
Puedes enviar tus consultas directamente desde este link https://suporteapi.abcevo.com/
PRÓXIMAMENTE: ¡Una IA podrá evacuar tus dudas dentro de la documentación! 🤖
Debido a la necesidad de algunas empresas de exportar datos masivos de EVO, a veces datos de todas las unidades, ofrecemos la posibilidad de descargar archivos XLS o CSV directamente desde el navegador. Se proporciona la mayor cantidad de información posible en el archivo para que pueda utilizarla de la manera más adecuada para su negocio y sistema.
Cómo funciona
Para descargar el archivo con los datos deseados, solo tiene que copiar una de las URL que se indican aquí, pegarla en su navegador (Chrome es el más adecuado), cambiar los parámetros cuando sea necesario y pulsar la tecla ENTER para iniciar el proceso.
El navegador le pedirá una autenticación. En ese momento, deberá introducir el DNS y la clave secreta que encontrará en su EVO, en Configuración - Integraciones - Tarjeta EVO. Si desea acceder a los datos de todas las unidades al mismo tiempo, utilice la clave que encontrará en su módulo de Administración General.
Al hacerlo, el navegador guardará estos datos y no los volverá a solicitar en las próximas consultas. Si utiliza una computadora compartida para descargar los archivos, le recomendamos que utilice una ventana anónima para ello. De esta manera, el navegador no guardará la autenticación. Una vez hecho esto, el archivo comenzará a descargarse automáticamente.
Este flujo centraliza las operaciones relacionadas con clientes potenciales que aún no son miembros activos del gimnasio. Permite:
Registrar y actualizar clientes potenciales
Consultar clientes potenciales ya registrados
Gestionar servicios asociados a clientes potenciales
Consultar intereses registrados
Transferir clientes potenciales entre sucursales
Seguir el historial de transferencias
⚠️ ¿Cómo registrar un nuevo cliente mediante la API?
Al igual que en EVO, no es posible registra un cliente directamente, excepto mediante una migración. Es necesario registrar un prospecto primero y luego registrar una venta de una membresía para que sea convertido a cliente.
El flujo de ventas centraliza la gestión de las transacciones realizadas en el sistema, permitiendo consultar ventas anteriores, crear nuevas ventas y recuperar artículos asociados a una venta. Este flujo es fundamental para las integraciones de PDV, autoservicio (tótem) y comercio electrónico, garantizando el control y el seguimiento de las transacciones.
Principales funcionalidades:
Recuperar información detallada de una venta específica
Enumerar todas las ventas registradas en el sistema
Crear una nueva venta (incluyendo servicios, inscripciones o productos)
Consultar las ventas asociadas a una sesión específica (por ejemplo, terminal de autoservicio)
Obtener los artículos de una venta
Este flujo representa el proceso de autorización y habilitación de entrada de personas en dispositivos de control de acceso, como torniquetes, terminales manuales y sistemas automatizados. Permite:
Validación automática de la entrada de alumnos, clientes potenciales o visitantes
Registro de habilitaciones manuales por parte de empleados autorizados
Consulta y mantenimiento de dispositivos de acceso (torniquetes)
Actualización de la información de los dispositivos
Una API (Interfaz de Programación de Aplicaciones) es un conjunto de reglas y protocolos que permite a diferentes programas de software comunicarse y compartir datos y funcionalidades entre sí, actuando como un intermediario para agilizar el desarrollo y crear nuevas funcionalidades. Las APIs sirven para conectar sistemas, automatizar procesos, y permitir que una aplicación utilice las funciones de otro servicio sin conocer sus detalles internos.