Vue d’ensemble du fournisseur OneRoster

L’API OneRoster (Interfaces de programmation d’applications) est un format Standard de l’industrie, de 1EdTech (anciennement IMS Global), pour l’échange de données SIS (Student Information System) / Systèmes de gestion des étudiants (SMS). À l’aide de cette méthode de synchronisation, vous pouvez vous connecter directement à votre SIS/SMS à l’aide des API OneRoster 1.1 basées sur REST développées par votre fournisseur SIS/SMS. La prise en charge de l’API vous permet de synchroniser les données directement au lieu d’utiliser des fichiers CSV (Valeur séparée par des virgules).

L’utilisation de l’API OneRoster pour ingérer les données vous permet d’éclairer les fonctionnalités principales de SDS pour l’approvisionnement. Il vous permet également d’améliorer les expériences des produits et fonctionnalités Microsoft 365. Les API OneRoster permettent de synchroniser des objets à partir de SIS/SMS qui fournissent des API OneRoster via la plateforme School Data Sync (SDS).

Pour plus d’informations sur la façon de configurer votre locataire pour utiliser l’API OneRoster comme source, consultez Ingestion de données avec l’API OneRoster.

Status et fonctionnalités des fournisseurs OneRoster

Mon fournisseur n’est pas répertorié dans la liste déroulante et le status ici indique Test. Que dois-je faire pour les afficher dans la liste des fournisseurs ?

• Contactez l’équipe du support technique pour tester votre locataire et accéder aux fournisseurs d’API actuellement tester. Partagez les informations suivantes lors du déclenchement de la demande :

  • ID client
  • Nom du fournisseur OneRoster
  • Version de SDS
  • Liste

• Une fois que votre locataire est testé, collaborez avec votre fournisseur OneRoster et la preuve de concept SDS pour exécuter des tests et vous assurer que l’intégration est réussie. Si vous rencontrez un problème, collaborez avec le fournisseur et la preuve de concept SDS pour les résoudre.

• Une fois le test réussi, le status fournisseur OneRoster est mis à jour (du mode test à oui) et disponible sur la liste des fournisseurs accessibles publiquement pour tous les locataires.

Mon fournisseur n’est pas répertorié. Y a-t-il des informations à partager avec eux pour participer en tant que fournisseur OneRoster avec SDS ?

• Partagez avec votre fournisseur l’article suivant Conseils d’intégration pour les fournisseurs d’API OneRoster avec SDS. L’article décrit les étapes nécessaires pour demander l’ajout en tant que fournisseur OneRoster, notamment le test et la validation avant d’être placé en mode test, puis finalement dans la liste publique pour la sélection par les locataires.

Quels points de terminaison sont accessibles lors de l’ingestion de données de liste ?

• La liste suivante est fournie pour vous aider à mieux comprendre les données auxquelles vous accédez lors de la connexion à votre SIS/SMS via l’API OneRoster.

Points de terminaison d’API requis pour SDS

Points de terminaison d’API facultatifs pour SDS

Relations de contact utilisateur étudiant facultatives

La relation de contact étudiant peut être spécifiée pour les utilisateurs étudiants afin d’améliorer les expériences des enseignants pour la communication avec les parents et les tuteurs. Les contacts sont davantage d’utilisateurs fournis avec /users et l’association à un étudiant se trouvent dans l’enregistrement utilisateur de l’étudiant sous « agents ».

• Pour plus d’informations, consultez les rôles de relation de contact d’étudiant pris en charge par SDS , consultez Liste de valeurs par défaut : rôles de relation de contact.

• familyName, givenName et email sont requis pour les utilisateurs qui ont des rôles de contact/tuteur.

• Le téléphone et les sms doivent être inclus dans E.164 et +. (Exemple : +1234567890)

• Si des données inversées sont fournies, d’un enregistrement tuteur de relation de contact à l’étudiant dans le champ « agents » des utilisateurs de contact, ces enregistrements sont filtrés.

Indicateurs démographiques utilisateur facultatifs

Les indicateurs utilisateur peuvent être spécifiés pour permettre aux utilisateurs étudiants d’indiquer leur participation à un programme ou à une cohorte. Les indicateurs utilisateur sont inclus (lorsqu’ils sont true pour l’utilisateur), ou non inclus si cela n’est pas applicable.

Les indicateurs sont spécifiés en tant qu’extension de métadonnées pour l’utilisateur, dans un champ de métadonnées, à la suite d’une clé |Paire valeur. La clé doit être nommée microsoft.userFlags et doit être mise en forme en tant que liste délimitée par des virgules. Les indicateurs utilisateur peuvent apparaître dans n’importe quel ordre et ne respectent pas la casse.

Pour plus d’informations, consultez la liste par défaut des valeurs d’indicateur utilisateur prises en charge par SDS , consultez Liste de valeurs par défaut : indicateurs utilisateur.

Exemple :

{ 
  "user" : { 
   … 
   … 
    "metadata" : { 
     "microsoft.userFlags" : "freeLunch,homeless,giftedOrTalented“ 
    } 
}

Informations d’identification d’accès à l’API OneRoster nécessaires

Pour activer la connexion à l’API OneRoster pour votre SIS/SMS, vous devez fournir les informations d’identification de connexion. Pour plus d’informations, consultez la documentation de votre fournisseur spécifique pour les obtenir ou les générer.

• URL d’accès web : URL où votre API OneRoster est accessible pour votre SIS/SMS

• ID client utilisé pour se connecter à votre API OneRoster SIS/SMS

• Clé secrète client utilisée pour se connecter à votre API OneRoster SIS/SMS

• URL du jeton d’accès : si votre API OneRoster SIS/SMS est configurée pour l’authentification à l’aide d’OAuth2, vous devez fournir le point de terminaison URL du jeton d’accès utilisé pour la connexion. Le point de terminaison est différent de l’URL d’accès Web.

Notes et conseils utiles

• Les points de terminaison viennent toujours après « https://{server_URL}/ims/oneroster/v1p1 »
• Pour empêcher certaines écoles d’être incluses dans les données fournies du SIS vers SDS, les clients doivent travailler avec leur fournisseur pour savoir comment configurer les écoles incluses pour la connexion/les informations d’identification utilisées pour lier SDS à leur SIS.
• Les points de terminaison ont des exigences en matière de prise en charge des paramètres de filtre pour autoriser le filtrage par status ou pour activer la synchronisation delta.
• SDS applique un filtre sur la propriété dateLastModified pour le traitement de synchronisation delta/incrémentielle et est requis pour l’intégration à SDS.
• Les fournisseurs doivent choisir d’implémenter le schéma d’authentification OAuth1(a) ou OAuth 2.0 (octroi d’informations d’identification du client). OAuth 2.0 est préférable.
• Si le protocole d’authentification pris en charge est « OAuth 2.0 » - type d’octroi des informations d’identification du client, SDS envoie les informations d’identification dans l’en-tête « Authorization ». Comme recommandé dans la spécification OneRoster, nous envoyons les informations d’identification client encodées dans l’en-tête Authorization des demandes de jeton.

Détails du fournisseur OneRoster

Aequitas

Aeries

Arbor Education

Blackbaud Education Management

Bulle

ClassLink

Classter

Formation Edge

Éduquer par les marques de la communauté

Connexion Edulife

eSchoolData

eSchooling

Eum School SIS

Eventful

FAITS

Focus School Software

Follett Aspen

Furlong Schoolbase

INACAP SDS API

Infinitas Learning

Infinite Campus

inLogic

iSAMS by IRIS

IST

LIBRUS

MySchool

Logiciel Rediker

SIMS

Skool

Ciel

SmartSchool

Synergie de système d'informations sur les élèves

Trivium

Vigilo

Visma InSchool

VULCAN UONET+