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

    Описание API

    • Dark
      Light
    • PDF

    Article summary

    В данном разделе представлено общее описание возможностей 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?