Информация, необходимая для эксплуатации экземпляра ПО*
Информация, необходимая для эксплуатации экземпляра ПО*
1.
Общие сведения
1.1. Наименование программы
1.1.1.
Полное наименование программы: «ИДГОС».
1.1.2.
Программное обеспечение «ИДГОС» является российской разработкой,
организация-разработчик: ООО «СИНТЕГРА».
1.1.3.
Сайт разработчика-правообладателя: «https://idgos.ru».
1.1.4.
Веб-сервис для формирования и подписания документов.
1.2. Назначение и область применения
1.2.1.
«ИДГОС» предназначено для подписания документов через авторизацию на портале
Госуслуг (ЕСИА). Сервис позволяет автоматизировать рабочие процессы обработки
документов, исключить ручное заполнение документов.
1.2.2.
Подписание документов в «ИДГОС» гарантирует согласие сторон, что помогает
избежать претензий, а также является подтверждением в суде.
1.3. Основные функции
1.3.1.
Перечень функций ПО приведён в разделе 2 настоящего документа.
2. Функциональные характеристики
2.1. Основная функция.
2.1.1.
Основной функцией «ИДГОС» является подписание документов через авторизацию на
портале Госуслуг.
2.2. Функциональные возможности
2.2.1.
Для реализации основной функции ПО предоставляет следующий набор функциональных
возможностей:
-
Идентификация клиента через ЕСИА
(Госуслуги);
-
Загрузка документов для подписи (формат «DOCX»);
-
Генерация документов на основе шаблонов с
автоматической подстановкой данных из ЕСИА;
-
Выбор документов для отправки клиенту на
подписание;
-
Создание документа внутри сервиса;
-
Предпросмотр сгенерированного документа
перед отправкой на подписание;
-
Добавление специальных переменных, которые
автоматически заменяются на данные клиента после авторизации через Госуслуги;
-
Просмотр списка документов, ожидающих
подписания;
-
Просмотр архива подписанных документов;
-
Скачивание подписанных документов на
устройство пользователя;
Сервис
развивается, поэтому данный список может быть дополнен.
2.3. Архитектура и алгоритм функционирования
Приложение
«ИДГОС» построено по клиент-серверной архитектуре. Система состоит из двух
взаимодействующих компонентов: клиентской части и серверной части.
2.3.1.
Клиентская часть — Админ-панель (веб)
1. Model:
локальное состояние, кэширование, сущности интерфейса;
2. View-Веб:
интерфейс администратора: формы, таблицы, кнопки;
3. ViewModel:
обработка команд администратора, подготовка запросов к API.
Шаблоны:
Interactor/Command для управления бизнес-процессами.
2.3.2.
Клиентская часть — Подписывающий (веб по ссылке)
1. Model:
хранение токена ссылки, данных документа, состояния подписания;
2. View-Веб:
адаптивный веб-интерфейс: просмотр документа, кнопка «Подписать через
Госуслуги»;
3. ViewModel:
обработка навигации, запуск авторизации ЕСИА, обновление UI.
Особенности:
1. Не
требует установки, регистрации или входа в аккаунт;
2. Работает
в любом современном браузере (мобильном/десктопном);
2.3.3.
Серверная часть (Backend)
1. Model:
Бизнес-сущности, работа с СУБД, интеграция с ЕСИА, генерация документов,
отправка SMS;
2. View-Веб:
Шаблоны TWIG для веб-интерфейса; JSON-ответы для API;
3. ViewModel:
Маршрутизация запросов, валидация токенов, координация бизнес-логики.
Технический
стек реализации:
1. Клиентская
часть: JavaScript, React 18.2.0, MVVM-архитектура;
2. Серверная
часть: PHP 7/8, СУБД PostgreSQL/MariaDB, Nginx, Linux;
3. Требования к установке и эксплуатации
3.1. Требования
к аппаратному обеспечению
3.1.1. Для корректной
работы веб-сервиса «ИДГОС», пользовательское устройство должно соответствовать
минимальным техническим характеристикам:
- Центральный
процессор: достаточная вычислительная мощность для выполнения задач.
- Оперативная
память: от 1 ГБ.
- Свободное
место: от 1 ГБ.
- Экран: Цветной
сенсорный экран от 4.5 дюймов (HD и выше).
3.2. Требования к программному обеспечению
3.2.1. Для корректной
работы веб-сервиса «ИДГОС», пользовательское устройство должно быть оснащено
одной из следующих операционных систем:
- Android: версия
5.0 и выше (рекомендуется 6.0+).
- iOS: версия
12 и выше.
- Windows: современные
версии для доступа через браузер.
-
macOS: современные версии для доступа
через браузер.
3.3. Требования к квалификации
персонала.
2.3.1.
Пользователям для подписания документов в «ИДГОС» достаточно иметь базовые
навыки работы:
-
со смартфоном под управлением ОС на базе
Android, IOS;
-
с ПК под управлением ОС Windows, macOS;
-
изучить документацию.
3.4. Установка и запуск
3.4.1.
Установка ПО на стороне пользователя не требуется.
3.4.2.
Для начала работы необходимо:
1. Перейти
по адресу https://idgos.ru;
2. Пройти
авторизацию (раздел «Личный кабинет - Авторизация»);
3. После
успешной авторизации функционал сервиса становится доступным (Рисунок 1).
Рисунок 1
3.4.3.
Для подписывающего (клиента) запуск осуществляется следующим образом:
1. Перейти
по ссылке из SMS-сообщения;
2. Принять
политику конфиденциальности (Рисунок 2);
3. Пройти
авторизацию через портал Госуслуг (ЕСИА);
4. Ознакомиться
с документами и ввести код подтверждения из SMS;
5. После
успешного подписания документ автоматически сохраняется в архиве и хранится в
течении 24 часов.
Рисунок
2
3.5. Проверка функционирования
3.5.1.
Для проверки работоспособности ПО выполнить последовательность:
1. Авторизуйтесь
в личный кабинет;
2. Создать
шаблон документа;
3. Сгенерировать
документ на основе шаблона;
4. Отправить
документ на подпись тестовому пользователю;
5. Убедиться
в получении уведомления и возможности подписания.
3.6. Порядок эксплуатации
3.6.1.
Работа с сервисом осуществляется через веб-интерфейс.
3.6.2.
Основные сценарии использования описаны в разделе 4 настоящего документа.
4. Выполнение программы
4.1.
Авторизация в личном кабинете
4.1.1. Перед работой с «ИДГОС»
необходимо произвести авторизацию в личном кабинете, перейдите на вкладку сайта
«Личный кабинет → Авторизация» (Рисунок 3, 4).
Рисунок 3
Рисунок 4
4.2. Шаблоны
документов
4.2.1. На странице «Шаблоны
документов» отображается список всех загруженных в систему шаблонов (Рисунок 5),
готовых к отправке на подписание.
Рисунок 5
4.2.2. На странице «Шаблоны
документов» в списке справа от каждого документа имеется кнопка удаления. При
нажатии на кнопку, появляется окно подтверждения действия (Рисунок 6), при
нажатии:
-
«Удалить», документ безвозвратно удален из
системы;
-
«Отмена», скрытие окна;
Рисунок
6
4.2.3. На странице «Шаблоны
документов» в списке, справа от каждого документа имеется кнопка редактирования.
При нажатии на кнопку, появляется окно подтверждения действия (Рисунок 7), при
нажатии: «Сохранить», документ сохраняет новые изменения, «Отмена», скрытие
окна.
Рисунок 7
4.2.3.1.
В форме редактирования имеется возможность скачивания текущего шаблона договора
(Рисунок 8).
Рисунок 8
4.2.3.2. Загрузка нового шаблона
документа. Загрузка файла осуществляется в формате «DOCX», при несоответствии
формата документа сервис проинформирует (Рисунок 9, 10, 11).
Рисунок
9
Рисунок 10
Рисунок 11
4.2.3.3. Изменение имени документа
(Рисунок 12, 13).
Рисунок
12
Рисунок
13
4.2.3.4.
Изменение описания документа (Рисунок 14, 15).
Рисунок 14
Рисунок
15
4.2.3.5. Добавление и удаление
переменных документа. Функция позволяет добавлять пользовательские переменные
для подстановки в документ (например, для указания специфичных данных, таких
как номер транспортного средства). Добавленные переменные отображаются в списке
под кнопкой «Добавить» и могут быть удалены при необходимости (Рисунок 16, 17,
18).
Рисунок 16
Рисунок
17
Рисунок
18
4.2.4. Отправка документов на
подпись. На вкладке «Шаблоны документов» при нажатии на кнопку «Отправить
на подпись» появляется форма подготовки отправки (Рисунок 19).
Рисунок
19
4.2.4.1. В поле «Телефон абонента»
необходимо ввести номер мобильного телефона, на который будет отправлено
SMS-сообщение со ссылкой для подписания и кодом подтверждения (Рисунок 20).
Рисунок
20
4.2.4.2. В блоке «Выбор документов»
необходимо отметить документы, которые будут отправлены на подписание (Рисунок
21).
Рисунок
21
4.2.4.3. В поле «Биллинг айди»
необходимо ввести уникальный идентификатор подключения (UID) (Рисунок 22).
Рисунок
22
4.2.4.4. В поле «Номер договора»
необходимо ввести номер договора для подстановки в документ (Рисунок 23)
Рисунок
23
4.2.4.5. В поле «Адрес»
необходимо ввести адрес точки подключения (место размещения оборудования)
(Рисунок 24).
Рисунок
24
4.2.4.6. В поле «Тариф» необходимо
ввести название тарифа для подстановки в документ (Рисунок 25).
Рисунок
25
4.2.4.7. В поле «Стоимость тарифа»
необходимо ввести стоимость тарифа для подстановки в документ (Рисунок 26).
Рисунок 26
4.2.4.8. В поле «ФИО» необходимо
ввести ФИО подписанта для сравнения с данными из Госуслуг и подстановки в
документ (Рисунок 27).
Рисунок
27
4.2.5. Памятка по выражениям. На странице
«Шаблоны документов» при нажатии на кнопку «Памятка по выражениям» появляется
форма для ознакомления с доступными системными переменными и правилами их
использования в шаблоне. В открывшейся памятке содержится таблица системных
переменных с указанием выражения, описания и источника данных, а также примеры
использования (Рисунок 28). В примечании поясняется, что выражение может быть
продублировано в тексте шаблона, и приведены примеры корректного применения
выражений в документе (Рисунок 29).
Рисунок 28
Рисунок 29
4.2.6. Добавление шаблона документа.
Для создания нового шаблона необходимо перейти на страницу «Шаблоны документов»
и нажать кнопку «Добавить шаблон». В результате открывается форма настройки
параметров, где необходимо заполнить данные полей, загрузить файл-основу,
добавить переменные и нажать кнопку «Сохранить» для регистрации шаблона в
системе (Рисунок 30).
Рисунок
30
4.2.6.1. В блоке «Файл-основа»
осуществляется загрузка файла шаблона в формате «DOCX», при несоответствии
формата документа сервис проинформирует. Текст файла должен содержать разметку
переменными в формате ${имя_переменной} (памятка, смотрите блок 4.2.5.) для автоматической подстановки данных из ЕСИА
(Рисунок 31, 32, 33).
Рисунок
31
Рисунок
32
Рисунок
33
4.2.6.2. В поле «Название» вводится
наименование документа, которое будет отображаться в общем списке шаблонов и
использоваться для идентификации при отправке на подписание (обязательное поле)
(Рисунок 34).
Рисунок 34
4.2.6.3. В поле «Описание»
указывается краткая справка о назначении шаблона для удобства администрирования
и поиска (Рисунок 35).
Рисунок
35
4.2.6.4. Добавление и удаление
переменных документа. Функция позволяет добавлять пользовательские переменные
для подстановки в документ (например, для указания специфичных данных, таких
как номер транспортного средства). Добавленные переменные отображаются в списке
под кнопкой «Добавить» и могут быть удалены при необходимости (Рисунок 36, 37,
38).
Рисунок
36
Рисунок
37
Рисунок 38
4.2.6.5. Для сохранения шаблона в
системе необходимо нажать кнопку «Сохранить». После успешного сохранения, новый
шаблон отображается в общем списке доступных шаблонов документов и готов к отправке на подписание (Рисунок 5).
4.3.
Просмотр актуальных договоров
4.3.1. На странице «Статистика →
Текущие договора» отображаются все актуальные договора, отправленные на
подписание в течение 3-х дней (Рисунок 39). Для удобства поиска предусмотрены
следующие возможности:
1.
Фильтрация по биллингу (Введите биллинг id) — позволяет найти договоры по
уникальному идентификатору;
2.
Фильтрация по статусам подписания —
позволяет отобразить договоры в зависимости от текущего статуса («Отправлен», «Просмотрен»,
«Подписан», «Подписывающему должно быть больше 18», «ФИО из биллинга не
совпадет с ФИО подписывающего»).
4.3.2. Для применения фильтра
необходимо выбрать нужные параметры в соответствующих полях фильтрации, список
договоров автоматически обновится в соответствии с заданными критериями
(Рисунок 40, 41).
Рисунок 39
Рисунок 40
Рисунок 41
4.4.
Просмотр архива документов
4.4.1.
На странице «Статистика → Архив» отображается список всех отправленных на
подписание документов (Рисунок 42).
Рисунок 42
4.4.2. Для удобства поиска
документов, предусмотрена фильтрация данных (Рисунок 43).
Рисунок 43
4.4.2.1. Поле фильтрации «За период»
предназначено для выбора данных из списка по следующим статусам: «За период»,
«День», «Неделя» (Рисунок 44, 45).
Рисунок 44
Рисунок 45
4.4.2.2. Поле ввода «Введите биллинг
id» предназначено для поиска документов по уникальному идентификатору
подключения (Рисунок 46).
Рисунок 46
4.4.2.3. Чекбокс «Показать только
подписные» предназначен для отображения в списке только подписанных документов
(Рисунок 47, 48, 49).
Рисунок 47 Рисунок 48
Рисунок 49
4.5.
Изменить конфигурацию
4.5.1. На странице «Личный кабинет → Изменить
конфигурацию» отображаются настройки системы с возможностью изменения
контактной информации и параметров интеграции (Рисунок 50).
4.5.2. На странице редактирования
информации предусмотрены поля:
- «Имя,
Отчество» — ввод имени и отчества (Иван Иванович);
- «Фамилия»
— ввод фамилии (Иванов);
- «E-Mail»
— ввод адреса электронной почты (info@idgos.ru);
- «Телефон»
— ввод личного номера телефона (+79995550011);
- «ИНН»
— отображение ИНН организации (кнопка «запросить» для получения данных);
- «Организация»
— отображение названия организации (ООО Имя вашей организации);
- «Адрес
сайта компании» — ввод адреса сайта компании (https://idgos.ru/);
- «Логотип
организации» — загрузка файла логотипа (кнопки «Выберите файл» и «Удалить»);
- «Телефон
компании» — ввод телефона компании (+79995550011);
- «IP
адрес API» — ввод IP адреса для API (111.11.11.1);
-
«URL для отправки данных из Госуслуг» — в
момент получения смс, для подписания документов, вам будет отправляться
post-запрос, в котором представлены данные, полученные из госуслуг, в формате JSON. Вы должны указать URL вашего скрипта, куда будут
отправляться данные, полученные из госуслуг (поле является обязательным). На
своей стороне Вы сами распоряжаетесь данными (https://idgos.ru/).
- «URL
для файлов» — ввод URL для сохранения подписанных документов (https://idgos.ru/);
- «Разрешить
подписание людям до 18 лет» — выберите «да» или «нет» для разрешения подписания
документов лицам младше 18 лет;
- «Собственный
смс-шлюз» — берите «да» или «нет» для использования собственного сервиса
отправки SMS;
- «URL
для статусов» — ввод URL для сохранения статусов документов;
- «Соответствие
ФИО с госуслугами» — выберите «да» или «нет» для проверки совпадения ФИО
подписывающего с данными из ЕСИА;
- «Токен
для API» — токен отвечающий за безопасность передачи данных из госуслуг, для
совместного использования с «URL для отправки данных из госуслуг».
Для получения нажмите кнопку «Генерировать».
После заполнения всех необходимых
полей нажмите кнопку «Продолжить».
Рисунок
50
4.6. Управление
операторами
4.6.1.
Страница «Управление операторами» предназначена для добавления, просмотра и
редактирования учётных записей операторов, имеющих доступ к сервису «ИДГОС».
Переход на страницу осуществляется «Личный кабинет → Управление
пользователями» (Рисунок 51).
Рисунок
51
4.7.
Изменить пароль
4.7.1. Для изменения пароля личного
кабинета, перейдите на страницу «Личный кабинет → Учетная запись» заполните
необходимые поля и нажмите кнопку «Продолжить» (Рисунок 52).
Рисунок 52
4.8. Подписание документов
4.8.1.
При работе с «ИДГОС» пользователям высылается сообщение с ссылкой (за которой
закреплены документы для подписания) и кодом подтверждения подписи.
|
Рисунок 54 |
|
Рисунок 53 |
|
Рисунок 55 |
|
Рисунок 56 |
|
Рисунок 58 |
|
Рисунок 57 |
|
Рисунок 59 |
|
Рисунок 60 |
|
Рисунок 62 |
|
Рисунок 61 |
4.8.6. Далее будет доступен список подписанных
документов для просмотра и скачивания (Рисунок 63).
Рисунок 63
5. Описание входных и выходных данных
5.1. Входные данные
5.1.1.
К входным данным относятся:
-
учётные данные пользователя (логин,
пароль, телефон);
-
параметры шаблона документа (название,
описание, файл-основа);
-
пользовательские переменные для
подстановки в документ;
-
данные авторизации через ЕСИА
(предоставляются порталом Госуслуг).
-
файл-основа шаблона в формате DOCX с
разметкой переменных;
-
номер телефона подписывающего;
-
код подтверждения из SMS для завершения
процедуры подписания;
5.2. Выходные данные
5.2.1.
К выходным данным относятся:
- Сгенерированные
документы (формат «DOCX»);
- Статусы
документов («Новый», «Отправлен», «Прочитан», «Подписан»);
- Результаты
запросов API в формате JSON;
- Документы
с наложенной квалифицированной электронной подписью и визуализацией печати
(форматы «PDF», «SIG»,
«ZIP»);
6. Возможные неисправности и способы их
устранения
6.1. Типовые ситуации
6.1.1.
При возникновении ошибок в работе сервиса рекомендуется:
-
Проверить подключение к сети Интернет;
-
Очистить кэш браузера и повторить
операцию;
-
Убедиться в актуальности версии браузера;
-
Перейдите по ссылке и повторите
подписание, повторно авторизовавшись через портал Госуслуги.
6.2. Обращение в службу поддержки
6.2.1.
Если неисправность не устраняется самостоятельно, необходимо направить заявку в
службу технической поддержки ООО «СИНТЕГРА»:
- электронная
почта: info@idgos.ru;
- форма
обратной связи на официальном сайте https://idgos.ru/;
- телефон:
+7 (800) 300-60-53.
6.2.2.
При возникновении инцидента, который не может быть устранён силами службы
технической поддержки, заявка передаётся разработчикам ПО «ИДГОС» для анализа и
исправления. После устранения ошибки выпускается обновление сервиса, информация
о котором доводится до всех партнёров и пользователей.
