A OneRoster API (Application Programming Interfaces) é um formato Padrão da Indústria, da 1EdTech (anteriormente IMS Global), para troca de dados do Sistema de Informação de Estudantes (SIS)/Sistemas de Gestão de Estudantes (SMS). Com este método de sincronização, pode ligar-se diretamente ao seu SIS/SMS através das APIs oneRoster 1.1 baseadas em REST desenvolvidas pelo seu fornecedor de SIS/SMS. O suporte da API permite-lhe sincronizar dados diretamente em vez de utilizar ficheiros CSV (Valores Separados por Vírgulas).
A utilização da API OneRoster para ingerir os dados permite-lhe iluminar as principais capacidades do SDS para aprovisionamento. Também lhe permite melhorar as experiências dos produtos e funcionalidades do Microsoft 365. As APIs do OneRoster são como podemos sincronizar objetos do SIS/SMS que fornecem APIs do OneRoster através da plataforma School Data Sync (SDS).
Para obter mais informações sobre como configurar o seu inquilino para utilizar a API OneRoster como origem, a Ingestão de Dados com a API OneRoster.
O meu fornecedor não está listado na lista pendente e o status aqui diz Teste. O que preciso de fazer para vê-los na lista de fornecedores?
Contacte a equipa de Suporte ao cliente para enviar o seu inquilino e obter acesso aos fornecedores de API atualmente Testar. Partilhe as seguintes informações ao levantar o pedido:
ID do locatário
Nome do Fornecedor Do OneRoster
Versão do SDS
Lista
Assim que o seu inquilino estiver em voo, trabalhe com o seu fornecedor do OneRoster e com a POC do SDS para executar testes e garantir que a integração é bem-sucedida. Se tiver algum problema, trabalhe com o fornecedor e a POC do SDS para resolvê-los.
Assim que o teste for concluído com êxito, o Fornecedor do OneRoster status é atualizado (do modo de teste para sim) e está disponível na lista de fornecedores acessíveis publicamente para todos os inquilinos.
O meu fornecedor não está listado. Existem informações para partilhar com os mesmos para participar como um fornecedor do OneRoster com o SDS?
Partilhe com o seu fornecedor o seguinte artigo Orientação de Inclusão para Fornecedores de API do OneRoster com o SDS. O artigo inclui os passos necessários para pedir a adição como um fornecedor do OneRoster, incluindo testes e validação antes de ser colocado primeiro no modo de teste e, em seguida, eventualmente na lista pública para seleção por inquilinos.
Que pontos finais estão a ser acedidos ao ingerir dados da lista?
A lista seguinte é fornecida para o ajudar a compreender melhor que dados estão a ser acedidos ao ligar ao seu SIS/SMS através da API OneRoster.
Para os dados opcionais para dados demográficos, relações de contacto de estudantes e sinalizadores de utilizadores de estudantes, a capacidade de incluir ou não estes dados será baseada nas capacidades de dados opcionais suportadas do perfil de fornecedor do OneRoster SIS/SMS. Se o Fornecedor de SIS/SMS também suportar estes dados, verá o botão de alternar (predefinição) selecionado Ativado para incluir dados adicionais. Pode selecionar o botão de alternar para desativar, se assim o desejar. Se o botão de alternar estiver indisponível, apresentado mas desativado e não estiver disponível para interação, significa que o perfil do fornecedor não suporta atualmente a disponibilização dos mesmos.
Observação
Se o perfil do fornecedor mostrar os sinalizadores demográficos demográficos, contactos ou utilizadores como indisponíveis e quiser que suportem essa funcionalidade, contacte o seu fornecedor e peça suporte para permitir que o SDS ingira os dados e permita que ative os cenários e experiências suportadas.
Relações de contacto opcionais do estudante do utilizador
A relação de contacto dos estudantes pode ser especificada para os utilizadores de estudantes melhorarem as experiências de educador para comunicação com encarregados de educação e tutores. Os contactos são mais utilizadores que são fornecidos com /utilizadores e a associação a um estudante encontram-se no registo de utilizador do estudante em "agentes".
familyName, givenName e e-mail são necessários para utilizadores com funções de contacto/tutor.
Espera-se que o telefone e sms estejam na E.164 e + têm de ser incluídos. (Exemplo: +1234567890)
Se forem fornecidos dados inversos, de um registo guardião da relação de contacto para um estudante no campo "agentes" dos utilizadores de contacto, estes registos são filtrados.
Sinalizadores demográficos de utilizador opcionais
Os sinalizadores de utilizador podem ser especificados para os utilizadores estudantes indicarem a sua participação num programa ou coorte. Os sinalizadores de utilizador são incluídos (quando verdadeiro para o utilizador) ou não são incluídos se não forem aplicáveis.
Os sinalizadores são especificados como uma extensão de metadados para o utilizador, num campo de metadados, seguindo uma Chave|Par de valores. A chave deve ter o nome microsoft.userFlags e tem de ser formatada como uma lista delimitada por vírgulas. Os sinalizadores de utilizador podem aparecer por qualquer ordem e não são sensíveis a maiúsculas e minúsculas.
Por 1EdTech, é da responsabilidade do fornecedor impor a privacidade dos dados relativamente aos dados disponíveis quando é feito um pedido de dados. O School Data Sync faz um pedido de dados ativos com base na hora do pedido.
Credenciais de acesso à API do OneRoster necessárias
Para ativar a ligação à API OneRoster para o SIS/SMS, tem de fornecer as credenciais de ligação. Para obter mais informações, veja a documentação do seu fornecedor específico para obter ou gerar.
URL de acesso à Web: URL onde a sua API OneRoster está acessível para o seu SIS/SMS
ID de cliente que é utilizado para ligar à API OneRoster do SIS/SMS
Segredo do Cliente que é utilizado para ligar à API oneRoster SIS/SMS
URL do Token de Acesso, se a API OneRoster do SIS/SMS estiver configurada para autenticação com o OAuth2, terá de fornecer o ponto final do URL do Token de Acesso que utilizou para se ligar. O ponto final é diferente do URL de acesso à Web.
Notas e sugestões úteis
Os pontos finais surgem sempre depois de "https://{server_URL}/ims/oneroster/v1p1"
Para impedir que determinadas escolas sejam incluídas nos dados fornecidos do SIS para o SDS, os clientes precisam de trabalhar com o Fornecedor para saber como configurar as escolas incluídas para a ligação/credenciais que estão a ser utilizadas para ligar o SDS ao respetivo SIS.
Os pontos finais têm requisitos no suporte de parâmetros de filtro para permitir a filtragem por status ou ativar a sincronização delta.
O SDS aplica um filtro na propriedade dateLastModified para processamento de sincronização delta/sincronização incremental e é necessário para a integração com o SDS.
Os fornecedores têm de optar por implementar o esquema de autenticação OAuth1(a) ou OAuth 2.0 (concessão de credenciais de cliente). O OAuth 2.0 é preferido.
Se o protocolo de autenticação suportado for "OAuth 2.0" – tipo de concessão de credenciais de cliente, o SDS enviará as credenciais no cabeçalho "Autorização". Conforme recomendado na especificação do OneRoster, enviamos as credenciais de cliente codificadas no cabeçalho Autorização dos pedidos de token.
Detalhes do fornecedor do OneRoster
Aequitas
Fornecedor do SIS
Aequitas Solutions, Inc
Versão mínima do software
3.6.1, Q Web API 3.6.0
Pré-requisitos de configuração
Confira a configuração da API Web Q
Como obter ID do cliente, segredo do cliente e URLs
Contactar o Suporte por Telefone (gratuito): (888) 324-5363 ou support@aeries.com
Arbor Education
Fornecedor do SIS
Arbor Education
Versão mínima do software
N/D
Pré-requisitos de configuração
A integração entre o Arbor MIS e o SDS está ativada no seu Arbor MIS. Contacte o seu gestor de conta na Arbor para se certificar de que está ativado através do accountmanagers@arbor-education.com. Tem de ter um inquilino de educação Office 365, permissões de administrador global e School Data Sync (Plano 1) ativado.
Como obter ID do cliente, segredo do cliente e URLs
Gere no seu Arbor MIS. Os passos a concluir estão detalhados no Centro de Ajuda do Arbor.
Instruções específicas
Contacte a Arbor ou o seu parceiro de suporte dedicado para ajudar a configurar esta integração através do myteam@arbor-education.com.
Help
Encontre artigos de suporte no Centro de Ajuda da Arbor. Para perguntas, contacte myteam@arbor-education.com ou contacte o seu parceiro de suporte dedicado.
Blackbaud Education Management
Fornecedor do SIS
Blackbaud Education Management
Versão mínima do software
A versão mais recente do BEM está sempre disponível para os utilizadores.
Pré-requisitos de configuração
Não aplicável
Como obter ID do cliente, segredo do cliente e URLs
Ao selecionar as definições de mapeamento para os utilizadores Microsoft Entra, certifique-se de que as definições para incluir/excluir o sufixo de domínio correspondem aos nomes de utilizador Microsoft Entra. Esta ação garante os melhores resultados ao corresponder estudantes e professores do BEM aos seus utilizadores Microsoft Entra.
Help
support.blackbaud.com
Bubblecon
Fornecedor do SIS
Bubblecon
Instruções específicas
Contacte a equipa de suporte ao cliente do Bubblecon.
Como obter ID do cliente, segredo do cliente e URLs
Os clientes podem obter as credenciais oAuth a partir da consola depois de adicionarem a aplicação. Um e-mail é enviado para o programador da Microsoft que configurou a aplicação. Selecione Adicionar Aplicações & Modificar Permissões para mostrar a localização para obter o ID de cliente e o segredo.
Se existirem problemas de ligação, certifique-se de que o URL do Web Access tem "/ims/oneroster/v1p1" para apontar para os conectores corretos.
Como obter ID do cliente, segredo do cliente e URLs
Entre em contato com o atendimento ao cliente.
Instruções específicas
Entre em contato com o atendimento ao cliente.
Help
Para obter suporte, contacte educate_support@communitybrands.com.
Conexão Edulife
Fornecedor do SIS
Conexão Edulife
Versão mínima do software
N/D
Pré-requisitos de configuração
N/D
Como obter ID do cliente, segredo do cliente e URLs
Feito diretamente em contacto com a nossa equipa de implementação e suporte.
Instruções específicas
N/D
Help
Contacte o suporte em support@wizkids.co.uk. // 020 7550 9286
eSchoolData
Fornecedor do SIS
eSchoolData
Versão mínima do software
N/D
Pré-requisitos de configuração
Os distritos têm de ser subscritores do produto GURU do eSD.
Como obter ID do cliente, segredo do cliente e URLs
Veja instruções específicas.
Instruções específicas
Para ativar uma integração de API com o SDS, os administradores distritais têm primeiro de criar uma conta de fornecedor no GURU. Navegue para Fornecedores de Configuração > e selecione Criar Novo Fornecedor. Introduza um Nome do Fornecedor e mantenha o ID de Cliente e o Segredo do Cliente que são gerados automaticamente. Indique, juntamente com o URL da API GURU regional, ao configurar a integração do SDS. Selecione Seguinte e ative todas as permissões da API do OneRoster. Selecione Concluir quando terminar para guardar a nova conta.
Help
Para perguntas, contacte a equipa de suporte eSchoolData.
eSchooling
Fornecedor do SIS
eSchooling by Codevision
Versão mínima do software
1.1.20
Pré-requisitos de configuração
Nenhum
Como obter ID do cliente, segredo do cliente e URLs
Siga as instruções na plataforma de eSchooling: System Administration > School Data Sync
Instruções específicas
O mesmo que antes
Help
Contacto suporte@codevision.pt
Eum School SIS
Fornecedor do SIS
DataEum
Versão mínima do software
N/D
Pré-requisitos de configuração
Nenhum
Como obter ID do cliente, segredo do cliente e URLs
Email suporte ao cliente para pedir credenciais da API do OneRoster.
Instruções específicas
Entre em contato com o atendimento ao cliente pbd@dataeum.kr
Help
Entre em contato com o atendimento ao cliente pbd@dataeum.kr
Eventful
Fornecedor do SIS
Eventful
Versão mínima do software
Pode encontrar uma lista de registos de estudantes suportados em Eventful OneRoster.
Pré-requisitos de configuração
Contacte Eventful por e-mail em info@eventful.se ou por telefone através do (+46) 10 209 9001
Como obter ID do cliente, segredo do cliente e URLs
Fornecido no processo de configuração.
Instruções específicas
N/D
Help
Contacte o Suporte Com Eventos por e-mail ou info@eventful.se por telefone através do (+46) 10 209 9001
FATOS
Fornecedor do SIS
FATOS
Versão mínima do software
Não aplicável. A versão mais recente está sempre disponível para os clientes.
Pré-requisitos de configuração
Não aplicável
Como obter ID do cliente, segredo do cliente e URLs
Os clientes inscrevem-se na API do OneRoster e os FACTOS fornecem-lhes estas informações.
Instruções específicas
A partir do SIS, aceda a Configuração do Sistema > Integrações > do SIS API > OneRoster Formulário de preenchimento.>
Help
Suporte ao Cliente 866-800-6593
Software da Escola de Foco
Fornecedor do SIS
Software da Escola de Foco
Versão mínima do software
Foco v 8.7
Pré-requisitos de configuração
N/D
Como obter ID do cliente, segredo do cliente e URLs
No ecrã Portal de concentração, Configure Sistema > configurar > Sistemas de Terceiros. Na linha de inserção de registo, introduza Título: Microsoft Versão 1.0 > Dialeto: OneRoster. Ao guardar, são gerados o URL, o ID de Cliente e o segredo do cliente.
Instruções específicas
N/D
Help
Ligue para a linha de suporte do telefone do Focus em 877-410-6637.
Follett Aspen
Fornecedor do SIS
Follett Aspen
Versão mínima do software
Versão mais recente do Aspen, 5.9
Pré-requisitos de configuração
N/D
Como obter ID do cliente, segredo do cliente e URLs
Contacte o Gestor de Relações com o Cliente do seu distrito para agendar a atualização.
Instruções específicas
N/D
Help
Contacte o Gestor de Relações com o Cliente para obter ajuda.
Base Escolar de Furlong
Fornecedor do SIS
Base Escolar de Furlong
Versão mínima do software
Escolas alojadas apenas com a versão mais recente
Pré-requisitos de configuração
N/D
Como obter ID do cliente, segredo do cliente e URLs
Antes da V 1933.3 - Aceda à interface >> de utilizador infinite Campus selecione Administração >> do Sistema selecione Campus Learning >> selecione Ferramentas >> do OneRoster selecione no OneRoster. Versão 1933.3 e posterior – aceda à interface >> de utilizador infinite Campus selecione Administração >> do Sistema selecione Interoperabilidade de Aprendizagem
Ao selecionar atributos no Infinite Campus para sincronizar, certifique-se de que o período não está selecionado. Se estiver selecionada, existe a possibilidade de gerar um grande número de erros ao sincronizar e bloquear o perfil em quarentena.
Help
Para obter Ajuda, contacte o Gestor de Sucesso do Cliente.
inLogic
Fornecedor do SIS
inLogic
Versão mínima do software
V7.7.510
Pré-requisitos de configuração
N/D
Como obter ID do cliente, segredo do cliente e URLs
Para obter suporte por e-mail, aceda a support@inlogic.dk, para obter suporte por telefone, +45 42 40 88 15 e suporte para a Web, https://www.inlogic.dk/support/.
iSAMS por IRIS
Fornecedor do SIS
iSAMS por IRIS
Versão mínima do software
21.4.23.12
Pré-requisitos de configuração
Nenhum
Como obter ID do cliente, segredo do cliente e URLs
Deve enviar um e-mail para o suporte técnico a pedir credenciais da API do OneRoster em helpdesk@isams.co.uk
Instruções específicas
Nenhum
Help
Contacte o Suporte Técnico do iSAMS para pedir o documento de ajuda em helpdesk@isams.co.uk.
IST
Fornecedor do SIS
IST
Versão mínima do software
Não aplicável.
Pré-requisitos de configuração
Veja instruções específicas.
Como obter ID do cliente, segredo do cliente e URLs
Veja instruções específicas.
Instruções específicas
As informações para a configuração são fornecidas em privado.
Help
Para perguntas, contacte a equipa de suporte do IST.
LIBRUS
Fornecedor do SIS
LIBRUS
Versão mínima do software
Versão atual
Pré-requisitos de configuração
O cliente tem de ter uma licença da LIBRUS Synergia
Como obter ID do cliente, segredo do cliente e URLs
Para ativar uma integração de API com o SDS, tem de ter sessão iniciada como administrador ou diretor escolar. Navegue para Configuração > de Definições > Outras opções > Office 365 Integração
Instruções específicas
Estão disponíveis instruções detalhadas na secção de ajuda.
Help
Contacte a nossa equipa de suporte em pomoc@LIBRUS.pl
MySchool
Fornecedor do SIS
MySchool Ltd
Versão mínima do software
Não aplicável
Pré-requisitos de configuração
Configuração inicial do sistema MySchool assistida através da equipa de suporte.
Como obter ID do cliente, segredo do cliente e URLs
Nenhuma. A integração do OneRoster está ativada para todas as escolas por predefinição.
Como obter ID do cliente, segredo do cliente e URLs
Gerado automaticamente pelo programa quando uma nova escola foi criada. Administração pode gerir as definições de utilizador através da aplicação Gestor de Livros de Notas.
Instruções específicas
Nenhum
Help
As perguntas podem ser direcionadas para GBSupport@rediker.com ou APSupport@rediker.com
SIMS
Fornecedor do SIS
SIMS by Education Software Solutions
Versão mínima do software
SIMS 7 Verão 2019 ou posterior
Pré-requisitos de configuração
É necessária uma conta do ID do SIMS.
Como obter ID do cliente, segredo do cliente e URLs
Como obter ID do cliente, segredo do cliente e URLs
A partir do portal Administração VULCAN; Selecione configuração de troca de API "Configuração" > "definições > de Office 365". Ative a "Sincronização com Office 365". Neste separador, receberá o ID de Cliente, o Segredo do Cliente e os URLs.