Panoramica del provider OneRoster

OneRoster API (Application Programming Interfaces) è un formato Industry Standard, di 1EdTech (ex IMS Global), per lo scambio di dati del sistema informativo degli studenti (SIS) / dei sistemi di gestione degli studenti (SMS). Con questo metodo di sincronizzazione, è possibile connettersi direttamente a SIS/SMS usando le API OneRoster 1.1 basate su REST sviluppate dal provider SIS/SMS. Il supporto API consente di sincronizzare i dati direttamente invece di utilizzare file CSV (Comma Separated Value).

L'uso dell'API OneRoster per inserire i dati consente di illuminare le funzionalità SDS di base per il provisioning. Consente anche di migliorare l'esperienza dei prodotti e delle funzionalità di Microsoft 365. Le API OneRoster sono il modo in cui è possibile sincronizzare gli oggetti da SIS/SMS che fornisce le API OneRoster tramite la piattaforma School sincronizzazione dati (SDS).

Per altre informazioni su come configurare il tenant per usare l'API OneRoster come origine, Inserimento dati con API OneRoster.

Stato e funzionalità dei provider OneRoster

Il mio provider non è elencato nell'elenco a discesa e lo stato qui dice Test. Cosa devo fare per vederli nell'elenco dei provider?

• Contatta il team di supporto tecnico per distribuire la versione di anteprima del tenant e ottenere l'accesso ai provider API attualmente in fase di test. Quando si genera la richiesta, condividere le informazioni seguenti:

  • ID del Tenant
  • Nome provider OneRoster
  • Versione SDS
  • Elenco partecipanti

• Dopo la distribuzione della versione di anteprima del tenant, collaborare con il provider di OneRoster e SDS POC per eseguire test e garantire la riuscita dell'integrazione. Se si verificano problemi, collaborare con il provider e SDS POC per risolverli.

• Una volta completato il test, lo stato del provider OneRoster viene aggiornato (dalla modalità di test a sì) e disponibile nell'elenco dei provider accessibili pubblicamente per tutti i tenant.

Il mio provider non è elencato. Sono disponibili informazioni da condividere con loro per partecipare come provider OneRoster con SDS?

• Condividere con il provider l'articolo seguente : Linee guida per l'onboarding per i provider API OneRoster con SDS. L'articolo include i passaggi necessari per richiedere l'aggiunta come provider OneRoster, inclusi test e convalida prima di essere inserito prima in modalità di test e quindi infine nell'elenco pubblico per la selezione da parte dei tenant.

A quali endpoint si accede durante l'inserimento dei dati dell'elenco?

• L'elenco seguente viene fornito per aiutarti a capire meglio a quali dati si accede quando ti connetti al tuo SIS/SMS tramite l'API OneRoster.

Endpoint API necessari per SDS

Endpoint API facoltativi per SDS

Relazioni di contatto utente-studente facoltative

La relazione di contatto con gli studenti può essere specificata per gli utenti studenti per migliorare le esperienze dei docenti per la comunicazione con genitori e tutori. I contatti sono più utenti a cui viene fornito l'/users e l'associazione a uno studente si trova nel record utente dello studente in "agenti".

• Per altre informazioni, vedere i ruoli delle relazioni di contatto con gli studenti supportati da SDS Vedere Elenco di valori predefinito: Ruoli delle relazioni di contatto.

• FamilyName, givenName e l'indirizzo e-mail sono necessari per gli utenti con ruoli di contatto/tutore.

• Aspettati che il telefono e gli sms siano in E.164 e + devono essere inclusi. (Esempio: +1234567890)

• Se vengono forniti dati inversi, da un record del tutore della relazione di contatto allo studente nel campo "agenti" degli utenti del contatto, questi record vengono filtrati.

Flag demografici utente facoltativi

È possibile specificare flag utente per gli utenti studenti per indicare la loro partecipazione a un programma o a una coorte. I flag utente vengono inclusi (se vero per l'utente) o non vengono inclusi se non applicabili.

I flag sono specificati come estensione di metadati per l'utente, in un campo di metadati, dopo un Key|Coppia di valori. La chiave deve essere denominata microsoft.userFlags e deve essere formattata come elenco delimitato da virgole. I flag utente possono essere visualizzati in qualsiasi ordine e non fanno distinzione tra maiuscole e minuscole.

Per altre informazioni, vedere l'elenco predefinito dei valori dei flag utente supportati da SDS e vedere Elenco di valori predefinito: flag utente.

Esempio:

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

Sono necessarie le credenziali di accesso all'API OneRoster

Per abilitare la connessione all'API OneRoster per SIS/SMS, è necessario fornire le credenziali di connessione. Per ulteriori informazioni, consultare la documentazione specifica del provider per ottenerle o generarle.

• URL di accesso Web: URL in cui l'API OneRoster è accessibile per SIS/SMS

• ID client usato per connettersi all'API OneRoster SIS/SMS

• Segreto client usato per connettersi all'API OneRoster SIS/SMS

• URL token di accesso, se l'API OneRoster SIS/SMS è configurata per l'autenticazione tramite OAuth2, è necessario specificare l'endpoint URL token di accesso usato per la connessione. L'endpoint è diverso dall'URL di accesso Web.

Note e suggerimenti utili

• Gli endpoint vengono sempre inseriti dopo "https://{server_URL}/ims/oneroster/v1p1"
• Per evitare che determinati istituti di istruzione siano inclusi nei dati forniti dal SIS a SDS, i clienti devono collaborare con il proprio provider per configurare quali istituti sono inclusi per la connessione/le credenziali utilizzate per collegare SDS al proprio SIS.
• Gli endpoint hanno requisiti per il supporto dei parametri di filtro per consentire il filtro in base allo stato o per abilitare la sincronizzazione delta.
• SDS applica un filtro alla proprietà dateLastModified per l'elaborazione di sincronizzazione delta/incrementale ed è necessario per l'integrazione con SDS.
• I provider devono scegliere di implementare lo schema di autenticazione OAuth1(a) o OAuth 2.0 (concessione delle credenziali client). OAuth 2.0 è preferibile.
• Se il protocollo di autenticazione supportato è "OAuth 2.0", ovvero il tipo di concessione delle credenziali client, SDS invierà le credenziali nell'intestazione "Authorization". Come raccomandato nella specifica di OneRoster, inviamo le credenziali client codificate nell'intestazione Authorization delle richieste di token.

Dettagli del provider OneRoster

Aequitas

Aeries

Dati IA

Arbor Education

Blackbaud Education Management

Bubblecon

ClassLink

Classter

Edge Learning

Educa con i marchi della community

Edulife Connect

eSchoolData

eSchooling

Eventful

FATTI

Focus Software per istituti di istruzione

Follett Aspen

Base scolastica di Furlong

INACAP SDS API

Apprendimento infinito

Infinite Campus

inLogic

iSAMS di IRIS

IST

LIBRUS

MySchool

Rediker Software

SIMS

Skool

Skyward

SmartSchool

Sis sinergico

Trivium

Vigilo

Visma InSchool

VULCAN UONET+