OneRoster API (Application Programming Interfaces) es un formato estándar del sector, de 1EdTech (anteriormente IMS Global), para el intercambio de datos de Student Information System (SIS) / Student Management Systems (SMS). Con este método de sincronización, puede conectarse directamente a su SIS/SMS mediante las API de OneRoster 1.1 basadas en REST desarrolladas por su proveedor de SIS/SMS. La compatibilidad con la API permite sincronizar datos directamente en lugar de usar archivos CSV (valores separados por comas).
El uso de la API de OneRoster para ingerir los datos le permite iluminar las funcionalidades básicas de SDS para el aprovisionamiento. También le permite mejorar las experiencias de los productos y características de Microsoft 365. Las API de OneRoster son la forma en que podemos sincronizar objetos de SIS/SMS que proporciona las API de OneRoster a través de la plataforma de School Data Sync (SDS).
Para obtener más información sobre cómo configurar el inquilino para usar la API de OneRoster como origen, Ingesta de datos con OneRoster API.
Estado y funcionalidades de los proveedores de OneRoster
Mi proveedor no aparece en la lista desplegable y el estado aquí indica Prueba. ¿Qué debo hacer para verlos en la lista de proveedores?
Póngase en contacto con el equipo de soporte al cliente para volar su inquilino y obtener acceso a los proveedores de API que actualmente prueban. Comparta la siguiente información al generar la solicitud:
Identificación del inquilino
Nombre del proveedor de OneRoster
Versión de SDS
Lista
Una vez que el inquilino esté piloto, trabaje con el proveedor de OneRoster y con el POC de SDS para ejecutar pruebas y asegurarse de que la integración se realiza correctamente. Si tiene algún problema, trabaje con el proveedor y sds poc para resolverlos.
Una vez que la prueba se realiza correctamente, se actualiza el estado del proveedor de OneRoster (del modo de prueba a sí) y está disponible en la lista de proveedores accesibles públicamente para todos los inquilinos.
Mi proveedor no aparece en la lista. ¿Hay información para compartir con ellos para participar como proveedor de OneRoster con SDS?
Comparta con su proveedor el siguiente artículo Guía de incorporación para proveedores de API de OneRoster con SDS. En el artículo se incluyen los pasos necesarios para solicitar que se agregue como proveedor de OneRoster, incluidas las pruebas y la validación antes de colocarse en modo de prueba primero y, después, en la lista pública para que los inquilinos la seleccionen.
¿A qué puntos de conexión se accede al ingerir datos de lista?
Se proporciona la lista siguiente para ayudarle a comprender mejor a qué datos se accede al conectarse a su SIS/SMS a través de oneroster API.
En el caso de los datos opcionales de datos demográficos, relaciones de contacto de alumnos y marcas de usuario de alumnos, la capacidad de incluir estos datos o no se basará en las funcionalidades de datos opcionales admitidas del perfil de proveedor de OneRoster de SIS/SMS. Si el proveedor SIS/SMS también admite estos datos, verá el botón de alternancia (valor predeterminado) seleccionado Activado para incluir datos adicionales. Puede seleccionar el botón de alternancia para desactivar si lo desea. Si el botón de alternancia no está disponible, se muestra pero no está disponible para la interacción, esto significa que el perfil del proveedor no admite actualmente proporcionar esos datos.
Nota:
Si el perfil del proveedor muestra la demografía, los contactos o las marcas demográficas del usuario como no disponibles y desea que admitan esa característica, póngase en contacto con su proveedor y solicite que se agregue soporte técnico para permitir que SDS ingiere los datos y le permita habilitar los escenarios y experiencias que admiten los datos.
Relaciones de contacto opcionales de alumnos de usuario
La relación de contacto con los alumnos puede especificarse para que los usuarios de los alumnos mejoren las experiencias del educador para la comunicación con los padres y los tutores. Los contactos son más usuarios que se proporcionan con /users y la asociación a un alumno se encuentran en el registro de usuario del alumno en "agentes".
familyName, givenName y email son necesarios para los usuarios que tienen roles de contacto o tutor.
Espere que el teléfono y los sms estén en E.164 y + deben estar incluidos. (Ejemplo: +1234567890)
Si se proporcionan datos inversos, desde un registro de tutor de relación de contacto hasta un alumno en el campo "agentes" de usuarios de contacto, estos registros se filtran.
Marcas demográficas de usuario opcionales
Las marcas de usuario pueden especificarse para que los usuarios estudiantes indiquen su participación en un programa o cohorte. Las marcas de usuario se incluyen (cuando es true para el usuario) o no se incluyen si no son aplicables.
Las marcas se especifican como una extensión de metadatos para el usuario, en un campo de metadatos, después de una clave |Par de valores. La clave debe denominarse microsoft.userFlags y debe tener el formato de lista delimitada por comas. Las marcas de usuario pueden aparecer en cualquier orden y no distinguen mayúsculas de minúsculas.
Por 1EdTech es responsabilidad del proveedor exigir la privacidad de los datos disponibles cuando se realiza una solicitud de datos. School Data Sync realiza una solicitud de datos activos en función de la hora de la solicitud.
Credenciales de acceso de la API de OneRoster necesarias
Para habilitar la conexión a la API de OneRoster para el SIS/SMS, debe proporcionar las credenciales de conexión. Para obtener más información, consulte la documentación de su proveedor específico para obtenerlos o generarlos.
Dirección URL de acceso web: dirección URL en la que la API de OneRoster es accesible para el SIS/SMS
Identificador de cliente que se usa para conectarse a la API oneroster de SIS/SMS
Secreto de cliente que se usa para conectarse a la API oneroster de SIS/SMS
Dirección URL del token de acceso, si la API OneRoster de SIS/SMS está configurada para la autenticación mediante OAuth2, debe proporcionar el punto de conexión de dirección URL del token de acceso que se usó para conectarse. El punto de conexión es diferente de la dirección URL de acceso web.
Notas y sugerencias útiles
Los puntos de conexión siempre vienen después de "https://{server_URL}/ims/oneroster/v1p1"
Para evitar que ciertas escuelas se incluyan en los datos que se proporcionan desde el SIS a SDS, los clientes deben trabajar con su proveedor para configurar qué escuelas se incluyen para la conexión o las credenciales que se usan para vincular SDS a su SIS.
Los puntos de conexión tienen requisitos sobre la compatibilidad con parámetros de filtro para permitir el filtrado por estado o para habilitar la sincronización diferencial.
SDS aplica un filtro en la propiedad dateLastModified para el procesamiento de sincronización diferencial o sincronización incremental y es necesario para la integración con SDS.
Los proveedores deben elegir implementar el esquema de autenticación OAuth1(a) o OAuth 2.0 (concesión de credenciales de cliente). OAuth 2.0 es el preferido.
Si el protocolo de autenticación admitido es "OAuth 2.0": tipo de concesión de credenciales de cliente, SDS enviaría las credenciales en el encabezado "Autorización". Como se recomienda en la especificación de OneRoster, se envían las credenciales de cliente codificadas en el encabezado Authorization de las solicitudes de token.
Detalles del proveedor de OneRoster
Aequitas
Proveedor de SIS
Aequitas Solutions, Inc
Versión mínima del software
Q 3.6.1, Q Web API 3.6.0
Requisitos previos de configuración
Consulte Configuración de Q Web API
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Consulte Configuración de Q Web API
Instrucciones específicas
N/D
Help
Póngase en contacto con el soporte técnico al (909) 946-1600
Póngase en contacto con el soporte técnico al teléfono (gratuito): (888) 324-5363 o support@aeries.com
Arbor Education
Proveedor de SIS
Arbor Education
Versión mínima del software
N/D
Requisitos previos de configuración
La integración entre Arbor MIS y SDS está habilitada en su Arbor MIS. Póngase en contacto con el administrador de cuentas en Arbor para asegurarse de que está habilitado a través de accountmanagers@arbor-education.com. Debe tener habilitado un inquilino de Office 365 education, permisos de administrador global y School Data Sync (plan 1).
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Genere en su Arbor MIS. Los pasos que se van a completar se detallan en el Centro de ayuda de Arbor.
Instrucciones específicas
Póngase en contacto con Arbor o con su asociado de soporte técnico dedicado para ayudarle a configurar esta integración a través de myteam@arbor-education.com.
Help
Encuentre artículos de soporte técnico en el Centro de ayuda de Arbor. Para preguntas, póngase en contacto con myteam@arbor-education.com o con su asociado de soporte técnico dedicado.
Blackbaud Education Management
Proveedor de SIS
Blackbaud Education Management
Versión mínima del software
La versión más reciente de BEM siempre está disponible para los usuarios.
Requisitos previos de configuración
No aplicable
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Al seleccionar la configuración de asignación para los usuarios de Microsoft Entra, asegúrese de que la configuración para incluir o excluir el sufijo de dominio coincide con los nombres de usuario de Microsoft Entra. Esta acción garantiza los mejores resultados al hacer coincidir los alumnos y profesores de BEM con los usuarios Microsoft Entra.
Help
support.blackbaud.com
Bubblecon
Proveedor de SIS
Bubblecon
Instrucciones específicas
Póngase en contacto con el equipo de soporte al cliente de Bubblecon.
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Los clientes pueden obtener sus credenciales de oAuth desde la consola después de agregar la aplicación. Un correo electrónico es para el desarrollador de Microsoft que configuró la aplicación. Seleccione Agregar aplicaciones & Modificar permisos para mostrar la ubicación para obtener el identificador de cliente y el secreto.
Si hay problemas para conectarse, asegúrese de que la dirección URL de acceso web tiene "/ims/oneroster/v1p1" para que apunte a los conectores correctos.
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Póngase en contacto con el soporte técnico al cliente.
Instrucciones específicas
Póngase en contacto con el soporte técnico al cliente.
Help
Para obtener soporte técnico, póngase en contacto con educate_support@communitybrands.com.
Edulife Connect
Proveedor de SIS
Edulife Connect
Versión mínima del software
N/D
Requisitos previos de configuración
N/D
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Se realiza directamente en contacto con nuestro equipo de implementación y soporte técnico.
Instrucciones específicas
N/D
Help
Póngase en contacto con el soporte técnico en support@wizkids.co.uk. // 020 7550 9286
eSchoolData
Proveedor de SIS
eSchoolData
Versión mínima del software
N/D
Requisitos previos de configuración
Los distritos deben ser suscriptores del producto eSD GURU.
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Consulte instrucciones específicas.
Instrucciones específicas
Para habilitar una integración de API con SDS, los administradores de distrito deben crear primero una cuenta de proveedor en GURU. Vaya a Proveedores de configuración > y seleccione Crear nuevo proveedor. Escriba un nombre de proveedor y conserve el identificador de cliente y el secreto de cliente que se generan automáticamente. Proporcione, junto con la dirección URL regional de la API de GURU, al configurar la integración de SDS. Seleccione Siguiente y habilite todos los permisos de api de OneRoster. Seleccione Finalizar cuando haya terminado para guardar la nueva cuenta.
Help
Para preguntas, póngase en contacto con el equipo de soporte técnico de eSchoolData.
eSchooling
Proveedor de SIS
eSchooling por Codevision
Versión mínima del software
1.1.20
Requisitos previos de configuración
Ninguno
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Siga las instrucciones de la plataforma eSchooling: System Administration > School Data Sync
Instrucciones específicas
Igual que antes
Help
Contacto suporte@codevision.pt
Eum School SIS
Proveedor de SIS
DataEum
Versión mínima del software
N/D
Requisitos previos de configuración
Ninguno
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Email soporte técnico al cliente para solicitar credenciales de api de OneRoster.
Instrucciones específicas
Póngase en contacto con el soporte técnico al cliente pbd@dataeum.kr
Help
Póngase en contacto con el soporte técnico al cliente pbd@dataeum.kr
Eventful
Proveedor de SIS
Eventful
Versión mínima del software
Puede encontrar una lista de registros de estudiantes admitidos en Eventful OneRoster.
Requisitos previos de configuración
Póngase en contacto con Eventful por correo electrónico o info@eventful.se por teléfono al (+46) 10 209 9001
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Se proporciona en el proceso de instalación.
Instrucciones específicas
N/D
Help
Póngase en contacto con soporte técnico de Eventful por correo electrónico o info@eventful.se por teléfono al (+46) 10 209 9001
HECHOS
Proveedor de SIS
HECHOS
Versión mínima del software
No procede. La versión más reciente siempre está disponible para los clientes.
Requisitos previos de configuración
No aplicable
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Los clientes se suscribe a la API de OneRoster y FACTS les proporciona esta información.
Instrucciones específicas
Desde dentro del SIS, vaya a System > Configuration > SIS Integrations > OneRoster API > Rellene el formulario.
Help
Atención al cliente 866-800-6593
Focus School Software
Proveedor de SIS
Focus School Software
Versión mínima del software
Focus v 8.7
Requisitos previos de configuración
N/D
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
En la pantalla del portal de enfoque, configure sistemas de terceros de configuración > del > sistema. En la fila de inserción de registros, escriba Title: Microsoft Version 1.0 > Dialect: OneRoster. Al guardar, se generan la dirección URL, el identificador de cliente y el secreto de cliente.
Instrucciones específicas
N/D
Help
Llame a la línea de soporte telefónico de Focus al 877-410-6637.
Follett Aspen
Proveedor de SIS
Follett Aspen
Versión mínima del software
Última versión de Aspen, 5.9
Requisitos previos de configuración
N/D
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Póngase en contacto con el Administrador de relaciones con el cliente de su distrito para programar la actualización.
Instrucciones específicas
N/D
Help
Póngase en contacto con el administrador de relaciones con el cliente para obtener ayuda.
Furlong Schoolbase
Proveedor de SIS
Furlong Schoolbase
Versión mínima del software
Escuelas hospedadas solo con la versión más reciente
Requisitos previos de configuración
N/D
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Puede iniciar sesión y encontrar la documentación del producto más reciente para la pantalla de configuración de oAuth en Guía de OneRoster para Infinite Campus.
Instrucciones específicas
Antes de la versión V 1933.3: vaya a la interfaz >> de usuario de Infinite Campus y seleccione Administración >> del sistema, seleccione Campus Learning >> y Seleccione OneRoster Tools >> en OneRoster. Versión 1933.3 y versiones posteriores: vaya a la interfaz >> de usuario de Infinite Campus y seleccione Administración >> del sistema, seleccione Interoperabilidad de aprendizaje.
Al seleccionar atributos dentro de Infinite Campus para sincronizar, asegúrese de que el período no está seleccionado. Si se selecciona, existe la posibilidad de que genere un gran número de errores al sincronizar y bloquear el perfil en cuarentena.
Help
Para obtener ayuda, póngase en contacto con el Administrador de éxito del cliente.
inLogic
Proveedor de SIS
inLogic
Versión mínima del software
V7.7.510
Requisitos previos de configuración
N/D
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Puede encontrar más instrucciones para ayudar o obtener la configuración de SDS con el SIS en Integración de InLogic y Teams.
Help
Para obtener soporte técnico por correo electrónico, vaya a support@inlogic.dk, para soporte telefónico, +45 42 40 88 15 y soporte web, https://www.inlogic.dk/support/.
iSAMS de IRIS
Proveedor de SIS
iSAMS de IRIS
Versión mínima del software
21.4.23.12
Requisitos previos de configuración
Ninguno
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Debe enviar un correo electrónico al departamento de soporte técnico que solicita las credenciales de la API de OneRoster en helpdesk@isams.co.uk
Instrucciones específicas
Ninguno
Help
Póngase en contacto con el departamento de soporte técnico de iSAMS para solicitar un documento de ayuda en helpdesk@isams.co.uk.
IST
Proveedor de SIS
IST
Versión mínima del software
No procede.
Requisitos previos de configuración
Consulte instrucciones específicas.
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Consulte instrucciones específicas.
Instrucciones específicas
La información para la instalación se proporciona de forma privada.
Help
Para preguntas, póngase en contacto con el equipo de soporte técnico de IST.
LIBRUS
Proveedor de SIS
LIBRUS
Versión mínima del software
Versión actual
Requisitos previos de configuración
El cliente debe tener una licencia para LIBRUS Synergia
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Para habilitar una integración de API con SDS, debe iniciar sesión como administrador o director educativo. Vaya a Configuración > Configuración > Otras opciones > Office 365 Integración
Instrucciones específicas
Las instrucciones detalladas están disponibles en la sección de ayuda.
Help
Póngase en contacto con nuestro equipo de soporte técnico en pomoc@LIBRUS.pl
MySchool
Proveedor de SIS
MySchool Ltd
Versión mínima del software
No aplicable
Requisitos previos de configuración
Configuración inicial del sistema MySchool asistida a través del equipo de soporte técnico.
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Asistencia a través del equipo de soporte técnico.
Libro de calificaciones de TeacherPlus de Rediker Software
Versión mínima del software
1.12.0.0
Requisitos previos de configuración
Ninguno. La integración de OneRoster está habilitada para todas las escuelas de forma predeterminada.
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Generado automáticamente por el programa cuando se ha creado una nueva escuela. Administración puede administrar la configuración de usuario a través de la aplicación Administrador de libros de calificaciones.
Instrucciones específicas
Ninguno
Help
Las preguntas se pueden dirigir a GBSupport@rediker.com o APSupport@rediker.com
SIMS
Proveedor de SIS
SIMS by Education Software Solutions
Versión mínima del software
SIMS 7 Verano 2019 o posterior
Requisitos previos de configuración
Se requiere una cuenta de id. de SIMS.
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Cómo obtener el identificador de cliente, el secreto de cliente y las direcciones URL
Desde el portal de Administración VULCAN; Seleccione "Configuración" > "Configuración Office 365 configuración" > Configuración de intercambio de API. Habilite "Sincronización con Office 365". En esta pestaña, recibirá el identificador de cliente, el secreto de cliente y las direcciones URL.
Instrucciones específicas
N/D
Help
Póngase en contacto con el soporte técnico durante el https://vulcan.edu.pl horario de oficina estándar.