Описание
Раздел документа позволяет изменить все параметры, относящиеся к документу (название, URL, тип файла и т. д.).
| Название | Описание | Тип | Пример |
|---|---|---|---|
| fileType* | Определяет тип файла исходного просматриваемого или редактируемого документа. Должен быть в нижнем регистре. Доступны следующие типы файлов: .csv, .djvu, .doc, .docm, .docx, .docxf, .dot, .dotm, .dotx, .epub, .fb2, .fodp, .fods, .fodt, .htm, .html, .mht, .odp, .ods, .odt, .oform, .otp, .ots, .ott, .oxps, .pdf, .pot, .potm, .potx, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf, .txt, .xls, .xlsb, .xlsm, .xlsx, .xlt, .xltm, .xltx, .xml, .xps. | строковый | «docx» |
| key* | Определяет уникальный идентификатор документа, используемый службой для распознавания документа. В случае отправки известного ключа документ будет взят из кеша. Каждый раз, когда документ редактируется и сохраняется, ключ необходимо генерировать заново. В качестве ключа можно использовать URL-адрес документа, но без специальных символов, а длина ограничена 128 символами. | строковый | «Khirz6zTPdfd7» |
| referenceData | Определяет объект, создаваемый интегратором для уникальной идентификации файла в его системе: fileKey — уникальный идентификатор документа, используемый сервисом для получения ссылки на файл. Его нельзя менять при редактировании и сохранении документа (т.е. он не равен параметру document.key), тип: строка, пример: «BCFA2CED»; instanceId — уникальный идентификатор системы. Если данные были скопированы из файла в одной системе, и вставлены в файл в другой, то вставка по ссылке будет недоступна и в контекстном меню не будет соответствующей кнопки, тип: строка, пример: «https://example.com». | объект | { «fileKey»: «BCFA2CED», «instanceId»: «https://example.com» } |
| title* | Определяет желаемое имя файла для просматриваемого или редактируемого документа, которое также будет использоваться в качестве имени файла при загрузке документа. Длина ограничена 128 символами. | строковый | «Example Document Title.docx» |
| url* | Определяет абсолютный URL-адрес, где хранится исходный просмотренный или отредактированный документ. Обязательно добавляйте token при использовании локальных ссылок. В противном случае произойдет ошибка. | строковый | «https://example.com/url-to-example-document.docx» |
Уточнение
* -Обязательное поле.
Пример
var docEditor = new DocsAPI.DocEditor("placeholder", {
"document": {
"fileType": "docx",
"key": "Khirz6zTPdfd7",
"referenceData": {
"fileKey": "BCFA2CED",
"instanceId": "https://example.com"
},
"title": "Example Document Title.docx",
"url": "https://example.com/url-to-example-document.docx",
},
...
});
Где example.com — это имя сервера, на котором установлены менеджер документов и служба хранения документов. Дополнительные сведения о взаимодействии клиент-сервер службы Сервера документов см. в разделе Как это работает.
Уточнение
Можно использовать ключевые символы: 0-9, a-z, A-Z, -._=. Максимальная длина ключа составляет 20 символов.