Panoramica del provider OneRoster

L'API OneRoster (Application Programming Interfaces) è un formato standard del settore, da 1EdTech (in precedenza IMS Global), per lo scambio di dati SIS (Student Information System) o SMS (Student Management Systems). Usando questo metodo di sincronizzazione, è possibile connettersi direttamente al SIS/SMS usando le API OneRoster 1.1 basate su REST sviluppate dal provider SIS/SMS. Il supporto dell'API consente di sincronizzare i dati direttamente invece di usare file CSV (valori delimitati da virgole).

L'uso dell'API OneRoster per inserire i dati consente di illuminare le funzionalità SDS di base per il provisioning. Consente anche di migliorare le esperienze dei prodotti e delle funzionalità di Microsoft 365. Le API OneRoster consentono di sincronizzare gli oggetti da SIS/SMS che forniscono API OneRoster tramite la piattaforma School Data Sync (SDS).

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

Stato e funzionalità dei provider OneRoster

Il provider non è elencato nell'elenco a discesa e lo stato è Test. Cosa è necessario fare per visualizzarli nell'elenco dei provider?

• Contattare il team di supporto clienti per eseguire il flight del tenant e ottenere l'accesso ai provider DI API attualmente testati. Condividere le informazioni seguenti durante la generazione della richiesta:

  • ID del Tenant
  • Nome del provider OneRoster
  • Versione di SDS
  • Ruolino

• Dopo aver eseguito il flight del tenant, collaborare con il provider OneRoster e il poc SDS per eseguire i test e assicurarsi che l'integrazione riesca. Se si verificano problemi, collaborare con il provider e il poc SDS 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 provider non è elencato. Sono disponibili informazioni da condividere con loro per partecipare come provider OneRoster con SDS?

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

A quali endpoint si accede quando si inseriiscono i dati del roster?

• L'elenco seguente consente di comprendere meglio i dati a cui si accede quando ci si connette al SIS/SMS tramite l'API OneRoster.

Endpoint API necessari per SDS

Endpoint API facoltativi per SDS

Relazioni di contatto facoltative tra studenti utente

La relazione di contatto tra studenti può essere specificata per consentire agli utenti degli studenti di migliorare le esperienze di docente per la comunicazione con genitori e tutori. I contatti sono più utenti forniti con /users e l'associazione a uno studente si trovano nel record utente dello studente in "agenti".

• Per altre informazioni, vedere i ruoli di relazione di contatto degli studenti supportati supportati da SDS , vedere Elenco predefinito di valori: ruoli di relazione di contatto.

• FamilyName, givenName e posta elettronica sono necessari per gli utenti con ruoli di contatto/tutore.

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

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

Flag facoltativi per i dati demografici degli utenti

I flag utente possono essere specificati per consentire agli utenti degli studenti di indicare la loro partecipazione a un programma o a una coorte. I flag utente sono inclusi (se true per l'utente) o non inclusi se non applicabile.

I flag vengono specificati come estensione di metadati per l'utente, in un campo di metadati, seguendo una chiave|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 , vedere Elenco predefinito di valori: flag utente.

Esempio:

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

Credenziali di accesso all'API OneRoster necessarie

Per abilitare la connessione all'API OneRoster per SIS/SMS, è necessario specificare le credenziali di connessione. Per altre informazioni, vedere la documentazione del provider specifico per ottenere o generarli.

• 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 del token di accesso, se l'API OneRoster SIS/SMS è configurata per l'autenticazione tramite OAuth2, è necessario fornire l'endpoint URL del token di accesso usato per la connessione. L'endpoint è diverso dall'URL di accesso Web.

Note e suggerimenti utili

• Gli endpoint vengono sempre dopo 'https://{server_URL}/ims/esistenti/v1p1'
• Per evitare che determinate scuole vengano incluse nei dati forniti dal SIS a SDS, i clienti devono collaborare con il provider per configurare quali scuole sono incluse per la connessione o le credenziali usate 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 differenziale.
• SDS applica un filtro alla proprietà dateLastModified per l'elaborazione della sincronizzazione differenziale/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). È preferibile usare OAuth 2.0.
• Se il protocollo di autenticazione supportato è "OAuth 2.0" - tipo di concessione delle credenziali client, SDS invierà le credenziali nell'intestazione "Authorization". Come consigliato nella specifica OneRoster, le credenziali client codificate vengono inviate nell'intestazione Authorization delle richieste di token.

Dettagli del provider OneRoster

Aequita

Aeries

Arbor Education

Blackbaud Education Management

Bubblecon

ClassLink

Classificatore

Edge Learning

Educate by Community Brands

Edulife Connect

eSchoolData

eSchooling

Eum School SIS

Eventful

FATTI

Focus School Software

Follett Aspen

Scuola di Furlong

INACAP SDS API

Infinitas Learning

Infinite Campus

inLogic

iSAMS di IRIS

IST

LIBRUS

MySchool

Rediker Software

SIMS

Skool

Skyward

SmartSchool

Sis sinergico

Trivium

Vigilo

Visma InSchool

VULCAN UONET+