Прием данных с помощью API OneRoster

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

Доступ к данным с помощью School Data Sync

Важно!

Подключая данные учреждений и делая их доступными с помощью School Data Sync, вы подтверждаете, что имеете право делиться данными с корпорацией Майкрософт и обязуетесь соблюдать стандарты управления данными вашей организации.

Академические сессии

Действие	URL-адрес	Обязательные свойства фильтра	Необязательный или рекомендуемый фильтр	Примеры
GetAllAcademicSessions	/academicSessions	status	dateLastModified	/academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}'

Организаций

Действие	URL-адрес	Обязательные свойства фильтра	Необязательный или рекомендуемый фильтр	Примеры
GetAllOrgs	/orgs	status	dateLastModified	/orgs?offset=0&limit=5000&filter=status='active'/orgs?filter=dateLastModified>'{deltaDateTime}'

пользователи

Действие	URL-адрес	Обязательные свойства фильтра	Необязательный или рекомендуемый фильтр	Примеры
GetAllUsers	/Пользователей	status	dateLastModified	/users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}'

занятия

Действие	URL-адрес	Обязательные свойства фильтра	Необязательный или рекомендуемый фильтр	Примеры
GetAllClasses	/Классы	status	dateLastModified	/classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}'

Регистрации

Действие	URL-адрес	Обязательные свойства фильтра	Необязательный или рекомендуемый фильтр	Примеры
GetAllEnrollments	/Регистрации	status	dateLastModified	/enrollments?offset=0&limit=5000&filter='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'

Курсы

Действие	URL-адрес	Обязательные свойства фильтра	Необязательный или рекомендуемый фильтр	Примеры
GetAllCourses	/Курсы	status	dateLastModified	/courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'

Демография

Необязательные данные

Действие	URL-адрес	Обязательные свойства фильтра	Необязательный или рекомендуемый фильтр	Примеры
GetAllDemographics	/Демография	status	dateLastModified	/demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'

Настройка SDS для клиента Microsoft 365 для образования

• клиент Microsoft 365 для образования
• Требуются разрешения глобального администратора

Доступ к SDS и первый вход

Чтобы получить доступ к порталу SDS Администратор, запустите веб-браузер, перейдите к sds.microsoft.com, а затем войдите в систему с помощью учетной записи Microsoft 365 Global Администратор.

1. Нажмите кнопку Начать.

   

2. Нажмите Продолжить.

   

   Предоставьте несколько минут для подготовки служб к клиенту перед следующим шагом.

   

3. Выберите Создать новый входящий поток. Нажмите кнопку Далее, чтобы продолжить.

   

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

5. Выберите формат. Для API OneRoster выберите параметр API. Нажмите кнопку Далее, чтобы продолжить.

   

   

6. Необходимо выбрать поставщика SIS/SMS в списке поставщиков. Выбрав этот флажок, нажмите кнопку Далее , чтобы продолжить.

   

   Примечание.

   Если вашего поставщика SIS/SMS нет в списке, инструкции по участию в пилотном тестировании или сведения, которые нужно отправить поставщику, см. в статье Общие сведения о поставщике OneRoster .

7. Чтобы включить подключение к SIS/SMS, необходимо указать учетные данные подключения.

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

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

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

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

   • Нажмите кнопку Далее, чтобы продолжить.

   

8. Далее мы проверяем подключение к SIS/SMS на основе сведений, введенных на последнем экране.

   

   • Если проблем нет, вы получите уведомление и можете нажать кнопку Далее , чтобы продолжить.

   • Если нам не удается установить подключение, вы получите уведомление и сможете нажать кнопку Назад , чтобы просмотреть и обновить предоставленные сведения.

   

9. Выберите текущий учебный год и укажите понятное имя, например 2023 или 2022–2023. (Символы должны быть utf8 или будут автоматически удалены).

   Важно!

   Учебный год используется для связывания входящих данных для создания исторических данных за год. Подход сопоставляется с учебным годом и календарным годом. Если ваш учебный год охватывает календарный год, например, начинается 15.08.2022 и заканчивается 15.06.2023, то выбранным значением учебного года будет окончание 2023 года. Дополнительные сведения см. в разделе Обработка учебного года.

   Введите даты начала и окончания учебного года.

   В зависимости от поддерживаемых дополнительных возможностей данных от поставщика вы увидите переключатель Вкл. (по умолчанию) для включения других данных. При желании можно выбрать переключатель, чтобы отключить его. Если переключатель отключен и недоступен для включения, это означает, что профиль поставщика в настоящее время не поддерживает предоставление необязательных данных. Дополнительные сведения о том, поддерживает ли поставщик отправку необязательных данных, см. в статье Общие сведения о поставщике API OneRoster.

   Введите дату прекращения синхронизации данных SDS на основе определенного учебного года для этого источника. Чаще всего синхронизация данных о дате окончания учебного года, которую вы только что ввели, перестают синхронизировать.

   Нажмите кнопку Далее, чтобы продолжить.

   

10. Выберите параметры правила удостоверений пользователей. Сделайте выбор для ролей сотрудников и учащихся.

    Примечание.

    Сопоставление пользователей выполняется с входящим потоком и не записывает и не обновляет пользовательские объекты в Microsoft Entra ID. Сопоставление выполняется и сохраняется в озере данных для образовательных учреждений. Дополнительные сведения см. в статье Управление пользователями в Microsoft 365 о записи ссылки на соответствие с исходящим потоком.

    • Атрибут из источника: атрибут пользователя на основе данных, поступающих из SIS/SMS.
      • Доступные параметры источника: Имя пользователя и Email.
    • Атрибут для сопоставления: свойство пользователя в Microsoft Entra ID для сопоставления.
      • Доступные Microsoft Entra ID варианты сопоставления: UserPrincipalName и Mail.
    • (НЕОБЯЗАТЕЛЬНО) Если данные пользователя не содержат значение @domain , выберите домен из списка.

    Предупреждение

    Выбор домена необязателен и должен использоваться только в том случае, если входящие данные на основе выбранного атрибута из источника не содержат значение @domain . SDS не проверка и не добавляет, если значение отсутствует в записи. SDS добавит выбранный домен ко всем записям, что может привести к @domain@domain и не найти совпадений в этих экземплярах для существующего сопоставления пользователей с пользователями в Microsoft Entra ID.

    Предостережение

    Если пользователи SIS или SMS, например пользователи в группе ролей персонала, могут быть связаны с @domain1 , @domain2 или @domain3 , в исходные данные должен быть включен @domain на основе выбранного атрибута из выбранного источника (например, prefix@domain). Это необходимо для того, чтобы атрибут соответствовал: UserPrincipalName или Mail, чтобы найти правильный Microsoft Entra пользователя, с которым нужно сопоставить.

    Спецификация API OneRoster версии 1.1 разрешает передачу только одной роли на пользователя. Если она связана с несколькими организациями, она может передавать одну и ту же роль только для пользователя нескольким организациям. Так как одна роль на организацию, записи помечаются как isPrimary "True".

    Важно!

    При настройке потока Управления пользователями в Microsoft 365 эти правила используются, если активируется параметр Create unmatched users (Создание несоответсвованных пользователей), чтобы определить конструкцию для свойства Microsoft Entra UserPrincipalName.

    После того как вы будете удовлетворены выбранными параметрами, нажмите кнопку Далее , чтобы продолжить.

    

11. Просмотр сведений, представленных на странице Просмотр и создание. Если все выглядит правильно, нажмите кнопку Далее . В противном случае вы сможете вернуться к правильному.

    

    

12. Поток входящих данных создан, и первый запуск ожидается, нажмите кнопку Готово . Проверьте состояние первого запуска.

    

    

    Совет

    Вы можете настроить конфигурацию управления данными сразу после определения конфигурации данных Connect, во время активного первого запуска или позже после завершения первого запуска.

13. Чтобы проверка о состоянии выполнения, вернитесь на страницу домашней панели мониторинга.

    Если проблемы с данными отсутствуют, на панели мониторинга "Главная" отобразится сообщение "Нет ошибок данных или предупреждений найдено" и "Во время последнего запуска не произошло никаких ошибок или предупреждений данных. Продолжайте большую работу!"

    Если с вашими данными обнаружены проблемы, на панели мониторинга "Главная" отображается сообщение "Мы обнаружили некоторые проблемы с вашими данными" и рекомендуется исследовать работоспособность синхронизации.