Описание: Получить конфигурацию для инициализации веб-редактора OnlyOffice по элементу-файлу: адрес API document-сервера, а также объект конфигурации config, который фронтенд передаёт в JS SDK OnlyOffice (DocsAPI.DocEditor). Требует права read на элемент.
Конфигурация формируется так:
- Тип документа (
documentType:word/cell/slide) определяется по расширению файла. - Права редактирования (
document.permissions.edit) даются, только если у пользователя есть правоuploadна элемент и запрошена не конкретная (историческая) версия, а актуальная. - Остальные права (
download,print,copy,comment,review,fillForms,chat,protect,modifyContentControl,modifyFilter) определяются наличием у пользователя праваupload. document.urlиeditorConfig.callbackUrl— это адреса методовGetDocument/ProcessCallbackэтого же контроллера, которые OnlyOffice Document Server будет вызывать сам.configдополнительно подписывается JWT-токеном (полеtoken) для проверки подлинности запроса document-сервером.
🌐 HTTP-информация
- Метод:
GET - URL:
/onlyOffice/api/editor/GetConfig/{itemId}или/onlyOffice/api/editor/GetConfig/{itemId}/{version} - Headers:
Authorization: <UserSessionToken>
📥 Параметры запроса (URL Path)
| Параметр | Тип | Описание |
|---|---|---|
itemId | Guid | ID элемента-файла, открываемого в редакторе |
version | string | Необязательный. Имя конкретной (исторической) версии файла. Если не указано — открывается актуальная версия в режиме редактирования (при наличии прав); если указано — открывается указанная версия только в режиме просмотра |
📤 Тело ответа (Response Body)
| Поле | Тип | Описание |
|---|---|---|
documentServerApiUrl | string | URL скрипта API document-сервера OnlyOffice, который нужно подключить на странице редактора |
config | object | Объект конфигурации для DocsAPI.DocEditor (согласно спецификации OnlyOffice): содержит documentType, type, width, height, document (fileType, key, title, url, permissions), editorConfig (callbackUrl, lang, mode, user, customization) и token (JWT-подпись конфигурации) |