API y Webhooks
Con la API y los webhooks de Salonnare conectas tu salón con otro software: tu programa de contabilidad, tu propia web, un servicio de newsletter o un panel a medida. No necesitas ser desarrollador para entender qué hacen -- esta página lo explica con calma.
Esta función todavía lleva la etiqueta Próximamente en la app: por ahora no puedes crear claves API ni webhooks. Si abres Ajustes > API y Webhooks, solo verás un aviso de que la función está en camino. Esta página describe cómo funcionará cuando esté disponible.
¿Qué es una API?
Una API (Application Programming Interface) es un acuerdo que permite que dos programas se comuniquen entre sí. Donde tú pulsas un botón en la app para cargar una cita, otro programa puede solicitar los mismos datos a través de la API -- de forma automática y sin intervención manual.
Ejemplos prácticos para un salón:
- Tu software de contabilidad recupera automáticamente tus ingresos cada noche.
- Tu propia web muestra tus servicios y precios, directamente desde Salonnare.
- Un socio de integración sincroniza tu lista de clientes.
El acceso a la API se realiza mediante una clave API: un código secreto que demuestra que la solicitud viene de ti. Trata esa clave como una contraseña.
Crear una clave API
- Ve a Ajustes -> API y Webhooks.
- En la pestaña Claves API, haz clic en Nueva clave.
- Dale a la clave un nombre reconocible (por ejemplo "Contabilidad") y elige los permisos: Solo lectura, Lectura + escritura o Acceso completo. Por ahora, una clave API solo puede recuperar datos, sea cual sea el nivel de permisos elegido; una clave de solo lectura nunca podrá hacer más que eso, de todos modos.
- Copia la clave de inmediato y guárdala en un lugar seguro. Por motivos de seguridad, Salonnare muestra la clave completa una sola vez.
¿Sospechas que una clave se ha filtrado? Elimínala enseguida -- toda integración que use esa clave se detiene de inmediato.
¿Qué es un webhook?
Un webhook es lo contrario de la API. En lugar de que tú recuperes datos, Salonnare envía automáticamente un mensaje a una dirección (URL) tuya en cuanto ocurre algo. El otro software ya no tiene que preguntar constantemente "¿hay algo nuevo?" -- recibe un aviso por sí solo.
Salonnare puede enviar estos seis eventos:
booking.created-- un miembro del equipo crea una cita en la aplicaciónbooking.updated-- un miembro del equipo modifica una cita en la aplicación (también un cambio de estado a completada o ausencia)booking.cancelled-- un miembro del equipo cancela una cita en la aplicaciónpayment.received-- un miembro del equipo finaliza un cobro en la cajaclient.created-- un miembro del equipo crea un cliente en la aplicaciónclient.updated-- un miembro del equipo modifica los datos de un cliente en la aplicación
Cada evento procede de una acción realizada en la aplicación. Una reserva online a través de tu página de reservas o de Google, un cliente que cancela por su cuenta, una lista de espera convertida, una serie periódica, un tratamiento por sesiones y un cliente que se crea a sí mismo en la página de reservas no envían (todavía) ninguna notificación. Coméntalo con tu socio de integración: puede recuperar las citas que falten consultando periódicamente la lista de citas.
Configurar un webhook
- Ve a Ajustes -> API y Webhooks y abre la pestaña Webhooks.
- Haz clic en Nuevo webhook.
- Introduce la URL a la que Salonnare enviará las notificaciones (te la facilita tu socio de integración o desarrollador).
- Elige los eventos a los que quieres reaccionar.
- Guarda. Después puedes revisar los registros de envío para comprobar que las notificaciones llegan correctamente.
El secreto que Salonnare usa para firmar los mensajes se muestra en el momento en que guardas el webhook -- guárdalo de forma segura de inmediato, igual que una clave API, porque Salonnare no volverá a mostrarlo. Si lo pierdes, haz clic en el icono de actualizar junto al webhook (Solicitar un nuevo secreto); verás un nuevo secreto una sola vez. El secreto anterior deja de funcionar a partir de ese momento, así que también hay que actualizar el lado receptor.
Cada notificación de webhook lleva una firma con la que el receptor puede verificar que el mensaje procede realmente de Salonnare.
Trabajar con seguridad
- Nunca compartas las claves API públicamente (ni en correos, ni en capturas de pantalla, ni en código publicado en línea).
- Da a cada integración solo los permisos que realmente necesita -- elige solo lectura cuando sea posible.
- Elimina las claves y webhooks que ya no uses.
Como Salonnare procesa tus datos en la UE y tú decides qué integraciones tienen acceso, mantienes el control total de tus datos. ¿Necesitas ayuda con una integración? No dudes en contactarnos a través de la página de soporte.
¿Eres desarrollador y buscas los detalles técnicos (autenticación, endpoints, campos, códigos de error, verificación de firma)? Consulta la Referencia de la API -- esa página está en inglés, porque está pensada para desarrolladores.