Запросить демо
Запросить демо
Документерра: руководство пользователя

Защита руководств пользователя

Нередко возникает необходимость предоставить доступ к публикации только определенным пользователям. Существует несколько вариантов защиты онлайн-документации в системе Документерра.

Обеспечение безопасности через неясность (секретная ссылка)

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

Уровень сложности реализации: Легкий
Уровень безопасности: Низкий

Ограниченный доступ в систему Документерра из единой учетной записи

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

Уровень сложности реализации: Средний
Уровень безопасности: Средний

Размещение на собственном сервере и защита

Публикация в формате Web Help и размещение на собственном сервере под собственным логином. Формат Web Help в своей основной функциональности повторяет интерфейс читателя портала Документерры и никак не зависит от портала —это совершенно отдельный пакет. Он может даже поставляться вместе с вашим продуктом и открываться из локальной файловой системы, так что вам даже не понадобится сервер для его размещения, поскольку это обычный формат HTML с сопутствующими стилями, скриптами и изображениями.   Более подробную информацию можно получить на странице справки Создание документа в формате веб-справки.

Уровень сложности реализации: Средний
Уровень безопасности: Высокий

Ограниченный доступ в систему Документерра из разных учетных записей

Можно также создать отдельную учетную запись авторизованного читателя для каждого пользователя, чтобы предоставить разным пользователям различные уровни доступа. Конечно, не обязательно делать это вручную. Скорее всего, в вашем веб-приложении имеется механизм управления пользователями. Вы можете использовать REST API Документерры для интеграции создания учетной записи пользователя на портале Документерры с созданием учетной записи пользователя в вашем веб-приложении. Более подробную информацию можно найти в разделе API Документерры.

Уровень сложности реализации: Средний
Уровень безопасности: Высокий

Ограниченный доступ в систему Документерра с помощью технологии единого входа (SSO)

Документерра поддерживает технологию единого входа OpenID Connect. Это означает, что вы можете интегрировать авторизацию в веб-приложении и на портале документации. При использовании такого подхода клиентам не придется запоминать два набора учетных данных —вход в веб-приложение будет означать и авторизацию на портале документации. Для получения дополнительной информации ознакомьтесь со страницей справки Технология единого входа.

Уровень сложности реализации: Средний
Уровень безопасности: Высокий

Важно
Для работы технологии единого входа необходимо реализовать на своей стороне Поставщик удостоверений OpenID Connect (если у вас его нет).