¿Qué es la API pública de ManageBac+?
La API pública de ManageBac+ te permite conectar la cuenta de tu colegio con plataformas externas que no están integradas directamente con ManageBac+. La configuración de esta función solo puede ser realizada por un administrador de la cuenta del colegio.
Advertencia
Ten en cuenta que tu token de la API solo debe compartirse con partes de confianza. Los tokens de la API nunca deben enviarse por correo electrónico ni guardarse en formularios sin cifrado SSL. Una vez que una integración deje de utilizarse, se recomienda desactivar el token de la API haciendo clic en el icono de eliminar.
¿Cómo activar la API pública de ManageBac+?
Para habilitar la API pública de ManageBac+, navega a Ajustes > Desarrollo > Administrador de API y haz clic en Añadir nuevo token.
A continuación, podrás configurar los permisos del token y generar un token único.
Añadir un token de API
Los administradores pueden generar un token de la API pública haciendo clic en Añadir nuevo token dentro de Ajustes > Desarrollo > Administrador de API. Asegúrate de asignar un nombre claro y descriptivo al token para identificar fácilmente su uso.
Desde esta pantalla, puedes seleccionar los permisos que deseas habilitar, incluyendo acceso a datos de alumnos, padres, profesores, grupos de año, clases, asignaturas, tareas, evaluaciones, asistencia y ajustes del colegio, entre otros.
Una vez configurados los permisos necesarios, haz clic en Añadir token para completar la creación del token.
Editar un token de API
Una vez añadido, podrás ver o modificar los detalles del token creado.
Haz clic en el icono del portapapeles para copiar el token y pegarlo en otros sistemas.
Consulta los permisos del token pasando el cursor sobre el icono de información (i).
Revisa el estado del token para verificar si está habilitado o deshabilitado.
Haz clic en Editar para ajustar los permisos del token o habilitarlo o deshabilitarlo.
Elimina el token haciendo clic en el icono de la papelera.
¿Qué campos y funciones admite la API pública de ManageBac+?
Haz clic en la pestaña Documentación API del menú lateral izquierdo para obtener orientación detallada sobre cómo configurar conexiones de la API, incluidas notas con ejemplos de solicitudes y respuestas.
Esta página también incluye un menú desplegable de versiones en la parte superior, que te permite utilizar cualquiera de las solicitudes de API disponibles según la versión seleccionada.
Notas API
• Los valores nulos nunca se muestran.
• Los valores nulos se ignoran en las solicitudes POST.
• Los valores de cadena vacía no se ignoran y sobrescribirán los valores existentes.
• Cualquier llamada devolverá un error cuando no se pueda encontrar un usuario para asignaciones masivas, por ejemplo parent_ids o child_ids.
• Los parámetros disponibles para las acciones index se combinan usando lógica AND. El uso simultáneo de modified_since y deleted_since puede no devolver el resultado esperado, ya que la eliminación no cambia la marca de tiempo de modificación del registro.
• Los usuarios con el rol de admin son de solo lectura a través de la API por razones de seguridad.
• Todos los campos de marca de tiempo utilizan el formato ISO8601, por ejemplo: yyyy-mm-ddThh:mm:ss.sssTZ, como 2017-11-06T04:35:00.000GST.
Queremos que esta API sea útil para ti. Si tienes preguntas o inquietudes, por favor contáctanos en api@managebac.com
Permisos API
Para los campos de permisos, puedes alternar entre Ninguno, Solo lectura o Todos. También puedes seleccionar permisos específicos marcando cada casilla de verificación.
Funciones API
Year Groups (Grupos de año)
Get all Year Groups
Obtener todos los Grupos de año
Get Advisors
Obtener los asesores de un Grupo de año
Get Students for a Year Group
Obtener los alumnos de un Grupo de año
Add Students to a Year Group
Añadir alumnos a un Grupo de año
Remove Students from a Year Group
Eliminar alumnos de un Grupo de año
Get Homeroom Attendance for a Year Group and Term
Obtener la asistencia de Tutoría para un Grupo de año y un periodo
Get Homeroom Attendance for a Year Group on a specified Date
Obtener la asistencia de Tutoría para un Grupo de año en una fecha específica
Get Homeroom Attendance Adjustments for a Year Group and Term
Obtener ajustes de asistencia de Tutoría para un Grupo de año y un periodo
Get PBL details for a Year Group
Obtener los detalles de Project-based Learning (PBL) para un Grupo de año
Classes (Clases)
Get all Classes
Obtener todas las clases
Get a Class
Obtener una clase
Create a Class
Crear una clase
Update a Class
Actualizar una clase
Bulk create and update Classes
Crear y actualizar clases en bloque
Get Students for a Class
Obtener los alumnos de una clase
Add Students to a Class
Añadir alumnos a una clase
Remove Students from a Class
Eliminar alumnos de una clase
Add or update class students
Añadir o actualizar alumnos de una clase
Get Teachers for a Class
Obtener los profesores de una clase
Add Teachers to a Class
Añadir profesores a una clase
Remove Teachers from a Class
Eliminar profesores de una clase
Set Teacher memberships for a Class
Configurar las membresías de profesores para una clase
Get Tasks for a Class
Obtener las tareas de una clase
Get a Task for a Class
Obtener una tarea de una clase
Create New Task
Crear una nueva tarea
Update Task
Actualizar una tarea
Delete Task
Eliminar una tarea
Get List of available Criteria for a Class
Obtener la lista de criterios disponibles para una clase
Get Categories for a Task
Obtener las categorías de una tarea
Get Student Assessment Results for a Task and Class
Obtener los resultados de evaluación de los alumnos para una tarea y clase
Get Term Grades for a Class
Obtener las calificaciones finales de un periodo para una clase
Get all Grades for a Class during an Academic Term
Obtener todas las calificaciones de una clase durante un periodo académico
Update or Create a Grade for a Student for a Task
Actualizar o crear una calificación para un alumno en una tarea
Bulk Update or Create Grades for Students for a Task
Actualizar o crear calificaciones en bloque para alumnos en una tarea
Bulk Delete Grades for Students for a Task
Eliminar calificaciones en bloque para alumnos en una tarea
Get Attendance for a Class during an Academic Term
Obtener la asistencia de una clase durante un periodo académico
Get Class Attendance for a Date
Obtener la asistencia de una clase en una fecha específica
Set or Update a Class Attendance for Students
Configurar o actualizar la asistencia de alumnos en una clase
Membership (Membresías)
Get all Memberships
Obtener todas las membresías
Behaviour Notes (Notas de comportamiento)
Get all behaviour notes
Obtener todas las notas de comportamiento
Students (Alumnos)
Get all Students
Obtener todos los alumnos
Get a Student
Obtener un alumno
Create New Student
Crear un nuevo alumno
Update a Student
Actualizar un alumno
Archive a Student
Archivar un alumno
Unarchive a Student
Desarchivar un alumno
Get Student memberships
Obtener las membresías de un alumno
Set Student homeroom attendance
Configurar la asistencia de Tutoría de un alumno
Get all Attendance Excusals for a Student
Obtener todas las excusas de asistencia de un alumno
Create Attendance Excusal for a Student
Crear una excusa de asistencia para un alumno
Update Attendance Excusal for a Student
Actualizar una excusa de asistencia para un alumno
Delete Attendance Excusal for a Student
Eliminar una excusa de asistencia para un alumno
Get all Attendance Excusals for a Date
Obtener todas las excusas de asistencia para una fecha
Update Student Avatar
Actualizar el avatar del alumno
Delete Student Avatar
Eliminar el avatar del alumno
Teachers (Profesores)
Get all Teachers
Obtener todos los profesores
Get a Teacher
Obtener un profesor
Create New Teacher
Crear un nuevo profesor
Update a Teacher
Actualizar un profesor
Archive a Teacher
Archivar un profesor
Unarchive a Teacher
Desarchivar un profesor
Get a teacher Classes Memberships
Obtener las membresías de clases de un profesor
Get a teacher Groups Memberships
Obtener las membresías de grupos de un profesor
Update Teacher Avatar
Actualizar el avatar del profesor
Delete Teacher Avatar
Eliminar el avatar del profesor
Parents (Padres)
Get all Parents
Obtener todos los padres
Get a Parent
Obtener un padre
Create New Parent
Crear un nuevo padre
Update a Parent
Actualizar un padre
Archive a Parent
Archivar un padre
Unarchive a Parent
Desarchivar un padre
Parent-Child Relationships (Relaciones Padre-Hijo)
Get all relationships
Obtener todas las relaciones
Get a Parent-Child relationship
Obtener una relación Padre-Hijo
Create New Parent-Child relationship
Crear una nueva relación Padre-Hijo
Update a Parent-Child relationship
Actualizar una relación Padre-Hijo
Bulk update a Parent-Children relationships
Actualizar relaciones Padre-Hijo en bloque
Delete a Parent-Child relationship
Eliminar una relación Padre-Hijo
School (Colegio)
Get School Details
Obtener los detalles del colegio
Get Academic Year
Obtener un año académico
Create new Academic Year
Crear un nuevo año académico
Get Academic Years
Obtener los años académicos
Get Academic Year Calendar
Obtener el calendario del año académico
Create new Academic Term
Crear un nuevo periodo académico
Update the Academic Term
Actualizar un periodo académico
Remove the Academic Term
Eliminar un periodo académico
Get School Grades
Obtener los grados del colegio
Get School Term Grade Scales
Obtener las escalas de calificación por periodo del colegio
Get School Subjects
Obtener las asignaturas del colegio
Get Subject Group
Obtener un grupo de asignaturas
Create Subject Group
Crear un grupo de asignaturas
Update Subject Group
Actualizar un grupo de asignaturas
Delete a Subject Group
Eliminar un grupo de asignaturas
Get Subjects
Obtener las asignaturas
Get Subject
Obtener una asignatura
Create Subject
Crear una asignatura
Update Subject
Actualizar una asignatura
Delete a Subject
Eliminar una asignatura
Bulk Enable Subjects
Habilitar asignaturas en bloque
Bulk Disable Subjects
Deshabilitar asignaturas en bloque
Get School Term Grade Rubrics
Obtener las rúbricas de calificación por periodo del colegio
Get Attendance Categories
Obtener las categorías de asistencia
Get Assessment Types
Obtener los tipos de evaluación
Utilities (Utilidades)
Ping
Verificar conexión con la API
Get Avatar
Obtener avatar
Registro de cambios de la API de ManageBac+
Puedes consultar los registros de cambios (Changelog) de la API de ManageBac desde Ajustes > Desarrollo > Administrador de API.
En la parte inferior de esta página encontrarás la sección Changelog, donde se publican de forma cronológica las actualizaciones recientes de la API, incluyendo nuevos campos, endpoints añadidos o modificados, y cambios técnicos relevantes.
Preguntas Frecuentes API
¿ManageBac+ se integra con ____?
Si el producto no aparece en Ajustes > Integraciones > Colaboradores, significa que no existe una integración oficial. En estos casos, el colegio aún puede establecer una integración personalizada utilizando la API pública.
¿El equipo de Soporte de ManageBac+ puede crear una integración con ____ para nosotros?
Cuéntanos con qué sistema te gustaría integrar ManageBac+. Evaluaremos si tiene sentido, a nivel de empresa y de producto, establecer una relación formal como colaboradores con la herramienta o servicio de interés.
¿El equipo de Soporte de ManageBac+ puede escribir las solicitudes de la API por nosotros?
El equipo de Soporte de ManageBac+ puede ofrecer orientación y resolver dudas relacionadas con la API, pero todas las solicitudes de la API deben ser desarrolladas directamente por el colegio. Si deseas establecer una conexión personalizada, te recomendamos coordinarte con tu departamento de TI.
¿Cuál es el límite de solicitudes de la API de ManageBac+?
El límite de solicitudes de la API es de 200 solicitudes por minuto desde la misma dirección IP.
¿Dónde puedo encontrar orientación sobre cómo usar la API pública de ManageBac+?
Consulta Ajustes > Desarrollo > Documentación API para obtener información detallada sobre cada campo y revisar las notas más recientes del Changelog.
Mi solicitud de la API presenta un problema, ¿con quién debo contactar?
Por favor escribe a api@managebac.com, incluyendo detalles claros de la solicitud realizada y el error que estás experimentando.