Запись опубликована:27.07.2023
Post category:API
Запись изменена:27.07.2023

Базовые концепции

Р7 Document Server это офисный пакет с открытым исходным кодом, включающий редактор для текстовых документов, электронных таблиц, презентаций и заполняемых форм. Он предоставляет следующие функции:

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

Р7 Document Server также поддерживает протокол WOPI, который используется для интеграции вашего приложения с онлайн офисом.

API Сервера документов используется для того, чтобы дать разработчикам возможность интегрировать Р7-Офис Редакторы документов/электронных таблиц/ презентаций в их собственные веб-сайты, настраивать редакторы и управлять ими.

Javascript файл API обычно может быть найден в следующей папке редактора:

https://documentserver/web-apps/apps/api/documents/api.js

Где documentserver — имя сервера, на котором установлен Сервер документов.

Целевой HTML файл, в который должны быть встроены редакторы, должен иметь тег-заполнитель div, в который будет передана вся информация о редакторе:

<div id="placeholder"></div>
<script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script>

Код страницы, содержащий изменяемые параметры выглядит следующим образом:

var docEditor = new DocsAPI.DocEditor("placeholder", config);

Где config — это объект:

config = {
    "document": {
        "fileType": "docx",
        "key": "Khirz6zTPdfd7",
        "title": "Example Document Title.docx",
        "url": "https://example.com/url-to-example-document.docx"
    },
    "documentType": "word",
    "editorConfig": {
        "callbackUrl": "https://example.com/url-to-callback.ashx"
    }
};

Где example.com — имя сервера, на котором установлены менеджер документов и сервис хранения документов. Смотрите раздел Как это работает, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.

Теперь объект docEditor может быть использован, чтобы вызывать методы редактора документов.

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