Conectar sus herramientas con la API
La API permite que una aplicación externa acceda a los datos de su Organización de forma programática: 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á destinada a un desarrollador, no a un responsable de Organización. Sirve para hacer dialogar su cuenta con un software que usted encarga programar o configurar: un sitio web a medida, una herramienta de contabilidad, una pantalla de información propia, una pasarela hacia otro sistema.
Para las necesidades habituales — recuperar la lista de socios, actualizar Suscripciones en masa, transmitir cifras a la junta directiva — los módulos de importación, exportación e informes responden sin escribir una sola línea de código.
La API se ofrece en versión beta: su funcionamiento aún puede evolucionar.
Activar la API y obtener su clave
- Diríjase a Administración›Configuración›API BETA.
- Active Activar el módulo API y luego haga clic en Guardar.
- Su Clave API aparece en pantalla: cópiela con el botón Copiar y facilítela únicamente a la herramienta que está conectando.
La clave se transmite en el encabezado HTTP X-API-Key de cada petición. Las llamadas se realizan obligatoriamente en HTTPS; no se acepta ninguna petición sin cifrar.
Proteger la clave
Conviene recordar algunos hábitos a la herramienta o al proveedor que la utiliza:
- no depositar nunca la clave en un repositorio de código; almacenarla en un archivo de configuración fuera del repositorio o en un gestor de secretos;
- restringir las direcciones autorizadas en cuanto la herramienta realice llamadas desde un servidor fijo;
- regenerar la clave ante la menor duda: publicación accidental, filtración de registros, fin del contrato de un proveedor.
El botón Regenerar pide confirmación y luego invalida la clave anterior de inmediato. Todas las aplicaciones que la utilizaban dejan de funcionar hasta que reciban 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 peticiones procedentes de las direcciones que indique, hasta un máximo 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 más a menudo descuidada: incluso divulgada, 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 se ha configurado un límite;
- Estadísticas de uso: Esta semana, Este mes, Total y Última solicitud.
Por encima de los límites indicados, las peticiones adicionales se rechazan temporalmente. Un contador que roza permanentemente su techo suele indicar una herramienta mal ajustada, que solicita los mismos datos en bucle en lugar de guardarlos en caché.
La fecha de la última petición es útil en el sentido contrario: una clave activada pero nunca utilizada desde hace meses es una clave que conviene desactivar.
Descubrir lo que permite la API
La documentación completa, con los parámetros y ejemplos de llamada, 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.
