Описание API
- 16 Oct 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
-
PDF
Описание API
- Updated on 16 Oct 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
-
PDF
В данном разделе представлено общее описание возможностей 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?