Cada vez más, los centros educativos dependen de múltiples sistemas para gestionar a los alumnos, el personal y las actividades, y mantener esos datos sincronizados ha implicado tradicionalmente la introducción manual de datos o soluciones alternativas personalizadas. La API pública SchoolsBuddy cambia esta situación, ofreciendo a los centros una forma segura y directa de conectar SchoolsBuddy con las herramientas que ya utilizan.

Diseñada en torno a la gestión básica de usuarios y actividades, la API ofrece a los equipos de desarrollo una forma escalable y flexible de interactuar con SchoolsBuddy mediante programación, con un acceso estrictamente controlado por los superadministradores de la organización para mantener segura cada integración.

Descripción general

La API pública SchoolsBuddy está diseñada para reducir la entrada manual de datos y mantenerlos sincronizados en todo el ecosistema de su escuela. Está pensada para equipos técnicos, generalmente administradores principales de la organización y sus desarrolladores, que necesitan automatizar tareas administrativas masivas o integrar SchoolsBuddy con una plataforma MIS/SIS personalizada o desarrollada internamente.

Qué hay de nuevo

La API incluye puntos de acceso para entidades de datos principales como Estudiantes, Contactos, Personal, Eventos, Ubicaciones, Grupos y Preferencias, así como registros de reserva instantánea. Las capacidades clave incluyen:

• Gestión de ubicaciones: Cree y gestione ubicaciones específicas que se utilizarán en todas las actividades escolares.
• Exportación de datos: Exporte las actividades SchoolsBuddy por alumno o evento para una visualización e integración perfectas con otros sistemas internos.
• API de asistencia: Lea y escriba registros de asistencia a eventos mediante programación para mantener sincronizado en tiempo real todo el ecosistema de su escuela.
• Inscripción de estudiantes externos: Añada y gestione a los estudiantes que no figuran en el SIS de la escuela, como los preadmitidos, los asistentes a la escuela de verano o los participantes en programas de enriquecimiento externos.
• Registros de personal y facilitadores: Gestionar el personal externo que no figura en el SIS, incluidos los facilitadores invitados, los entrenadores externos, los líderes de viaje o el personal del distrito.
• Integración virtual: Actualice y mantenga los identificadores de reuniones en línea de los docentes para las plataformas de comunicación digital elegidas por su escuela.
• Creación y gestión de: suscripciones a preferencias y reservas instantáneas, grupos para la programación de eventos deportivos o excursiones, grupos para el cobro de cuotas y clases por asignatura para reuniones de padres y profesores (solo necesario si no dispone de otra fuente de importación de datos).

Navegación paso a paso

Configuración del cliente API

Configuración de administración > Integraciones > API pública

1. Confirma que has iniciado sesión como Superadministrador de la organización, ya que este rol es necesario para otorgar acceso a la API.
2. Siga la guía de configuración específica para registrar su cliente API y generar las credenciales.
3. Configure la autenticación OAuth 2.0 para su integración utilizando las credenciales proporcionadas.
4. Antes de realizar tus primeras llamadas, revisa los puntos finales disponibles (Estudiantes, Contactos, Personal, Eventos, Ubicaciones, Grupos, Registros) en la documentación de Swagger.
5. Pruebe su integración con un conjunto de datos que no sea de producción, siempre que sea posible, antes de implementar la sincronización de datos en tiempo real.

Las instrucciones completas de configuración están disponibles aquí: Cómo configurar la API pública SchoolsBuddy .

Consejos y buenas prácticas

• La seguridad es lo primero: utilice el estándar de autenticación OAuth 2.0 proporcionado para garantizar un acceso seguro a sus datos.
• Documentación de revisión: Los desarrolladores deben consultar el Portal de integraciones y la página de Swagger para obtener las especificaciones completas de los puntos finales y la guía de autenticación.
• Eficiencia: Utilice metadatos de paginación para una recuperación de datos eficiente al trabajar con grandes conjuntos de datos.

Advertencias y notas importantes

Artículos relacionados

• Cómo configurar la API pública SchoolsBuddy
• Gestión de permisos de superadministrador de la organización

Preguntas frecuentes

¿Qué método de autenticación se utiliza?

La API utiliza la autenticación OAuth 2.0 para garantizar los estándares de seguridad modernos en todas las integraciones.

¿Hay documentación técnica disponible?

Sí, la documentación completa para desarrolladores, incluidas las definiciones de OpenAPI/Swagger, está disponible a través del Portal de Integraciones .

¿Quién puede configurar el acceso a la API?

Solo los superadministradores de la organización pueden otorgar acceso al cliente API, lo que mantiene la seguridad de la integración bajo estricto control.

En resumen

• La API conecta SchoolsBuddy con sistemas internos o de terceros para automatizar los flujos de trabajo de datos.
• Actualmente abarca a estudiantes, personal, eventos, ubicaciones, grupos y suscripciones para reservas instantáneas y por preferencias.
• El acceso lo otorgan exclusivamente los superadministradores de la organización a través de OAuth 2.0.

Mejora la eficiencia operativa de tu escuela con la API pública SchoolsBuddy .