Primeros pasos con la EVO API

Definición

API significa Application Programming Interface (Interfaz de Programación de Aplicaciones). En el contexto de APIs, la palabra Aplicación se refiere a cualquier software con una función específica. La interfaz puede entenderse como un contrato de servicio entre dos aplicaciones. Este contrato define cómo se comunican utilizando solicitudes y respuestas. La documentación de sus respectivas APIs contiene información sobre cómo los desarrolladores deben estructurar estas solicitudes y respuestas, como esta API Reference.

La EVO API es una API REST. REST significa Transferencia Representacional de Estado. REST define un conjunto de funciones como GET, PUT, DELETE, entre otras, que pueden utilizarse para acceder a los datos del servidor. El solicitante y los servidores intercambian datos utilizando HTTP.

La característica principal de una API REST es la ausencia de estado. Esto significa que los servidores no guardan datos del cliente entre solicitudes. Las solicitudes al servidor son similares a las URLs que escribes en el navegador para visitar un sitio web. La respuesta del servidor corresponde a datos simples, sin la renderización gráfica típica de una página web.

Cómo usar la EVO API

Para comenzar a usar la EVO API, es necesario:

Obtener una clave de API para poder realizar solicitudes.

Probar la API utilizando un cliente de API HTTP, donde puedes estructurar solicitudes de API fácilmente usando las claves de API obtenidas.

A continuación detallaremos ambos puntos.

Obteniendo las claves de la EVO API

Para obtener las claves necesarias para realizar solicitudes de API, es necesario crearlas dentro del propio EVO. Es importante entender que existen dos tipos de claves de API que pueden crearse:

Clave única de sucursal: clave creada en la instancia de una sucursal con permisos y acceso solo a los datos de esa sucursal;

Clave multisucursal: clave creada en una instancia de ADM General con acceso solo a llamadas que contienen el parámetro idbranch.

La ruta para la creación de las claves en EVO es Configuraciones - Integraciones y acceder al card EVO en la sección API:

Al hacer clic en el card EVO se presenta la siguiente pantalla:

92e576e4fc02a2495bff23c9eacb8687ec2d47b430018d4ab29b9bb410f9ee62-image.png

1- Lista en orden alfabético con todos los Tokens de integración creados.

2- Campo de búsqueda para encontrar el nombre del Token.

3- NUEVO TOKEN: botón para crear nuevos Tokens.

4- Acciones: editar y eliminar los Tokens creados.

5- Historial de eliminación de Tokens.

Crear un token

Haz clic en NUEVO TOKEN.

7cd71a776f3bc29226e1ded9db13e04fd513f16e4c43e8033b0aec0af8d2892e-image.png

Se mostrará la ventana de solicitud de usuario y contraseña del sistema EVO.

9763b4018a6f60017c3dc737f16bccab9af7e4e46ad7462a3f597f70ca4cfe99-image.png

Haz clic en CONFIRMAR.

Completa el Nombre del Token, el Nombre del solicitante y el WhatsApp.

59bae093b67bf72c44f513954d177c53136f3663260b22c6d9a88c4203debf9f-image.png

Completa la información de uso.

Propósito de uso: indica la finalidad de la integración seleccionando las opciones existentes.

Uso interno/Proveedor socio: al seleccionar la opción Proveedor/Socio, informa el socio, el nombre del proveedor, correo electrónico o teléfono.

🚧 Si el proveedor no está en la lista, es necesario solicitar el registro en este formulario.

e872749cf3abca9f860e40895025e5fd31dba3a751c6e57874f9e8299400d312-image.png

Completa los permisos.

Los permisos seleccionados deben estar relacionados con los datos a los que la clave podrá acceder.

Cada uno de estos permisos está vinculado a endpoints y para verificarlos haz clic en la flecha para expandir.

3b4b17acffb047191c4ca8d071680c504406dec42288d239da0c28d7faa05e01-image.png

📘 Lee este artículo para entender a qué endpoint se refiere cada permiso.

Después de seleccionar todas las opciones haz clic en CREAR TOKEN.

Después de crear el token, se mostrarán las claves para utilizar en la autenticación:

Tu DNS, que funcionará como usuario;

Y un token, que funcionará como contraseña.

2eb66af3cf47c337a7e4c1f6b94eb26d25bcedf98dd26ca47a688c9a91ba481b-image.png

Editar y eliminar token

Después de crear el token, puedes editar los permisos o eliminar los tokens existentes. Solo debes hacer clic en el ícono de "editar".

0eada00798d2b7a0d8c12f1f0fe3d13091e6860233b69df414f52ffb15cfdf8d-image.png

Probando la EVO API en un cliente de API HTTP

El método de autenticación de la EVO API es Basic Authentication, lo que significa que para realizar llamadas a la API es necesario un usuario y una contraseña: el DNS como usuario y la clave aleatoria única creada en el último paso como contraseña.

Los clientes de API HTTP que disponemos para que puedas probar llamadas de API son este, el Api Reference, donde podrás navegar por las diferentes entidades y sus endpoints, pudiendo probarlos. También está el Swagger, donde podrás hacer lo mismo en una interfaz más simple.

Para realizar las pruebas de llamadas solo tendrás que proporcionar el usuario y la contraseña y completar los parámetros definidos en cada endpoint. Tanto este canal como Swagger ofrecen un entorno sandbox donde podrás ver las respuestas de tus llamadas de prueba.

"Enviar"

¿Cuáles son las entidades de la EVO API?

Las entidades de API son las diferentes áreas del producto sobre las cuales puedes realizar llamadas de API. A continuación se presenta un resumen de las principales entidades de la EVO API:

Activities: endpoints para obtener clases existentes, inscribir alumnos en ellas, crear clases de prueba y ver listas de clases;

Configuration: endpoints para obtener configuraciones de la unidad, gateway, banderas de tarjeta, traducción de tarjeta y ocupación;

Employees: endpoints para obtener, agregar, actualizar y eliminar colaboradores;

Entries: endpoints para obtener entradas;

Invoices: endpoints para obtener facturas por fecha;

MemberMembership: endpoints para obtener resúmenes de contratos de clientes;

Members: endpoints para obtener, actualizar y autenticar clientes;

Memberships: endpoints para obtener contratos y sus categorías;

Prospects: endpoints para obtener, agregar y actualizar oportunidades;

Receivables: endpoints para obtener y marcar cuentas por cobrar, obtener centros de costo;

Sales: endpoints para obtener, crear ventas y retornar ítems por venta;

Service: endpoints para obtener servicios;

Voucher: endpoints para obtener vouchers;

Webhook: endpoints para crear, listar y eliminar webhooks;

Workout: endpoints para obtener listas de entrenamientos.

¡Y muchas más!
Consulta la lista completa de entidades en nuestra API Reference.

Paginación de la EVO API

El estándar de paginación para las respuestas de llamadas de la EVO API es de 50 registros. Algunos endpoints excepcionalmente permiten 100 registros en la respuesta.

Para controlar la paginación de las respuestas de tus llamadas, utiliza los parámetros take y skip.

El parámetro total en el header indica la cantidad total de elementos disponibles para paginación en la API.

Limitaciones de solicitudes (Rate Limits)

Para garantizar el rendimiento y la estabilidad del sistema, la EVO API implementa límites de solicitudes (rate limits). Estos límites controlan el número de llamadas que pueden realizarse dentro de intervalos de tiempo específicos, basándose en los siguientes criterios:

Por minuto (por IP): Límite de 40 solicitudes por minuto. Al alcanzarlo se retornará el estado 429 (Too Many Requests), y se deberá esperar 1 minuto para realizar nuevas llamadas.

💎 Clientes de API PRO no tienen el límite por minuto.

Por hora (por clave de API): Límite de 10.000 solicitudes por hora. Si se supera, la clave será bloqueada por 1 hora.

Por hora (por DNS): Límite de 20.000 solicitudes por hora para todas las claves asociadas al mismo DNS. Al excederlo, todas las claves de la academia quedan bloqueadas por 1 hora.

Nota: Durante el horario de 0h a 5h, los límites no se aplican, permitiendo ejecuciones de alto volumen, como solicitudes en lote.

Para más información y buenas prácticas sobre cómo evitar bloqueos, consulta la sección completa de Límites de solicitudes.

Buenas prácticas de uso de la EVO API

Por último, aquí hay algunas buenas prácticas para el uso efectivo de la EVO API.

Primero que nada, es importante dejar claro que la EVO API fue diseñada para usarse en backend, ya que Basic Authentication requiere las claves de API para las solicitudes.

🚧 Esto significa que usarla en frontend puede exponer métodos y datos de tu(s) academia(s). Siempre impleméntala en backend.

Además, es esencial saber que la EVO API consume datos de producción, lo que compite con los procesos normales de uso del propio EVO. Por lo tanto, se recomienda realizar solicitudes de API pesadas durante la madrugada, entre la 01:00 y las 06:00, para evitar lentitud en el uso del EVO por parte de la(s) academia(s).

Primeros pasos con la EVO API

Definición#

Cómo usar la EVO API#

Obteniendo las claves de la EVO API#

Crear un token#

Editar y eliminar token#

Probando la EVO API en un cliente de API HTTP#

¿Cuáles son las entidades de la EVO API?#

Paginación de la EVO API#

Limitaciones de solicitudes (Rate Limits)#

Buenas prácticas de uso de la EVO API#