Описание API
  • 29 May 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Описание API

  • Dark
    Light
  • PDF

Article Summary

Doczilla is an API that provides access to a wide range of documents and files. It offers users the ability to search, view, and download documents with ease. It also provides tools for creating and managing documents, as well as for sharing them with others. Additionally, it allows users to customize their document experience by setting up rules for how they want their documents to be displayed. Doczilla also offers an extensive library of templates and other resources that can be used in creating documents. Finally, it provides support for various file formats so that users can easily access the content they need.

В данном разделе представлено общее описание возможностей API, детализацию методов с примерами запросов и ответов можно найти по ссылке.

Действия с документами

В данном разделе представлено общее описание возможностей API, детализацию методов с примерами запросов и ответов можно найти по ссылке

В Doczilla существуют объекты: шаблон и анкета. 

Интерактивный шаблон (.dotx) - файл с общей структурой, в котором производится разметка документа, создается его схема. 

Анкета (.docz) - создается на основании шаблона. 

Здесь производится автоматическое заполнение документа, путем ответа на вопросы. Таким образом, можно иметь один шаблон договора, например купли-продажи, и создавать на основании его анкеты под каждую сделку.


Название методаОписание
createDoczСоздание анкеты из шаблона. Без заполнения
fillDoczМетод для заполнения созданной анкеты
getСкачивание файла. В теле метода вы сами определяете в каком формате, вы хотите скачать документ
getByIdВозвращает информацию о документе по его ID: имя, формат,  путь, кто и когда создал документ, статус, кто и когда изменял/публиковал документ, информацию о скачиваниях и открытиях документа, ссылку на документ.
getByLinkАналогичен предыдущему методу, только информация возвращается по ссылке на документ.
setСохранение, существующего в Doczilla файла
createСоздание нового документа. Действие аналогично кнопке "Создать документ" в Doczilla.
moveПеремещение документа в Doczilla, в методе необходимо указать папку назначение.
copyМетод копирования файла с возможностью указать, какую версию копировать, в какую папку поместить копию и какое имя задать новому документу.
recycleПеремещение файла в корзину.
restoreВосстановление файла из корзины.
shareНастройка доступа к файлу с указанием, какой уровень доступа выдать и на какой период.
publishПубликация шаблона.
publicationApplyПрименение изменений в анкете после изменение шаблона.
publicationRejectОтказ от изменений в анкете после изменение шаблона.
editСнятие шаблона с публикации и перевод в статус "В работе".
createVersionМетод создание версии документа.

Действия с пользователями

ЗапросОписание
loginАвторизация в системе
createСоздание учетной записи
copyКопирование учетной записи
readПолучение данных по учетной записи
updateИзменение полей учетной записи
destroyУдаление учетной записи
export-reportСоздание отчета по записям
previewВыгрузка отчета в формате pdf

Was this article helpful?