eUgoda LogoAPI ЕЦП eUgoda

Вступ

Вітаємо у API ЕЦП eUgoda!

У вас є бізнес, повноцінна система внутрішнього електронного документообігу, але ви все ще підписуєте документи з вашими контрагентами через сторонні застосунки і обмінюєтеся ними за допомогою електронної пошти? API ЕЦП eUgoda дасть вам можливість замкнути коло електронного документообігу та легко інтегрувати до вашої системи ЕЦП.

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

Як це працює

  • Реєстрація застосунку. Сконтактуйте з представником eUgoda та надайте йому назву та логотип вашого застосунку. Після реєстрації ви отримаєте ідентифікатор та ключ, які ви використовуватимете для роботи з API.
  • Реєстрація документа. Використовуючи ваш ідентифікатор та ключ, реєструйте документ в eUgoda та отримуйте посилання на сторінку підписання.
  • Підписання. Поширте отримане посилання серед контрагентів, які за допомогою нього матимуть змогу переглянути та підписати ваш документ.
  • Моніторинг. Отримуйте сповіщення про всі дії над документом від сервера безпосередньо в URL, який ви вказали при реєстрації документа.
  • Фіналізація. Отримуйте підписаний документ безпосередньо на електронну пошту, вказану при підписанні, або через API.

Безпека

eUgoda використовує канал звʼязку, захищений протоколом TLS 1.3. Це забезпечує передачу даних в зашифровану вигляді з неможливістю їх розшифрування зловмисниками.

Окрім того, сам протокол комунікації API ЕЦП eUgoda у запитах та відповідях містить службову інформацію, що використовується для перевірки валідності даних:

  • applicationId - ідентифікатор застосунку
  • externalId - ідентифікатор документа у вашій системі
  • timestamp - поточна часова мітка UNIX (UTC)
  • validationString - рядок валідації - HMAC, сформований за допомогою алгоритму MD5 з рядка applicationId|externalId|timestamp, використовуючи ключ застосунку, виданий eUgoda

Зберігаючи ключ застосунку в надійному місці, ви, а також сервер, матимете змогу сформувати HMAC, використовуючи вказані applicationId, externalId та timestamp, та звіряти його із вказаним validationString. Якщо validationString збігається зі сформованим рядком, ви можете бути впевнені, що дані в запиті чи відповіді непідробні.

Опис помилок

Помилка Опис
document_exists Документ з таким ідентифікатором уже був зареєстрований для вашого застосунку
document_not_found Документ з таким зовнішнім ідентифікатором не зареєстрований в eUgoda для вашого застосунку
VALIDATION_ERROR Параметри запиту вказані неправильно. Деталі - в полі data
null / EntityNotFoundError Застосунок не зареєстровано в eUgoda
request_timeout Запит застарілий. Часова мітка, передана в запиті, значно відрізняється від поточної
validation_failed Дані підроблені - рядок перевірки невалідний
parameters_validation_error Параметри для шаблону задані неправильно
template_not_found Шаблон не знайдено
inactive_template Шаблон деактивовано
application_template_access_denied Доступ до шаблону заборонений для вашого застосунку

Зразок

Спрощений зразок інтеграції та його опис ви можете знайти тут.

Контакти

Для уточнення умов та отримання доступу до API надішліть відповідний запит за адресою onix.avacom@gmail.com