Основные

Часто задаваемые вопросы о Сервере документов:
Основные вопросы

Свернуть все

Я новичок в API сервера документов. С чего мне следует начать?
Если вы не знаете, с чего начать работу с API Сервера документов, рекомендуем сначала прочитать разделы Основные концепции и Как это работает , чтобы лучше понять, как устроен API Сервера документов. После того, как вы ознакомитесь с основными понятиями, вы можете посетить раздел «Попробовать сейчас», чтобы увидеть живые примеры основных функций Сервера документов в действии.

Если вас интересует конкретный пример языка программирования, см. примеры для конкретных языков, которые доступны на нескольких языках программирования, и объясните, как установить Сервер документов, где взять исходные файлы примеров и как их установить и подключить Сервер документов.

Пользователям, использующим некоторые системы управления документами (Nextcloud, ownCloud, SharePoint и т. д.) и просто желающим узнать, как подключить Сервер документов к этим системам, следует посетить раздел готовые к использованию коннекторы, где собраны все основные плагины, работающие с Сервером документов.

Подробное описание каждого метода API доступно в более крупном модуле «Документация». Все методы описаны в соответствующих разделах, их список доступен в Расширенных параметрах.

Как узнать номер текущей версии Сервера документов?

Текущий номер версии Сервера документов можно найти на странице «О программе» редактора документов, презентаций или электронных таблиц, прямо под логотипом и названием редактора.

Вы можете использовать API для отправки запроса POST в службу управления документами. Используйте параметр c для этого со значением версии, которое отправляется как объект JSON в теле запроса:

{
    "c": "version"
}

Результат запроса версии возвращается в форме JSON, например:

{
    "error": 0,
    "version": "4.3.1.4"
}
Более подробная информация о взаимодействии с службой управления документами и использовании для этого различных команд доступна на этой странице.

Я хочу изменить некоторые параметры Сервера документов из файла конфигурации default.json. Как мне сделать так, чтобы мои изменения не были потеряны после обновления?

AВсе основные настройки Document Sever хранятся в конфигурационном файле default.json, который находится в папке /etc/Р7/documentserver/ (для Linux) или %ProgramFiles%\Р7\DocumentServer\config\ (для Windows). В той же папке есть файл production.json для конкретной платформы, в котором хранятся настройки, актуальные для Linux или Windows.

Сервер документов использует Node.js модуль конфигурации для организации и структурирования файлов конфигурации, поэтому иерархия этих файлов выглядит следующим образом:

default.json
production.json
local.json

Где все основные настройки хранятся в файле default.json, при этом некоторые из них добавляются или переопределяются настройками из файла production.json, а любые настройки пользователя/разработчика переопределяются настройками из файла конфигурации local.json.

Если вы измените параметры в файле default.json или production.json, все изменения будут потеряны после обновления Сервера документов или перезапуска контейнера Docker (если у вас Сервер документов установлен с помощью Docker).
Поэтому мы настоятельно рекомендуем вам не изменять параметры ни в файлах default.json, ни в файлах production.json, а вместо этого использовать файл конфигурации local.json. Этот файл должен быть создан в той же папке, что и файл default.json, при этом вся структура объекта для необходимого параметра должна быть сохранена.

Примеры использования local.json можно найти в следующих разделах:

Сохранить задержку
Принудительное сохранение
Запрос с токеном в теле
Включение WOPI
IP-фильтр