Для взаимодействия с командным сервисом документов используются POST запросы. Параметры запроса указываются в теле запроса в формате JSON. Запросы отправляются к https://documentserver/coauthoring/CommandService.ashx.
Где documentserver — имя сервера, на котором установлен Сервер документов.
В Р7 Сервер документов до версии 4.2 использовался GET-запрос с параметрами в QueryString.
См. доступные типы команд ниже, чтобы узнать о них больше.
Типы команд
| Команда | Описание |
|---|---|
| drop | Позволяет отключить пользователей с идентификаторами, указанными в параметре users от сервиса редактирования документов (эти пользователи смогут просматривать документ, но не смогут его редактировать); |
| forcesave | Принудительное сохранение редактируемого документа без его закрытия (после выполнения этой команды редактирование документа может быть продолжено, так что эта версия сохранения документа не будет финальной); |
| info | Получение статуса документа и список идентификаторов пользователей, которые открывают дкумент для редактирования. |
| license | Эта команда позволяет запросить лицензию у Сервера документов с информацией о сервере и пользовательской квоте. |
| meta | Обновляет метаинформацию документа для всех редакторов совместной работы; |
| version | Эта команда позволяет запросить номер текущей версии Сервера документов. |
Веб-маркер JSON должен быть отправлен в формате JSON в службу управления документами. Используется для получения статуса документа с указанным ключом:
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg"
}
Параметры
| Название | Описание | Тип | Наличие |
|---|---|---|---|
| token | Определяет зашифрованную подпись, добавляемую в конфигурацию Сервера документов в виде токена. | строковый | обязательно по конфигурации |
Сервис редактирования документов оповещает сервис хранения документов о результатах выполнения команд, используя обработчик процедур обратного вызова.
Коды возможных ошибок и их описание
| Код ошибки | Описание |
|---|---|
| 0 | Без ошибок. |
| 1 | Не указан ключ документа или не найден документ, с таким ключом. |
| 2 | Некорректная ссылка обратного вызова. |
| 3 | Внутренняя ошибка сервера. |
| 4 | Документ не был изменён до получения команды forcesave. |
| 5 | Неверная команда. |
| 6 | Неверный токен. |