Una API (en inglés Application Programming Interface, en español interfaz de programación de aplicaciones) es una parte de un programa que un sistema de software pone a disposición de otros programas para su conexión. Según Wikipedia, una API es una vía estandarizada mediante la cual un software externo puede acceder a las funciones y los datos de un sistema.
Qué puede hacer una API REST en el sistema de reservas de citas
- Consultar citas libres: las aplicaciones externas leen qué días y horas están disponibles para reservar.
- Crear citas: las reservas pueden desencadenarse por programación desde otras aplicaciones.
- Crear usuarios: las cuentas de cliente se crean a través de la API en el marco de la reserva.
- Consultar campos de formulario: la propia interfaz indica qué datos necesita una reserva.
- Recibir webhooks: eventos como nuevas reservas o cancelaciones se transmiten en tiempo real a sistemas externos mediante webhooks.
- Integración en sistemas CRM: los datos de clientes procedentes de las reservas pueden incorporarse automáticamente a los sistemas de gestión de clientes.
Características habituales
Las API web modernas trabajan con peticiones HTTP y JSON como formato de datos. En lugar de una contraseña se envía un token que el proveedor genera en el área de administración y puede renovar en cualquier momento. También es habitual un límite de peticiones por minuto, así como el funcionamiento entre servidores: el token debe permanecer en el propio servidor y no en un sitio web o una aplicación.
La API de Appointmind
Appointmind pone a disposición una API REST que refleja todo el proceso de reserva en seis llamadas:
| Llamada | Finalidad |
|---|---|
GET /schedules | Listar los calendarios de citas disponibles |
GET /reasons | Motivos de cita de un calendario con descripción y duración |
GET /days | Días en los que hay una cita libre |
GET /slots | Horas libres de un día |
GET /forms | Campos de formulario necesarios para la reserva |
POST /bookings | Reservar una cita |
El acceso se realiza mediante un token Bearer que se genera en el área de administración en Configuración → API; de forma predeterminada son posibles 300 peticiones por minuto. Encontrará un resumen en la página Módulo «API (interfaz)» y una guía paso a paso en Configurar y utilizar la API REST.