Школьный портал — school.mosreg.ru Документация в формате Swagger
Документация доступна по адресу https://api.school.mosreg.ru/partners/swagger/ui/index
Общая информация
Система «Школьный портал» предоставляет набор API для создания сторонних приложений и интеграции внешних сервисов. Через API сторонние приложения могут получить доступ к общим данным сервиса, а также к личным данным пользователя.
Взаимодействие с API происходит по протоколу HTTPS в соответствии с архитектурным стилем REST.
Ряд ресурсов содержит ФИО юзера и аватар. Эти данные являются служебными и предназначены только для приложений с доступом к персональным данным юзера. Для остальных приложений соответствующие поля не возвращаются.
Авторизация
Для выполнения большинства действий через API приложению необходимо получить токен доступа. Для авторизации сторонних приложений используется фреймворк OAuth2.
Каждый токен привязан к конкретному пользователю и приложению, зарегистрированному в системе.
После того как токен доступа получен, приложение должно включать его в каждый запрос к API в качестве параметра URL access_token или заголовка HTTP Access-Token.
Процедура получения токена доступа
Если при обработке запроса произошла ошибка, то ответ будет содержать код состояния 4xx или 5xx , а тело ответа — объект ApiError с ошибкой одного из следующих типов:
API и Порядок интеграции внешних систем ЭЖД к обмену данными с ИСУОД
ПАО «Ростелеком» принято решение о реализации интеграционного интерфейса программирования приложений (далее — API) для подключения к Системе «Школьный портал» внешних информационных систем, используемых муниципальными общеобразовательными организациями Московской области для ведения электронного журнала успеваемости обучающихся (далее — внешние системы ЭЖД).
Порядок интеграции сторонних модулей ведения электронного учета успеваемости обучающихся общеобразовательных организаций к обмену данными с единой информационной системой учета и мониторинга образовательных достижений обучающихся общеобразовательных организаций Московской области
Для подключения внешних систем ЭЖД к ИСУОД должны быть проведены следующие мероприятия:
1. Подача разработчиками (владельцами) внешних систем ЭЖД письменного запроса в службу поддержки пользователей Системы для получения доступа к полному описанию методов API.
Разработчики (владельцы) внешних систем ЭЖД должны отправить письменный запрос в службу поддержки пользователей Системы для получения доступа к полному описанию методов API. Запрос должен содержать следующую информацию:
При соответствии запроса требованиям к составу предоставляемой в нем информации и наличии в запросе объективных оснований для получения *доступа Оператор Системы (ПАО «Ростелеком») в срок не позднее 14 календарных дней с момента получения запроса предоставляет разработчику (владельцу) внешней системы ЭЖД доступ к запрашиваемой информации письмом на адрес электронной почты, указанный в запросе.
В случае отсутствия у разработчика (владельца) внешней системы ЭЖД объективных оснований или нарушения требований к составу предоставляемой в запросе информации Оператор Системы (ПАО «Ростелеком») в срок не позднее 14 календарных дней с момента получения запроса направляет разработчику (владельцу) внешней системы ЭЖД мотивированный **отказ.
*Не менее 1 (одной) ОО Московской области использует внешнюю систему ЭЖД.
**Оператор Системы вправе не направлять мотивированный отказ в случаях, когда Оператор ВП не предоставил в запросе email ответственного сотрудника.
2. Обеспечение разработчиками (владельцами) внешних систем ЭЖД соответствия внешних систем ЭЖД требованиям информационной безопасности и, при необходимости, доработка внешней системы ЭЖД в соответствии с требованиями, определёнными в пакете документов.
При необходимости, разработчики (владельцы) внешних систем ЭЖД должны доработать внешнюю систему ЭЖД в соответствии с требованиями, определенными в пакете документов.
Разработчики (владельцы) внешних систем ЭЖД должны обеспечить соответствие внешних систем ЭЖД требованиям информационной безопасности, определенным в пакете ***документов.
***Обеспечение работы программно-технических средств, организация защищенного канала связи и дальнейшее обслуживание его производственных функций осуществляются за счет собственных средств организации – разработчика (владельца) внешней системы ЭЖД.
3. Подача заявки разработчиками (владельцами) внешних систем ЭЖД в службу поддержки пользователей Системы на подключение к ИСУОД (далее – Заявка).
Заявку могут подать:
К Заявке должны быть приложены следующие материалы и документы:
при отсутствии вышеуказанных сведений и документов Заявка, направленная разработчиком (владельцем) внешней системы ЭЖД, считается неполной и не подлежит рассмотрению Оператором Системы (ПАО «Ростелеком»), о чем Оператор Системы (ПАО «Ростелеком») уведомляет разработчика (владельца) внешней системы ЭЖД.
4. Рассмотрение Заявки и принятие решения.
Шаг 1. Оператор Системы (ПАО «Ростелеком») рассматривает полученную от разработчика (владельца) внешней системы ЭЖД Заявку на предмет соответствия установленным требованиям. В процессе рассмотрения Заявки Оператор Системы (ПАО «Ростелеком») имеет право запрашивать дополнительные разъяснения у разработчика (владельца) внешней системы ЭЖД по сведениям, указанным в Заявке.
Максимальный срок рассмотрения Заявки Оператором Системы (ПАО «Ростелеком») составляет 30 дней.
В случае несоответствия Заявки требованиям, определенным в пакете документов Оператор Системы (ПАО «Ростелеком») направляет соответствующее уведомление разработчику (владельцу) внешней системы ЭЖД.
Если Заявка соответствует требованиям, определенным в пакете документов, Оператор Системы (ПАО «Ростелеком») направляет ее на согласование и утверждение в Министерство образования Московской области и направляет соответствующее уведомление разработчику (владельцу) внешней системы ЭЖД.
Шаг 2. Решение о подключении внешней системы ЭЖД к ИСУОД, а также о целесообразности заключения соглашения об информационном взаимодействии между Оператором Системы (ПАО «Ростелеком») и разработчиком (владельцем) внешней системы ЭЖД (далее – Соглашение) принимает Министерство образования Московской области.
В рамках процедуры принятия решения Министерство образования Московской области запрашивает согласие с ОО и МОУО о передаче сведений в ИСУОД через внешнюю систему ЭЖД, на подключение которой направлена Заявка, и направляет информацию о принятом решении Оператору Системы (ПАО «Ростелеком»).
Максимальный срок согласования Заявки Министерством образования Московской области и принятия решения составляет 30 дней.
5. Уведомление разработчика (владельца) внешней системы ЭЖД о принятом решении.
Оператор Системы (ПАО «Ростелеком») направляет разработчику (владельцу) внешней системы ЭЖД информацию о принятом Министерством образования Московской области решении:
6. Подключение внешней системы ЭЖД к ИСУОД.
Шаг 1. Заключение соглашения об информационном взаимодействии между Оператором Системы (ПАО «Ростелеком») и разработчиком (владельцем) внешней системы ЭЖД.
Шаг 2. Регистрация разработчика (владельца) внешней системы ЭЖД в Системе и направление ключа доступа.
Шаг 3. Тестирование работоспособности подключения внешней системы ЭЖД к ИСУОД разработчиком (владельцем) внешней системы ЭЖД совместно с Оператором Системы (ПАО «Ростелеком»).
Установленные технические требования к внешним системам и приложениям и технологический процесс их подключения к cистеме «Школьный портал» описаны в документе «Единые технические требования для обеспечения возможности подключения внешних автоматизированных информационных систем к Единой информационной системе учета и мониторинга образовательных достижений обучающихся общеобразовательных организаций Московской области» (в приложении).