Ingesta de datos con OneRoster API

  • Artículo

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).

Datos a los que accede School Data Sync

Importante

Al conectar y hacer que los datos de la institución estén disponibles con School Data Sync, reconoce que está autorizado para compartir estos datos con Microsoft y se compromete a cumplir los estándares de gobernanza de datos de su organización.

Acción URL Propiedades de filtro necesarias Filtro opcional o recomendado Ejemplos
GetAllAcademicSessions /academicSessions status dateLastModified /academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}'

Configuración de SDS para Microsoft 365 Educación inquilino

  • Microsoft 365 Educación inquilino
  • Necesita permisos de administrador global

Acceso a SDS e inicio de sesión por primera vez

Para acceder al portal de Administración SDS, inicie el explorador web, vaya a sds.microsoft.com e inicie sesión con su cuenta de Administración global de Microsoft 365.

  1. Seleccione Introducción.

    Captura de pantalla que muestra el mensaje de bienvenida.

  2. Seleccione Continuar.

    Captura de pantalla que muestra información general sobre SDS.

    Espere unos instantes para que los servicios se aprovisionen en el inquilino antes del paso siguiente.

    Captura de pantalla que muestra pendiente mientras se espera a que se complete el aprovisionamiento del servicio.

  3. Seleccione Crear nuevo flujo de entrada. Seleccione Siguiente para continuar.

    Captura de pantalla que muestra el mensaje para crear un nuevo flujo de entrada.

  4. Elija el origen de datos. En OneRoster API, seleccione la opción Conectarse a mis datos.

  5. Seleccione el formato. En OneRoster API, seleccione la API de opción. Seleccione Siguiente para continuar.

    Captura de pantalla de la selección de la API.

    Captura de pantalla que muestra la solicitud de proceso para obtener la lista de proveedores de API.

  6. Debe seleccionar el proveedor SIS/SMS de la lista de proveedores. Una vez que haya seleccionado, seleccione Siguiente para continuar.

    Captura de pantalla que muestra la lista de proveedores de API para la selección.

    Nota:

    Si su proveedor de SIS o SMS no está en la lista, consulte Información general del proveedor de OneRoster para obtener instrucciones para participar en pruebas piloto o información que se enviará a su proveedor para que participen y se agreguen como proveedores de OneRoster.

  7. Para habilitar la conexión a su SIS/SMS, debe proporcionar las credenciales de conexión.

    • Dirección URL de acceso web: dirección URL donde 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 de 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, también deberá proporcionar el punto de conexión de dirección URL del token de acceso que se usará para conectarse. El punto de conexión es diferente de la dirección URL de acceso web.

    • Seleccione Siguiente para continuar.

    Captura de pantalla que muestra las solicitudes de credenciales de API.

  8. A continuación, probaremos la conexión a su SIS/SMS en función de la información especificada en la última pantalla.

    Captura de pantalla que muestra la validación de credenciales de API.

    • Si no hay ningún problema, se le notificará y puede seleccionar Siguiente para continuar.

    • Si no podemos establecer una conexión, se le notificará y podrá seleccionar Atrás para revisar y actualizar la información proporcionada.

    Captura de pantalla que muestra la validación correcta de las credenciales de API.

  9. Elija su año académico actual y proporcione un nombre descriptivo, como 2023 o 2022 – 2023. (Los caracteres deben ser utf8 o se quitarán automáticamente).

    Importante

    El año académico se usa para asociar datos entrantes para ayudar a crear datos históricos año a año. El enfoque se alinea con un año académico frente a un año natural. Si el año académico abarca un año natural, por ejemplo, comienza el 15/08/2022 y finaliza el 15/6/2023, el valor del año académico que se va a seleccionar es el año final, 2023. Para obtener más información, consulte Control del año académico.

    Escriba las fechas de inicio y finalización de su año académico.

    En función de las funcionalidades de datos opcionales admitidas del proveedor, verá el botón de alternancia activado (valor predeterminado) para incluir otros datos. Puede seleccionar el botón de alternancia para desactivar si lo desea. Si el botón de alternancia está desactivado y no está disponible para activarse, esto significa que el perfil del proveedor no admite actualmente proporcionar los datos opcionales. Para obtener más información si el proveedor admite el envío de datos opcionales, consulte Información general sobre el proveedor de API de OneRoster.

    Escriba la fecha en que SDS debe dejar de sincronizar los datos en función del año académico definido para este origen. Es más común dejar de sincronizar datos en la fecha de finalización del año académico que acaba de escribir.

    Seleccione Siguiente para continuar.

    Captura de pantalla que solicita año académico y detiene la fecha de sincronización.

  10. Seleccione las opciones de regla de identidad de usuario. Haga sus selecciones para los roles de personal y estudiante.

    Nota:

    La coincidencia de usuarios se realiza con el flujo de entrada y no escribe ni actualiza los objetos de usuario en Microsoft Entra ID. La coincidencia se realiza y se almacena en el lago de datos de Education. Para obtener más información, consulte Administración de usuarios de Microsoft 365 en la escritura del vínculo de coincidencia hacia delante con el flujo de salida.

    • Atributo del origen: atributo de usuario basado en los datos que proceden del SIS/SMS.
      • Las opciones de origen disponibles son Nombre de usuario y Email.
    • Atributo con el que se va a hacer coincidir: propiedad de usuario en Microsoft Entra ID con la que se va a hacer coincidir.
      • Las opciones de coincidencia de Microsoft Entra ID disponibles son UserPrincipalName y Mail.
    • (OPCIONAL) Si los datos de usuario no incluyen el valor @domain , seleccione un dominio de la lista.

    Advertencia

    La selección de un dominio es opcional y solo se debe usar si los datos entrantes basados en el atributo seleccionado del origen no incluyen el valor @domain . SDS no comprueba y anexa si falta el valor en un registro. SDS anexará la selección de dominio a todos los registros que podrían dar lugar a @domain@domain y no encontrar coincidencias en esas instancias para la asignación de usuarios existente con usuarios en Microsoft Entra ID.

    Precaución

    Si los usuarios de SIS o SMS, por ejemplo, los usuarios del grupo de roles de personal, podrían estar asociados a @domain1 , @domain2 o @domain3 debe tener un @domain incluido en los datos de origen, en función del atributo seleccionado de la selección de origen (por ejemplo, prefix@domain). Esto es necesario para que el atributo coincida con: UserPrincipalName o Mail para encontrar el Microsoft Entra usuario correcto con el que debe coincidir.

    La especificación de oneRoster API v1.1 solo permite pasar un rol por usuario. Si está asociado a varias organizaciones, solo puede pasar el mismo rol para un usuario a varias organizaciones. Dado que un rol por organización, los registros se marcan como isPrimary "True".

    Importante

    Al configurar el flujo Administrar usuarios de Microsoft 365, estas reglas se usan si la opción está activada para Crear usuarios no coincidentes, para definir la construcción de la Microsoft Entra propiedad UserPrincipalName.

    Una vez que esté satisfecho con las selecciones, seleccione Siguiente para continuar.

    Captura de pantalla que muestra las solicitudes de reglas de identidad de usuario.]

  11. Revise la información presentada en Revisión y creación. Si todo parece correcto, seleccione el botón Siguiente . Si no es así, puede volver a la corrección.

    Captura de pantalla de Revisar y crear.]

    Captura de pantalla del procesamiento después de seleccionar crear.]

  12. Se ha creado el flujo de datos de entrada y la primera ejecución está pendiente, seleccione el botón Listo . Vuelva a comprobar para ver el estado de la primera ejecución.

    Captura de pantalla en la que se ha creado el flujo de entrada.]

    Captura de pantalla que muestra la acción Panel principal y Administrar datos.

    Sugerencia

    Puede configurar la configuración administrar datos inmediatamente después de definir la configuración de datos de Connect, durante la primera ejecución activa o posterior después de que la primera ejecución haya finalizado.

  13. Para comprobar el estado de la ejecución, vuelva a la página Panel principal.

    Si no hay ningún problema con los datos, el panel inicio indicará, "No se encontraron errores de datos o advertencias" y "No se encontraron errores de datos ni advertencias durante la última ejecución. ¡Sigue con el gran trabajo!"

    Si se encuentran problemas con los datos, el panel inicio informa de que "Hemos encontrado algunos problemas con los datos" y le anima a investigar el estado de sincronización.