Описание: Общее описание REST API портала. API организовано по функциональным группам методов; каждая группа — отдельная подстраница с индексом входящих в неё методов.
🔑 Получение токена авторизации
Прежде чем вызывать любой другой метод API, необходимо получить токен сессии пользователя, вызвав метод Получить токен авторизации (Login). Полученный токен передаётся в заголовке Authorization при всех последующих вызовах REST API.
📚 Индекс разделов
| Раздел | Статус | Описание |
|---|---|---|
| Авторизация | ✅ готово (см. ниже) | Получение токена, вход по логину/паролю, NTLM, OpenID Connect, двухфакторная аутентификация, сессия, выход |
| Пароли и восстановление доступа | план | Установка/смена пароля, восстановление по e-mail, TOTP |
| Права доступа | план | Настройка уникальных прав на элемент, получение списка прав |
| Элементы | план | CRUD по элементам, ссылки, lookup-поиск |
| Списки | план | Работа со списками и действиями над списками |
| Файлы и документы | план | Загрузка/скачивание файлов, версии, подписание, публичные ссылки |
| Представления | план | Представления и части представлений |
| Типы контента и конфигурация | план | Типы контента, конфигурация, лицензия, площадка |
| Экспорт | план | Экспорт данных |
| Корзина | план | Удалённые элементы, восстановление |
| Процессы | план | Маршруты согласования, задачи процессов (Workflows) |
| Автоматизация | план | Правила автоматизации, синхронизация атрибутов |
| Оповещения | план | Отправка почтовых оповещений по шаблону |
| Штампы и печати | план | Штампы, QR-коды, объединение PDF, экспорт/импорт замечаний |
| Импорт | план | Импорт данных из Excel |
| Отчёты | план | Формирование отчётов |
| Просмотр BIM-моделей | план | Модели, сцены, элементы моделей, 3D-текст |
| Просмотр CAD-моделей | план | CAD-модели |
| Редактор OnlyOffice | план | Интеграция с OnlyOffice |
| Табели рабочего времени | план | Timesheets |
| Активность | план | Лента активности по элементу |
| Замечания (Issues) | план | Работа с замечаниями |
| Калькулятор | план | Расчётные операции |