helpcenter/helpcenter.r7-office.ru/Web/Controls/Help/APIEditors/Basic.ascx

<%@ Control Language="C#" Inherits="BaseContentUserControls" %> <%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %><script runat="server">
    protected override void Init()
    {
        PageTitle = PageCaption = "Basic concepts";
        MetaDescription = "Статьи документации по API сервера документов.";
    }
</script>
<div class="MainHelpCenter">
    <h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Основные понятия</h1>

    <p class="dscr">API Сервера документов используется для того, чтобы дать разработчикам возможность интегрировать Р7-Офис</p>

    <p>Javascript файл API может быть найден в следующей папке редактора:</p>
    <p><b>https://documentserver/web-apps/apps/api/documents/api.js</b></p>
    <p>Где <b>documentserver</b> - имя сервера, на котором установлен Сервер документов.</p>
    <div class="note">Для версий <b>Сервера Документов</b> ниже 4.0 путь к API будет выглядеть следующим образом: <br /> <b>https://documentserver/OfficeWeb/apps/api/documents/api.js</b></div>

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

    <pre>
&lt;div id=&quot;placeholder&quot;&gt;&lt;/div&gt;
&lt;script type=&quot;text/javascript&quot; src=&quot;https://documentserver/web-apps/apps/api/documents/api.js&quot;&gt;&lt;/script&gt;
</pre>

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

    <pre>
var docEditor = new DocsAPI.DocEditor(&quot;placeholder&quot;, config);
</pre>

    <p>Где <em>config</em> - это объект:</p>

    <pre>
config = {
    &quot;document&quot;: {
        &quot;fileType&quot;: &quot;docx&quot;,
        &quot;key&quot;: &quot;Khirz6zTPdfd7&quot;,
        &quot;title&quot;: &quot;Пример названия документа.docx&quot;,
        &quot;url&quot;: &quot;https://example.com/url-to-example-document.docx&quot;
    },
    &quot;documentType&quot;: &quot;text&quot;,
    &quot;editorConfig&quot;: {
        &quot;callbackUrl&quot;: &quot;https://example.com/url-to-callback.ashx&quot;
    }
};
</pre>
    <p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>

    <p>Теперь объект <i>docEditor</i> может быть использован, чтобы вызывать <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/methods.aspx")%>">методы</a> <b>редактора документов</b>.</p>

    <p>Вышеописанный пример включает все параметры, необходимые для корректного запуска Сервера Документов. Существуют также дополнительные необязательные параметры, которые могут быть изменены, чтобы добиться различных результатов, при работе с вашим документом (изменить права доступа к документу, отобразить иную информацию о документе, и т.д.) Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/advanced.aspx")%>">Расширенные параметры</a>, чтобы узнать, что означают эти параметры и как вы можете изменять их.</p>

    <h2>Поддержка</h2>
    <p>Вы можете задать вопрос нашим разработчикам по адресу <a href="http://dev.onlyoffice.org/viewforum.php?f=9" target="_blank">dev.onlyoffice.org</a> (необходима регистрация).</p>
</div>