La API pública te permite conectar Encuadrado con otras herramientas para consultar horarios disponibles y crear reservas desde tu propia página web, agente, o integración de preferencia.
Tú generas la llave de acceso (API key) y un desarrollador (que puedes ser tú mismo) se encarga del resto. Con esto puedes tener el 100% del control sobre el flujo de agendamiento de tu consultante en tu propia página, e incluso medir conversiones a tu gusto.
Generar tu API Key
Para conseguir tu API Key debes:
Ir a Conexiones en el menú.
Ir a la pestaña Especializadas.
Buscar la tarjeta "Integración API" y hacer clic en ella.
Generar tu API key. ⚠️ Nota: La key se muestra una sola vez. Cópiala y guárdala en un lugar seguro. Si la pierdes, tendrás que generar una nueva.
Entregar la key al desarrollador a cargo de la integración.
💡 Por seguridad, no guardamos tu API Key, pero esta no permite hacer acciones confidenciales en tu nombre. Simplemente, quien tenga la key puede solicitar crear reservas en tu agenda y utilizar tus límites de la API, pero debe pasar la misma validación que cualquier consultante que visita tu perfil público.
Con la key, el desarrollador ya tiene todo para trabajar.
Funcionamiento de la API
La API ofrece dos acciones:
Consultar los horarios disponibles de un servicio: otro sistema puede mostrar tus horas libres, igual como se mostrarían en tu perfil público
Crear una reserva en ese servicio: otro sistema puede agendar a un consultante en tu agenda si pasa las mismas validaciones que tiene tu perfil (reglas de horarios, datos del paciente, términos y condiciones, entre otros).
Toda la información técnica (cómo autenticar, qué datos enviar y qué respuestas esperar) está en la documentación para desarrolladores: encuadrado.com/api/public/v1/docs.
Para consultar y reservar servicios con la API, deberás proveer al desarrollador el id público del servicio. Que se puede obtener de la url en tu navegador cuando vas a editar un servicio, como se muestra en la imagen:
⚠️ Importante: Hoy la API ofrece solo las dos acciones mencionadas. No permite, por ejemplo, editar una ficha clínica, emitir documentos tributarios ni gestionar pagos, y tampoco lo permitirá en el futuro. Sí consideraremos agregar funcionalidades que están relacionadas al agendamiento en sí mismo en base a la demanda de usuarios.
Validar tu dominio
Opcionalmente, puedes validar un dominio para redirigir al consultante una vez que termine un agendamiento con prepago. Esto puede servir, entre otros, para medir conversiones u ofrecer encuestas de satisfacción post pago.
Cuando tu consultante agenda una hora sin prepago mediante la API, nunca debe abandonar tu página web y la sesión queda agendada de inmediato. En cambio, si la hora es con prepago, la API solo confirma la reserva temporal del bloque horario, pero la sesión no queda agendada hasta que tu consultante pague en nuestra pasarela de pago. Por ello, si quieres redirigirlo de vuelta a tu página web una vez termine el pago puedes opcionalmente entregar una url de redirección al hacer la reserva por la API. Pero esta url debe pertenecer a tu dominio registrado en esta sección de Encuadrado:
Por ejemplo, si registras tu dominio "doctorpedro.cl" en Encuadrado, entonces puedes elegir redirigir a los consultantes a una url como "doctorpedro.cl/agendamiento-exitoso" al momento de crear la reserva mediante la API.
Si tienes sugerencias o solicitudes para extender la funcionalidad de la API, escríbenos a soporte@encuadrado.com o al chat, nuestro equipo te atenderá directamente 💬