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).
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.
Per i dati facoltativi per i dati demografici, le relazioni di contatto degli studenti e i flag utente degli studenti, la possibilità di includere o meno questi dati si baserà sulle funzionalità di dati facoltative supportate dal profilo del provider OneRoster SIS/SMS. Se anche il provider SIS/SMS supporta questi dati, verrà visualizzato l'interruttore (impostazione predefinita) selezionato Sì per includere dati aggiuntivi. Se lo si desidera, è possibile selezionare l'interruttore da disattivare. Se l'interruttore non è disponibile, visualizzato ma disattivato e non disponibile per l'interazione, significa che il profilo del provider non supporta attualmente la fornitura di tali dati.
Nota
Se il profilo del provider mostra i dati demografici, i contatti o i flag demografici degli utenti come non disponibili e si vuole che supportino tale funzionalità, contattare il provider e richiedere l'aggiunta del supporto per consentire a SDS di inserire i dati e consentire di abilitare gli scenari e le esperienze supportate dai dati.
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".
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 1EdTech è responsabilità del provider imporre la privacy dei dati per i dati disponibili quando viene effettuata una richiesta di dati. School Data Sync effettua una richiesta di dati attivi in base all'ora della richiesta.
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
Fornitore SIS
Aequitas Solutions, Inc
Versione minima del software
Q 3.6.1, Q Web API 3.6.0
Prerequisiti di configurazione
Vedere Configurazione dell'API Web Q
Come ottenere ID client, segreto client e URL
Vedere Configurazione dell'API Web Q
Istruzioni specifiche
N/D
Help
Contattare il supporto tecnico all'indirizzo (909) 946-1600
Contattare il supporto telefonico (numero verde): (888) 324-5363 o support@aeries.com
Arbor Education
Fornitore SIS
Arbor Education
Versione minima del software
N/D
Prerequisiti di configurazione
L'integrazione tra Arbor MIS e SDS è abilitata in Arbor MIS. Contattare il responsabile dell'account in Arbor per assicurarsi che sia abilitato tramite accountmanagers@arbor-education.com. È necessario avere un tenant di Office 365 Education, autorizzazioni di amministratore globale e School Data Sync (Piano 1) abilitato.
Come ottenere ID client, segreto client e URL
Generare nel mis Arbor. I passaggi da completare sono descritti in dettaglio nel Centro assistenza Arbor.
Istruzioni specifiche
Contattare Arbor o il partner di supporto dedicato per configurare questa integrazione tramite myteam@arbor-education.com.
Help
Per gli articoli di supporto, vedere Arbor's Help Centre. Per domande, contattare o il partner di myteam@arbor-education.com supporto dedicato.
Blackbaud Education Management
Fornitore SIS
Blackbaud Education Management
Versione minima del software
La versione più recente di BEM è sempre disponibile per gli utenti.
Quando si selezionano le impostazioni di mapping per gli utenti di Microsoft Entra, assicurarsi che le impostazioni per includere/escludere il suffisso di dominio corrispondano ai nomi utente di Microsoft Entra. Questa azione garantisce i migliori risultati quando si associano studenti e insegnanti BEM agli utenti di Microsoft Entra.
Help
support.blackbaud.com
Bubblecon
Fornitore SIS
Bubblecon
Istruzioni specifiche
Contattare il team di supporto clienti di Bubblecon.
I clienti possono ottenere le credenziali oAuth dalla console dopo aver aggiunto l'app. Un messaggio di posta elettronica viene inviato allo sviluppatore di Microsoft che ha configurato l'app. Selezionare l'opzione Aggiunta di applicazioni & Modifica delle autorizzazioni per visualizzare la posizione in cui ottenere l'ID client e il segreto.
In caso di problemi di connessione, assicurarsi che l'URL di accesso Web abbia "/ims/veter/v1p1" per puntare ai connettori corretti.
Per assistenza, contattare educate_support@communitybrands.com.
Edulife Connect
Fornitore SIS
Edulife Connect
Versione minima del software
N/D
Prerequisiti di configurazione
N/D
Come ottenere ID client, segreto client e URL
Operazione eseguita direttamente in contatto con il team di distribuzione e supporto tecnico.
Istruzioni specifiche
N/D
Help
Contattare il supporto tecnico all'indirizzo support@wizkids.co.uk. // 020 7550 9286
eSchoolData
Fornitore SIS
eSchoolData
Versione minima del software
N/D
Prerequisiti di configurazione
I distretti devono essere abbonati al prodotto eSD GURU.
Come ottenere ID client, segreto client e URL
Vedere istruzioni specifiche.
Istruzioni specifiche
Per abilitare l'integrazione di un'API con SDS, gli amministratori distrettuali devono prima creare un account fornitore all'interno di GURU. Passare a Fornitori di configurazione > e selezionare Crea nuovo fornitore. Immettere un nome fornitore e conservare l'ID client e il segreto client generati automaticamente. Specificare, insieme all'URL dell'API GURU a livello di area, quando si configura l'integrazione SDS. Selezionare Avanti e abilitare tutte le autorizzazioni dell'API OneRoster. Selezionare Fine al termine per salvare il nuovo account.
Help
Per domande, contattare il team di supporto di eSchoolData.
eSchooling
Fornitore SIS
eSchooling di Codevision
Versione minima del software
1.1.20
Prerequisiti di configurazione
Nessuno
Come ottenere ID client, segreto client e URL
Seguire le istruzioni nella piattaforma eSchooling: System Administration > School Data Sync
Istruzioni specifiche
Uguale a quello precedente
Help
Contatto suporte@codevision.pt
Eum School SIS
Fornitore SIS
DataEum
Versione minima del software
N/D
Prerequisiti di configurazione
Nessuno
Come ottenere ID client, segreto client e URL
Inviare un messaggio di posta elettronica al supporto clienti per richiedere le credenziali dell'API OneRoster.
Istruzioni specifiche
Contattare il supporto tecnico pbd@dataeum.kr
Help
Contattare il supporto tecnico pbd@dataeum.kr
Eventful
Fornitore SIS
Eventful
Versione minima del software
Un elenco dei registri degli studenti supportati è disponibile in Eventful OneRoster.
Prerequisiti di configurazione
Contatta Eventful via email all'indirizzo info@eventful.se o al telefono (+46) 10 209 9001
Come ottenere ID client, segreto client e URL
Fornito nel processo di installazione.
Istruzioni specifiche
N/D
Help
Contattare il supporto per eventi tramite posta elettronica all'indirizzo info@eventful.se o per telefono al numero (+46) 10 209 9001
FATTI
Fornitore SIS
FATTI
Versione minima del software
Non applicabile. La versione più recente è sempre disponibile per i clienti.
Prerequisiti di configurazione
Non applicabile
Come ottenere ID client, segreto client e URL
I clienti si iscrivono all'API OneRoster e FACTS fornisce queste informazioni.
Istruzioni specifiche
Dall'interno del SIS passare al > modulo di compilazione dell'API > OneRoster di System Configuration > SIS Integrations>.
Help
Supporto tecnico 866-800-6593
Focus School Software
Fornitore SIS
Focus School Software
Versione minima del software
Messa a fuoco v 8.7
Prerequisiti di configurazione
N/D
Come ottenere ID client, segreto client e URL
Nella schermata Del portale di messa a fuoco configurare > i sistemi di terze parti di configurazione > del sistema. Nella riga di inserimento del record immettere Title: Microsoft Version 1.0 > Dialect: OneRoster. Al momento del salvataggio, vengono generati l'URL, l'ID client e il segreto client.
Istruzioni specifiche
N/D
Help
Chiamare la linea di supporto telefonico focus al numero 877-410-6637.
Follett Aspen
Fornitore SIS
Follett Aspen
Versione minima del software
Versione più recente di Aspen, 5.9
Prerequisiti di configurazione
N/D
Come ottenere ID client, segreto client e URL
Per pianificare l'aggiornamento, contattare customer relationship manager per il proprio distretto.
Istruzioni specifiche
N/D
Help
Per assistenza, contattare il customer relationship manager.
INACAP SDS API
Fornitore SIS
INACAP SDS API
Versione minima del software
N/D
Prerequisiti di configurazione
N/D
Come ottenere ID client, segreto client e URL
Sistema locale per INACAP, contattare sistemas@inacap.cl se necessario.
Istruzioni specifiche
N/D
Help
Contattare il supporto di INACAP tramite posta elettronica all'indirizzo sistemas@inacap.cl.
Infinitas Learning
Fornitore SIS
Informat
Versione minima del software
N/D
Prerequisiti di configurazione
N/D
Come ottenere ID client, segreto client e URL
L'ID client e il segreto client verranno forniti dopo aver completato il modulo di assunzione
Prima di V 1933.3 - Passare all'interfaccia >> utente di Infinite Campus selezionare Amministrazione >> sistema selezionare Campus Learning >> selezionare OneRoster Tools (Strumenti >> OneRoster) in OneRoster. Versione 1933.3 e successive - Passare all'interfaccia >> utente di Infinite Campus selezionare Amministrazione >> sistema selezionare Interoperabilità di apprendimento
Quando si selezionano gli attributi all'interno di Infinite Campus da sincronizzare, assicurarsi che il periodo non sia selezionato. Se è selezionato, è possibile che generi un numero elevato di errori durante la sincronizzazione e il blocco del profilo in quarantena.
Help
Per assistenza, contattare customer success manager.
inLogic
Fornitore SIS
inLogic
Versione minima del software
V7.7.510
Prerequisiti di configurazione
N/D
Come ottenere ID client, segreto client e URL
È disponibile una pagina wiki per l'integrazione del cliente in InLogic e Teams.
Istruzioni specifiche
Altre istruzioni per semplificare o ottenere la configurazione di SDS con il SIS sono disponibili in Integrazione di InLogic e Teams.
Help
Per il supporto tramite posta elettronica, passare a support@inlogic.dk, per Supporto telefonico, +45 42 40 88 15 e supporto Web, https://www.inlogic.dk/support/.
iSAMS di IRIS
Fornitore SIS
iSAMS di IRIS
Versione minima del software
21.4.23.12
Prerequisiti di configurazione
Nessuno
Come ottenere ID client, segreto client e URL
È consigliabile inviare un messaggio di posta elettronica al supporto tecnico che richiede le credenziali dell'API OneRoster all'indirizzo helpdesk@isams.co.uk
Istruzioni specifiche
Nessuno
Help
Contattare l'helpdesk iSAMS per richiedere il documento della Guida all'indirizzo helpdesk@isams.co.uk.
IST
Fornitore SIS
IST
Versione minima del software
Non applicabile.
Prerequisiti di configurazione
Vedere istruzioni specifiche.
Come ottenere ID client, segreto client e URL
Vedere istruzioni specifiche.
Istruzioni specifiche
Le informazioni per l'installazione vengono fornite privatamente.
Help
Per domande, contattare il team di supporto IST.
LIBRUS
Fornitore SIS
LIBRUS
Versione minima del software
Versione corrente
Prerequisiti di configurazione
Il client deve avere una licenza per LIBRUS Synergia
Come ottenere ID client, segreto client e URL
Per abilitare l'integrazione dell'API con SDS, è necessario accedere come amministratore o entità dell'istituto di istruzione. Passare a Configurazione > impostazioni > Altre opzioni > Integrazione di Office 365
Istruzioni specifiche
Le istruzioni dettagliate sono disponibili nella sezione della Guida.
Help
Contattare il team di supporto all'indirizzo pomoc@LIBRUS.pl
MySchool
Fornitore SIS
MySchool Ltd
Versione minima del software
Non applicabile
Prerequisiti di configurazione
Configurazione iniziale del sistema MySchool assistita tramite il team di supporto.
Nessuna. L'integrazione di OneRoster è abilitata per tutte le scuole per impostazione predefinita.
Come ottenere ID client, segreto client e URL
Generato automaticamente dal programma quando è stata creata una nuova scuola. L'amministratore può gestire le impostazioni utente tramite l'applicazione Gradebook Manager.
Istruzioni specifiche
Nessuno
Help
Le domande possono essere indirizzate a GBSupport@rediker.com o APSupport@rediker.com
Dal portale di amministrazione di VULCAN; Selezionare "Configurazione" > "Impostazioni di Office 365" > Configurazione dello scambio API. Abilitare "Sincronizzazione con Office 365". In questa scheda vengono visualizzati l'ID client, il segreto client e gli URL.
Istruzioni specifiche
N/D
Help
Contattare il supporto tecnico durante https://vulcan.edu.pl gli orari di ufficio standard.