Utilice la API pública ManageBac+ para conectar otros sistemas. Cree y administre tokens API y encuentre los campos y permisos admitidos.
Aprenda cómo funciona la API pública ManageBac+ , cómo crear y administrar tokens de API y dónde encontrar campos, funciones, permisos, notas e información de registro de cambios admitidos.
La API pública ManageBac+ permite a las escuelas conectar su cuenta ManageBac+ a plataformas externas que no están integradas directamente con ManageBac+ .
Solo un administrador de la cuenta de su escuela puede configurar estos ajustes. Esta guía cubre la configuración, la administración de tokens, las funciones admitidas, notas técnicas, permisos y preguntas frecuentes.
Descripción general
La API pública ManageBac+ está diseñada para escuelas que necesitan crear conexiones personalizadas con sistemas de terceros. El acceso a la API se controla mediante tokens creados y administrados por los administradores.
Desde API Manager, puede crear tokens, controlar permisos, revisar el estado de los tokens, acceder a la documentación de referencia y ver el registro de cambios de API.
Configuración > Desarrollar ahora tiene dos administradores de API. API Manager (Legacy) crea los tokens de API descritos en esta guía. API Manager (OAuth2) emite credenciales de OAuth2. Utilice el que admite el sistema que está conectando.
Conceptos clave/Novedades
Campos y funciones soportados
Abra la pestaña Documentos de referencia en el menú de la izquierda para obtener orientación detallada sobre cómo configurar conexiones API, incluidas notas con ejemplos de solicitudes y respuestas. Esta página también incluye un menú desplegable de versiones en la parte superior para que pueda utilizar las solicitudes disponibles enumeradas para diferentes versiones de API.
Permisos API
Para los campos de permiso, puede elegir Ninguno, seleccionar solo aquellos con derechos de solo lectura o seleccionar Todos. También puede seleccionar campos individuales marcando la casilla de verificación.
Estudiantes
- índice
- espectáculo
- crear
- actualizar
- archivo
- desarchivar
Padres
- índice
- espectáculo
- crear
- actualizar
- archivo
- desarchivar
Maestros
- índice
- espectáculo
- crear
- actualizar
Grupos anuales
- índice
- asesores
- estudiantes
- agregar-estudiantes
- eliminar-estudiantes
- asistencia a término
- asistencia a la cita
Clases
- índice
- espectáculo
- estudiantes
- agregar-estudiantes
- eliminar-estudiantes
- asistencia a término
- asistencia a la cita
Evaluaciones de clase
- grados-grados-term
Membresías
- índice
Escuela
- espectáculo
- años académicos
- sujetos
- calificaciones
Tareas
- índice espectáculos estudiantes
Funciones API
Grupos anuales
- Obtener todos los grupos de año
- Obtener asesores
- Obtener estudiantes para un grupo de año
- Agregar estudiantes a un grupo de año
- Eliminar estudiantes de un grupo de año
- Obtenga asistencia al salón principal para un grupo anual y un período
- Obtener asistencia al salón principal para un grupo de año en una fecha específica
Clases
- Obtener todas las clases
- Obtener una clase
- Conseguir estudiantes para una clase
- Agregar estudiantes a una clase
- Eliminar estudiantes de una clase
- Obtener tareas para una clase
- Obtener una tarea para una clase
- Obtenga resultados de evaluación de estudiantes para una tarea y clase
- Obtener calificaciones trimestrales para una clase
- Obtenga todas las calificaciones de una clase durante un período académico
- Obtener asistencia a una clase durante un período académico
- Obtener asistencia a clase para una cita
Membresías
- Obtenga todas las membresías
Estudiantes
- Obtener todos los estudiantes
- conseguir un estudiante
- Crear nuevo estudiante
- Actualizar un estudiante
- Archivar un estudiante
- Desarchivar un estudiante
Maestros
- Obtener todos los profesores
- conseguir un maestro
- Crear nuevo profesor
- Actualizar un maestro
Padres
- Obtener todos los padres
- conseguir un padre
- Crear nuevo padre
- Actualizar un padre
- Archivar un padre
- Desarchivar un padre
Escuela
- Obtener detalles de la escuela
- Obtener años académicos
- Obtener calificaciones escolares
- Obtener materias escolares
Utilidades
- Silbido
- Obtener Avatar
Registro de cambios de API
Puede ver el registro de cambios de API en ManageBac+ navegando a Configuración > Desarrollar > API Manager (Legacy). En la parte inferior de esta página, encontrará la sección Registro de cambios, donde se enumeran cronológicamente las actualizaciones recientes de API, incluidos campos nuevos, puntos finales agregados o modificados y otros cambios técnicos relevantes.
Navegación paso a paso
Habilite la API pública ManageBac+ y agregue un token
- Vaya a Configuración > Desarrollar > API Manager (Legacy) > Agregar nuevo token.
- Haga clic en Agregar nuevo token.
- Introduzca un nombre de token claro y útil para que sea fácil identificar para qué se utiliza el token.
- Seleccione los puntos que desea actualizar y recuperar, incluidos los datos de estudiantes, padres y maestros, grupos de IB, clases y configuración de la escuela.
- Haga clic en Agregar token para generar el token.
Editar o administrar un token de API
- Abra Configuración > Desarrollar > API Manager (Legacy).
- Utilice el icono del portapapeles para copiar el token y utilizarlo en otro sistema confiable.
- Pase el cursor sobre el ícono i para ver los permisos del token.
- Revise el estado del token para ver si está habilitado o deshabilitado.
- Haga clic en Editar para ajustar los permisos o deshabilitar o habilitar el token.
- Elimine el token usando el ícono de la papelera cuando la integración ya no sea necesaria.
Advertencias y notas importantes
Advertencia de seguridad
Su token API solo debe compartirse con partes de confianza. Los tokens API nunca deben enviarse por correo electrónico ni guardarse en formularios sin cifrado SSL. Una vez que una integración ya no esté en uso, recomendamos deshabilitar el token API haciendo clic en el ícono de eliminar.
Notas API
- Los valores nulos nunca se representan.
- Los valores nulos se ignoran en las solicitudes POST.
- Los valores de cadena vacíos no se ignoran y sobrescribirán los valores existentes.
- Cualquier llamada devolverá un error cuando no pueda encontrar un usuario para una asignación masiva, por ejemplo parent_ids o child_ids.
- Los parámetros disponibles para la pila de acciones de índice utilizan la lógica AND. Es posible que el uso de modificado_since y eliminado_since al mismo tiempo no devuelva el resultado esperado porque la eliminación no cambia la marca de tiempo de modificación del registro.
- Cualquier usuario que tenga la función de administrador tiene acceso de solo lectura a través de la API por razones de seguridad.
- Todos los campos de marca de tiempo están en formato ISO8601, por ejemplo yyyy-mm-ddThh:mm:ss.sssTZ como 2017-11-06T04:35:00.000GST.
- Si tiene preguntas o inquietudes sobre la API, comuníquese con api@managebac.com.
Límite de tarifa
El límite de solicitudes de API es de 200 solicitudes por minuto desde la misma dirección IP.
Preguntas frecuentes
¿ ManageBac+ se integra con otra plataforma?
Si el producto no aparece en Configuración > Integraciones > Socios, entonces no existe una relación formal. En estos casos, es posible que su escuela aún pueda establecer una integración personalizada utilizando la API pública.
¿Puede ManageBac+ Support crear una integración para nuestra escuela?
Háganos saber qué sistema le gustaría integrar con ManageBac+ y consideraremos si tiene sentido para nosotros, como empresa y producto, convertirnos en socios directos de esa herramienta o servicio.
¿Puede ManageBac+ Support escribir la solicitud de API por nosotros?
El equipo de soporte de ManageBac+ puede brindar orientación sobre preguntas y problemas de API, pero todas las solicitudes de API deben ser completadas directamente por su escuela. Si está estableciendo una conexión personalizada, consulte a su departamento de TI.
¿Cuál es el límite de tasa de API ManageBac+ ?
El límite de solicitudes de API es de 200 solicitudes por minuto desde la misma dirección IP.
¿Dónde puedo encontrar orientación sobre cómo utilizar la API pública ManageBac+ ?
Consulte Configuración > Desarrollar > Documentos de referencia para obtener detalles sobre cada campo y las últimas notas del registro de cambios.
Mi solicitud de API tiene un problema. ¿A quién debo contactar?
Envíe un correo electrónico a api@managebac.com con detalles claros de la solicitud y el error que está experimentando.
En resumen
- La API pública ManageBac+ permite a las escuelas conectar ManageBac+ con sistemas externos a través de tokens administrados por el administrador.
- Puede crear, revisar, editar, deshabilitar y eliminar tokens desde Configuración > Desarrollar > API Manager (Legacy).
- Los documentos de referencia, los permisos, las notas de API, los detalles del registro de cambios y la guía de soporte común están disponibles en el flujo de trabajo de API Manager.
ManageBac+ brinda a las escuelas una forma controlada de crear integraciones personalizadas mientras mantiene el acceso a la API seguro y basado en permisos.