OneRoster API (Интерфейсы программирования приложений) — это отраслевой стандартный формат, от 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.
Мой поставщик не указан в раскрывающемся списке, а состояние здесь указано Тест. Что нужно сделать, чтобы просмотреть их в списке поставщиков?
Обратитесь в службу поддержки клиентов , чтобы провести тестирование клиента и получить доступ к поставщикам API, которые в настоящее время тестируются. При вызове запроса делитесь следующими сведениями:
Идентификатор клиента
Имя поставщика OneRoster
Версия SDS
Список
После запуска клиента обратитесь к поставщику OneRoster и службе POC SDS, чтобы выполнить тесты и убедиться, что интеграция прошла успешно. Если у вас возникла какая-либо проблема, обратитесь к поставщику и поставщику служб контроля SDS, чтобы устранить их.
После успешного выполнения теста состояние поставщика OneRoster обновляется (с тестового режима на да) и доступно в списке общедоступных поставщиков для всех клиентов.
Мой поставщик отсутствует в списке. Есть ли информация, поделиться с ними для участия в качестве поставщика OneRoster с SDS?
Поделитесь со своим поставщиком следующей статьей Руководство по подключению для поставщиков API OneRoster с помощью SDS. В этой статье описаны шаги, необходимые для запроса на добавление в качестве поставщика OneRoster, включая тестирование и проверку, прежде чем сначала поместить в тестовый режим, а затем в общедоступный список для выбора клиентами.
К каким конечным точкам осуществляется доступ при приеме данных реестра?
Следующий список поможет вам лучше понять, к каким данным обращается при подключении к SIS/SMS через API OneRoster.
Для дополнительных фрагментов данных для демографических данных, связей контактов учащихся и флагов пользователей учащиеся возможность включать эти данные или не включать эти данные будет зависеть от поддерживаемых дополнительных возможностей данных из вашего профиля поставщика OneRoster SIS/SMS. Если поставщик SIS/SMS также поддерживает эти данные, вы увидите переключатель (по умолчанию ) для включения дополнительных данных. При желании можно выбрать переключатель, чтобы отключить его. Если переключатель недоступен, отображается, но отключен и недоступен для взаимодействия, это означает, что профиль поставщика в настоящее время не поддерживает предоставление этих данных.
Примечание.
Если в профиле поставщика отображаются демографические данные, контакты или демографические флаги пользователей как недоступные и вы хотите, чтобы они поддерживали эту функцию, обратитесь к поставщику и запросите добавление поддержки, чтобы включить SDS для приема данных и разрешить вам сценарии и возможности, поддерживаемые данными.
Необязательные связи контактов учащихся-пользователей
Контактная связь с учащимися может быть указана для пользователей учащихся, чтобы улучшить взаимодействие преподавателей с родителями и опекунами. Контакты — это больше пользователей, которые предоставляются с /users, а связь с учащимся находится в пользовательской записи учащегося в разделе "агенты".
familyName, givenName и электронная почта необходимы для пользователей, имеющих роли контакта или опекуна.
Ожидается, что телефон и sms должны быть указаны в E.164 и + должны быть включены. (Пример: +1234567890)
Если предоставляются обратные данные, из записи опекуна контактных отношений до учащегося в поле "агенты" контактных пользователей эти записи отфильтровываются.
Необязательные флаги демографических данных пользователей
Флаги пользователей могут быть указаны для учащихся, чтобы указать их участие в программе или когорте. Флаги пользователей включаются (если значение true для пользователя) или не включаются, если это неприменимо.
Флаги указываются как расширение метаданных для пользователя в поле метаданных после ключа |Пара "Значение". Ключ должен иметь имя microsoft.userFlags и должен быть отформатирован как список с разделителями-запятыми. Флаги пользователей могут отображаться в любом порядке и не учитывать регистр.
В 1EdTech поставщик несет ответственность за обеспечение конфиденциальности данных для того, какие данные доступны при запросе данных. Служба синхронизации данных учебного заведения выполняет запрос на активные данные в зависимости от времени запроса.
Необходимые учетные данные для доступа к 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
Поставщик SIS
Aequitas Solutions, Inc
Минимальная версия программного обеспечения
Вопрос 3.6.1, Q Web API 3.6.0
Предварительные требования к настройке
См. раздел Настройка веб-API Q
Как получить идентификатор клиента, секрет клиента и URL-адреса
См. раздел Настройка веб-API Q
Конкретные инструкции
Н/Д
Справка
Обратитесь в службу поддержки по телефону (909) 946-1600
Обратитесь в службу поддержки по телефону (бесплатный номер): (888) 324-5363 или support@aeries.com
Arbor Education
Поставщик SIS
Arbor Education
Минимальная версия программного обеспечения
Н/Д
Предварительные требования к настройке
Интеграция между Arbor MIS и SDS включена в Arbor MIS. Обратитесь к менеджеру по работе с клиентами в Arbor, чтобы убедиться, что он включен через accountmanagers@arbor-education.com. Необходимо включить клиент Office 365 для образовательных учреждений, разрешения глобального администратора и синхронизацию данных учебного заведения (план 1).
Как получить идентификатор клиента, секрет клиента и URL-адреса
Создайте в Arbor MIS. Действия, которые необходимо выполнить, описаны в справочном центре Arbor.
Конкретные инструкции
Обратитесь в Arbor или к вашему партнеру по поддержке, чтобы помочь в настройке этой интеграции через myteam@arbor-education.com.
Справка
Статьи поддержки см. в справочном центре Arbor. Для получения вопросов обратитесь к или к вашему партнеру myteam@arbor-education.com по поддержке.
Blackbaud Education Management
Поставщик SIS
Blackbaud Education Management
Минимальная версия программного обеспечения
Последняя версия BEM всегда доступна пользователям.
Предварительные требования к настройке
Неприменимо
Как получить идентификатор клиента, секрет клиента и URL-адреса
При выборе параметров сопоставления для пользователей Microsoft Entra убедитесь, что параметры включают или исключают суффикс домена, соответствующий вашим Microsoft Entra именам пользователей. Это действие обеспечивает наилучшие результаты при сопоставлении учащихся и преподавателей BEM с пользователями Microsoft Entra.
Как получить идентификатор клиента, секрет клиента и URL-адреса
Клиенты могут получить свои учетные данные oAuth из консоли после добавления приложения. Электронное письмо — разработчику корпорации Майкрософт, который настроит приложение. Выберите Добавление приложений & Изменение разрешений , чтобы отобразить расположение для получения идентификатора и секрета клиента.
Если при подключении возникают проблемы, убедитесь, что URL-адрес веб-доступа содержит "/ims/oneroster/v1p1", чтобы указать на правильные соединители.
Как получить идентификатор клиента, секрет клиента и URL-адреса
Обратитесь в службу поддержки клиентов.
Конкретные инструкции
Обратитесь в службу поддержки клиентов.
Справка
Для получения поддержки обратитесь в .educate_support@communitybrands.com
Edulife Connect
Поставщик SIS
Edulife Connect
Минимальная версия программного обеспечения
Недоступно
Предварительные требования к настройке
Н/Д
Как получить идентификатор клиента, секрет клиента и URL-адреса
Выполняется напрямую при контакте с нашей группой развертывания и поддержки.
Конкретные инструкции
Недоступно
Справка
Обратитесь в службу поддержки по адресу support@wizkids.co.uk. // 020 7550 9286
eSchoolData
Поставщик SIS
eSchoolData
Минимальная версия программного обеспечения
Недоступно
Предварительные требования к настройке
Районы должны быть подписчиками продукта ESD GURU.
Как получить идентификатор клиента, секрет клиента и URL-адреса
См. конкретные инструкции.
Конкретные инструкции
Чтобы включить интеграцию API с SDS, администраторы районов должны сначала создать учетную запись поставщика в GURU. Перейдите в раздел Поставщики конфигурации > и выберите Создать нового поставщика. Введите имя поставщика и сохраните автоматически создаваемые идентификатор клиента и секрет клиента. Укажите url-адрес API GURU в регионе при настройке интеграции SDS. Нажмите кнопку Далее и включите все разрешения API OneRoster. По завершении нажмите кнопку Готово, чтобы сохранить новую учетную запись.
Справка
По вопросам обратитесь в службу поддержки eSchoolData.
eSchooling
Поставщик SIS
eSchooling от Codevision
Минимальная версия программного обеспечения
1.1.20
Предварительные требования к настройке
Нет
Как получить идентификатор клиента, секрет клиента и URL-адреса
Следуйте инструкциям на платформе eSchooling: System Administration > School Data Sync
Конкретные инструкции
То же, что и раньше
Справка
Контакт suporte@codevision.pt
Eum School SIS
Поставщик SIS
DataEum
Минимальная версия программного обеспечения
Недоступно
Предварительные требования к настройке
Нет
Как получить идентификатор клиента, секрет клиента и URL-адреса
Email поддержке клиентов запрашивать учетные данные API OneRoster.
Конкретные инструкции
Обратитесь в службу поддержки клиентов pbd@dataeum.kr
Справка
Обратитесь в службу поддержки клиентов pbd@dataeum.kr
Eventful
Поставщик SIS
Eventful
Минимальная версия программного обеспечения
Список поддерживаемых регистров учащихся можно найти на странице Eventful OneRoster.
Предварительные требования к настройке
Обратитесь к Eventful по электронной почте или info@eventful.se по телефону (+46) 10 209 9001
Как получить идентификатор клиента, секрет клиента и URL-адреса
Предоставляется в процессе установки.
Конкретные инструкции
Недоступно
Справка
Обратитесь в службу поддержки по событиям по электронной почте info@eventful.se или по телефону (+46) 10 209 9001
ДАННЫЕ
Поставщик SIS
ДАННЫЕ
Минимальная версия программного обеспечения
Не применимо. Последняя версия всегда доступна для клиентов.
Предварительные требования к настройке
Неприменимо
Как получить идентификатор клиента, секрет клиента и URL-адреса
Клиенты регистрятся для использования API OneRoster, и ФАКТЫ предоставляют им эту информацию.
Конкретные инструкции
В SIS перейдите в раздел System > Configuration > SIS Integrations > OneRoster API > Заполнить форму.
Справка
Служба поддержки клиентов 866-800-6593
Focus School Software
Поставщик SIS
Focus School Software
Минимальная версия программного обеспечения
Focus v 8.7
Предварительные требования к настройке
Н/Д
Как получить идентификатор клиента, секрет клиента и URL-адреса
На экране Портала фокусировки выберите Настройка > системы > Сторонних систем. В строке вставки записи введите Заголовок: Диалект Microsoft версии 1.0 > : OneRoster. После сохранения создаются URL-адрес, идентификатор клиента и секрет клиента.
Конкретные инструкции
Недоступно
Справка
Позвоните в службу поддержки Focus по телефону 877-410-6637.
Фоллетт Аспен
Поставщик SIS
Фоллетт Аспен
Минимальная версия программного обеспечения
Последняя версия Aspen, 5.9
Предварительные требования к настройке
Н/Д
Как получить идентификатор клиента, секрет клиента и URL-адреса
Чтобы запланировать обновление, обратитесь к менеджеру по работе с клиентами в вашем районе.
Конкретные инструкции
Недоступно
Справка
Обратитесь за помощью к менеджеру по работе с клиентами.
Школа Furlong
Поставщик SIS
Школа Furlong
Минимальная версия программного обеспечения
Размещенные учебные заведения используют только последнюю версию
Предварительные требования к настройке
Недоступно
Как получить идентификатор клиента, секрет клиента и URL-адреса
До версии 1933.3 — перейдите к пользовательскому интерфейсу >> Infinite Campus выберите Системное администрирование >> выберите Обучение кампуса >> выберите Средства >> OneRoster выберите в OneRoster. Версия 1933.3 и более поздние — перейдите к пользовательскому интерфейсу >> Infinite Campus выберите Системное администрирование >> выберите Взаимодействие с обучением.
При выборе атрибутов в Infinite Campus для синхронизации убедитесь, что период не выбран. Если он выбран, существует вероятность возникновения большого количества ошибок при синхронизации и блокировке профиля в карантине.
Справка
Для получения справки обратитесь к менеджеру по успешности клиентов.
inLogic
Поставщик SIS
inLogic
Минимальная версия программного обеспечения
Версия 7.7.510
Предварительные требования к настройке
Недоступно
Как получить идентификатор клиента, секрет клиента и URL-адреса
Для получения поддержки по электронной почте перейдите по адресу support@inlogic.dk, для службы поддержки по телефону, +45 42 40 88 15 и веб-поддержки. https://www.inlogic.dk/support/
iSAMS от IRIS
Поставщик SIS
iSAMS от IRIS
Минимальная версия программного обеспечения
21.4.23.12
Предварительные требования к настройке
Нет
Как получить идентификатор клиента, секрет клиента и URL-адреса
Вы должны отправить службу поддержки по электронной почте, запрашивая учетные данные API OneRoster по адресу helpdesk@isams.co.uk
Конкретные инструкции
Нет
Справка
Обратитесь в службу поддержки iSAMS, чтобы запросить справку по адресу helpdesk@isams.co.uk.
IST
Поставщик SIS
IST
Минимальная версия программного обеспечения
Не применимо.
Предварительные требования к настройке
См. конкретные инструкции.
Как получить идентификатор клиента, секрет клиента и URL-адреса
См. конкретные инструкции.
Конкретные инструкции
Сведения о настройке предоставляются в частном порядке.
Справка
По вопросам обратитесь в службу поддержки IST.
LIBRUS
Поставщик SIS
LIBRUS
Минимальная версия программного обеспечения
Текущая версия
Предварительные требования к настройке
Клиент должен иметь лицензию на LIBRUS Synergia
Как получить идентификатор клиента, секрет клиента и URL-адреса
Чтобы включить интеграцию API с SDS, необходимо войти в систему как администратор или субъект учебного заведения. Перейдите в раздел Конфигурация > параметров > Другие параметры > Office 365 интеграции
Конкретные инструкции
Подробные инструкции см. в разделе справки.
Справка
Обратитесь в нашу службу поддержки по адресу pomoc@LIBRUS.pl
MySchool
Поставщик SIS
MySchool Ltd
Минимальная версия программного обеспечения
Неприменимо
Предварительные требования к настройке
Начальная настройка системы MySchool осуществляется с помощью группы поддержки.
Как получить идентификатор клиента, секрет клиента и URL-адреса
Нет. Интеграция OneRoster включена для всех учебных заведений по умолчанию.
Как получить идентификатор клиента, секрет клиента и URL-адреса
Автоматически создается программой при создании нового учебного заведения. Администратор может управлять параметрами пользователей с помощью приложения Gradebook Manager.
Конкретные инструкции
Нет
Справка
Вопросы можно направлять по или GBSupport@rediker.comAPSupport@rediker.com
SIMS
Поставщик SIS
SIMS от образовательных программных решений
Минимальная версия программного обеспечения
SIMS 7 Лето 2019 или более поздней версии
Предварительные требования к настройке
Требуется учетная запись идентификатора SIMS.
Как получить идентификатор клиента, секрет клиента и URL-адреса
Как получить идентификатор клиента, секрет клиента и URL-адреса
На портале Администратор VULCAN; Выберите "Конфигурация" > "Office 365 параметры" > конфигурация обмена API. Включите "Синхронизация с Office 365". На этой вкладке вы получите идентификатор клиента, секрет клиента и URL-адреса.
Конкретные инструкции
Н/Д
Справка
Обратитесь в службу поддержки по адресу https://vulcan.edu.pl в стандартные рабочие часы.