Conectar sus herramientas con la API
La API permite que una aplicación de terceros acceda de forma programática a los datos de su club: miembros, calendarios, reservas y facturación. Se activa en dos clics y se protege mediante una clave, una lista de direcciones autorizadas y un seguimiento del consumo.
Saber si la API le concierne
La API está dirigida a un desarrollador, no a un responsable de club. Sirve para conectar su cuenta con un software que usted encarga desarrollar o configurar: un sitio web a medida, una herramienta de contabilidad, una pantalla de visualización propia o una pasarela hacia otro sistema.
Para las necesidades habituales — recuperar la lista de socios, actualizar suscripciones de forma masiva, transmitir cifras a la junta — los módulos de importación, exportación e informes responden a la necesidad sin escribir una sola línea de código.
La API se ofrece en versión beta: su funcionamiento todavía puede evolucionar.
Activar la API y recuperar su clave
- Vaya a Administración›Configuración›API BETA.
- Active Activar el módulo API y haga clic en Guardar.
- Se muestra su Clave API: cópiela con el botón Copiar y transmítala únicamente a la herramienta que conecta.
La clave se transmite en el encabezado HTTP X-API-Key de cada solicitud. Las llamadas deben realizarse obligatoriamente en HTTPS; no se acepta ninguna solicitud no cifrada.
Proteger la clave
Conviene recordar algunas buenas prácticas a la herramienta o al proveedor que la utiliza:
- no guarde nunca la clave en un repositorio de código; guárdela en un archivo de configuración fuera del repositorio o en un gestor de secretos;
- restrinja las direcciones autorizadas en cuanto la herramienta llame desde un servidor fijo;
- regenere la clave ante la menor duda: publicación accidental, filtración de registros o fin de la misión de un proveedor.
El botón Regenerar solicita confirmación y luego invalida la clave anterior de inmediato. Todas las aplicaciones que la utilizaban dejan de funcionar hasta que hayan recibido la nueva: avíselas antes de hacer clic.
Restringir el acceso por dirección IP
Active la Restricción por dirección IP: solo se aceptan las solicitudes procedentes de las direcciones que usted indique, con un límite de 10 direcciones IPv4. Introduzca cada dirección y valide con Añadir; su dirección actual se muestra en pantalla para ayudarle.
Es la protección más eficaz y la que más a menudo se pasa por alto: incluso si se divulga, una clave restringida a la dirección de su proveedor sigue siendo inutilizable en otro lugar.
Seguir el consumo
La pantalla muestra de forma continua lo que consume su clave:
- Uso este minuto y Uso hoy, cada una comparada con su límite cuando hay un límite configurado;
- Estadísticas de uso: Esta semana, Este mes, Total y Última solicitud.
Más allá de los límites indicados, las solicitudes adicionales se rechazan temporalmente. Un contador que roza permanentemente su límite suele indicar una herramienta mal configurada, que solicita los mismos datos en bucle en lugar de almacenarlos en caché.
La fecha de la última solicitud también es útil en el sentido contrario: una clave activada pero que no se ha usado desde hace meses es una clave que debe desactivarse.
Descubrir qué permite la API
La documentación completa, con los parámetros y ejemplos de llamadas, se muestra en la parte inferior de la pantalla del módulo. En líneas generales:
- Usuarios: es el único recurso modificable. Puede listar, consultar, crear, modificar y eliminar cuentas.
- Configuración: suscripciones, perfiles, grupos y categorías de edad se pueden consultar, pero solo se configuran desde la aplicación.
- Reserva: calendarios, franjas horarias disponibles, reservas y etiquetas se pueden consultar.
- Facturación: cuentas de facturación, pedidos y pagos se pueden consultar.
