Обзор поставщика OneRoster

OneRoster API (Интерфейсы программирования приложений) — это отраслевой формат Standard, от 1EdTech (ранее IMS Global), для обмена данными системы информации о учащихся (SIS) и системах управления учащимися (SMS). С помощью этого метода синхронизации можно подключаться непосредственно к SIS/SMS с помощью ИНТЕРФЕЙСОВ API OneRoster 1.1 на основе REST, разработанных поставщиком SIS/SMS. Поддержка API позволяет синхронизировать данные напрямую, а не использовать csv-файлы (значения с разделимы-запятыми).

Использование API OneRoster для приема данных позволяет активировать основные возможности SDS для подготовки. Это также позволяет улучшить возможности продуктов и функций Microsoft 365. API OneRoster — это способ синхронизации объектов из SIS/SMS, которые предоставляют API OneRoster через платформу School Data Sync (SDS).

Дополнительные сведения о настройке клиента для использования API OneRoster в качестве источника см. в статье Прием данных с помощью API OneRoster.

Состояние и возможности поставщиков OneRoster

Мой поставщик не указан в раскрывающемся списке, а состояние здесь указано Тест. Что нужно сделать, чтобы просмотреть их в списке поставщиков?

• Обратитесь в службу поддержки клиентов , чтобы провести тестирование клиента и получить доступ к поставщикам API, которые в настоящее время тестируются. При вызове запроса делитесь следующими сведениями:

  • Идентификатор клиента
  • Имя поставщика OneRoster
  • Версия SDS
  • Список

• После запуска клиента обратитесь к поставщику OneRoster и службе POC SDS, чтобы выполнить тесты и убедиться, что интеграция прошла успешно. Если у вас возникла какая-либо проблема, обратитесь к поставщику и поставщику служб контроля SDS, чтобы устранить их.

• После успешного выполнения теста состояние поставщика OneRoster обновляется (с тестового режима на да) и доступно в списке общедоступных поставщиков для всех клиентов.

Мой поставщик отсутствует в списке. Есть ли информация, поделиться с ними для участия в качестве поставщика OneRoster с SDS?

• Поделитесь со своим поставщиком следующей статьей Руководство по подключению для поставщиков API OneRoster с помощью SDS. В этой статье описаны шаги, необходимые для запроса на добавление в качестве поставщика OneRoster, включая тестирование и проверку, прежде чем сначала поместить в тестовый режим, а затем в общедоступный список для выбора клиентами.

К каким конечным точкам осуществляется доступ при приеме данных реестра?

• Следующий список поможет вам лучше понять, к каким данным обращается при подключении к SIS/SMS через API OneRoster.

Обязательные конечные точки API для SDS

Необязательные конечные точки API для SDS

Необязательные связи контактов учащихся-пользователей

Контактная связь учащихся может быть указана для пользователей учащихся, чтобы улучшить взаимодействие преподавателей с родителями и опекунами. Контакты — это больше пользователей, которые предоставляются вместе с /users, а связь с учащимся находится в пользовательской записи учащегося в разделе "агенты".

• Дополнительные сведения см. в статье Поддерживаемые роли связи с учащимися, поддерживаемые SDS, см. в разделе Список значений по умолчанию: Роли связи контактов.

• familyName, givenName и электронная почта необходимы для пользователей, имеющих роли контакта или опекуна.

• Ожидается, что телефон и sms должны быть указаны в E.164 и + должны быть включены. (Пример: +1234567890)

• Если предоставляются обратные данные, из записи опекуна контактных отношений до учащегося в поле "агенты" контактных пользователей эти записи отфильтровываются.

Необязательные флаги демографических данных пользователей

Флаги пользователей могут быть указаны для учащихся, чтобы указать их участие в программе или когорте. Флаги пользователей включаются (если значение true для пользователя) или не включаются, если это неприменимо.

Флаги указываются как расширение метаданных для пользователя в поле метаданных после ключа |Пара "Значение". Ключ должен иметь имя microsoft.userFlags и должен быть отформатирован как список с разделителями-запятыми. Флаги пользователей могут отображаться в любом порядке и не учитывает регистр.

Дополнительные сведения см. в списке значений пользовательских флагов по умолчанию, поддерживаемых SDS , см. в разделе Список значений по умолчанию: пользовательские флаги.

Пример:

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

Необходимые учетные данные для доступа к API OneRoster

Чтобы включить подключение к API OneRoster для SIS/SMS, необходимо указать учетные данные подключения. Дополнительные сведения см. в документации конкретного поставщика, чтобы получить или создать их.

• URL-адрес веб-доступа: URL-адрес, по которому API OneRoster доступен для SIS/SMS.

• Идентификатор клиента, используемый для подключения к API OneRoster SIS/SMS

• Секрет клиента, используемый для подключения к API OneRoster SIS/SMS

• URL-адрес маркера доступа. Если api OneRoster SIS/SMS настроен для проверки подлинности с помощью OAuth2, необходимо указать конечную точку URL-адреса маркера доступа, которая использовалась для подключения. Конечная точка отличается от URL-адреса веб-доступа.

Полезные примечания и советы

• Конечные точки всегда поступают после https://{server_URL}/ims/oneroster/v1p1.
• Чтобы предотвратить включение определенных учебных заведений в данные, предоставляемые из SIS в SDS, клиентам необходимо поработать со своим поставщиком, чтобы настроить, какие учебные заведения включены для подключения или учетных данных, используемых для связывания SDS с их SIS.
• Конечные точки имеют требования к поддержке параметров фильтра, чтобы разрешить фильтрацию по состоянию или включить разностную синхронизацию.
• SDS применяет фильтр к свойству dateLastModified для разностной синхронизации или добавочной синхронизации и требуется для интеграции с SDS.
• Поставщики должны реализовать схему проверки подлинности OAuth1(a) или OAuth 2.0 (предоставление учетных данных клиента). OAuth 2.0 является предпочтительным.
• Если поддерживается протокол проверки подлинности "OAuth 2.0" — тип предоставления учетных данных клиента, SDS будет отправлять учетные данные в заголовке "Авторизация". Как и рекомендуется в спецификации OneRoster, мы отправим закодированные учетные данные клиента в заголовке Authorization запросов маркеров.

Сведения о поставщике OneRoster

Aequitas

Aeries

Arbor Education

Blackbaud Education Management

Bubblecon

ClassLink

Классировщик

Edge Learning

Обучение по брендам сообщества

Edulife Connect

eSchoolData

eSchooling

Eum School SIS

Eventful

ДАННЫЕ

Focus School Software

Фоллетт Аспен

Школа Furlong

INACAP SDS API

Обучение Infinitas

Infinite Campus

inLogic

iSAMS от IRIS

IST

LIBRUS

MySchool

Rediker Software

SIMS

Skool

Skyward

SmartSchool

Synergy SIS

Trivium

Vigilo

Visma InSchool

VULCAN UONET+