Логіка взаємодії з API

Отримання списку шаблонів і полів шаблонів

Для створення документа необхідно отримати список шаблонів і полів шаблонів.

1. Для отримання списку шаблонів необхідно виконати метод /templates;
2. Обрати один з шаблонів для заповнення (на даний момент MULTIDOC - універсальний документ);
3. Для отримання списку полів шаблону необхідно виконати метод /templates/:code.

tip

Отримати список шаблонів і полів шаблонів необхідно лише один раз на початку роботи, немає необхідності отримувати їх перед створенням кожного документа

Створення і надсилання документа

1. Для заповнення полів шаблону та отримання файлів для підпису необхідно виконати метод /templates/:code/fill.
   У відповідь ви отримаєте body (тіло xml документа) та image_body (pdf представлення документа) для накладання на них КЕП.

   💡 Можлива передача заповнених полів на сервер для отримання PDF представлення документа та перегляду коректності заповнення полів за допомогою метода /templates/:code/pdf

2. Необхідно надіслати підписані body та image_body на сервер (можливо додати масив підписаних вкладень additional_files) та подальше їх надсилання контрагенту за допомогою метода /documents/create.

   💡Документ отримає статус SENT

3. Контрагент може погодити або відхилити документ. Статус документа зміниться на APPROVED або REJECTED відповідно.
   У випадку коли контрагент погодив документ можливо отримати підписані файли (PDF, xml, additional_files) використовуючи наступні методи для кожного типу файлу:
   • PDF - /documents/:uuid/pdf
   • xml - /documents/:uuid/xml
   • additional_files - /documents/:uuid/attached

Отримання детальної інформації про документ

Для отримання детальної інформації про один документ виконайте метод /documents/:uuid.

Погодження/відхилення документа

1. Для отримання списку доступних документів необхідно виконати метод /documents.
2. Необхідно отримати документ для його підпису і подальшого погодження. Для цього виконайте метод /documents/:uuid/files.
3. Для погодження документа необхідно виконати метод /documents/:uuid/approve. Статус документа зміниться на APPROVED.
4. Для відхилення документа необхідно виконати метод /documents/:uuid/reject. Статус документа зміниться на REJECTED.

Отримання документа

1. Для отримання списку доступних документів виконайте метод /documents.
2. Якщо необхідно отримати PDF представлення документа виконайте метод /documents/:uuid/pdf
3. Якщо необхідно отримати xml представлення документа виконайте метод /documents/:uuid/xml
4. Для завантаження прикріплених до документа файлів виконайте метод /documents/:uuid/attached