API
Подписи
Подписание
Электронные подписи: запросы, проверка, отзыв.
Подписание — подписи и печати
Файлы и снимки подписи.
Подписание — по ссылке
Публичное подписание по короткой ссылке (OTP).
Подписание — проверка
Публичная верификация подписей.
Операции
Всего операций: 40. Полные схемы запросов и ответов — на страницах разделов.
Подписание
| Метод | Путь | Операция |
|---|---|---|
POST | /api/v1/signatures | Создать запрос на подпись |
GET | /api/v1/signatures/inbox | Входящие запросы на подпись |
GET | /api/v1/signatures/sent | Отправленные запросы на подпись |
DELETE | /api/v1/signatures/{id} | Удалить запрос на подпись |
GET | /api/v1/signatures/{id} | Получить запрос на подпись |
PATCH | /api/v1/signatures/{id} | Переименовать запрос на подпись |
GET | /api/v1/signatures/{id}/comments | Список комментариев к подписанию |
POST | /api/v1/signatures/{id}/comments | Добавить комментарий (инициатор) |
GET | /api/v1/signatures/{id}/document | Получить документ для предпросмотра (актуальный или подписанный snapshot) |
POST | /api/v1/signatures/{id}/duplicate | Дублировать запрос на подпись |
GET | /api/v1/signatures/{id}/export/pdf | Экспорт PDF для конкретного запроса подписания (snapshot + signings ЭТОГО request) |
POST | /api/v1/signatures/{id}/reject | Отклонить подпись |
POST | /api/v1/signatures/{id}/remind | Отправить напоминание подписанту |
POST | /api/v1/signatures/{id}/revoke | Отозвать подпись |
POST | /api/v1/signatures/{id}/send-otp | Отправить OTP-код подписанту |
POST | /api/v1/signatures/{id}/sign | Подписать документ |
GET | /api/v1/signatures/{id}/snapshot-to-sign | Получить snapshot документа для подписи |
POST | /api/v1/signatures/{id}/verification | Загрузить видео верификации |
Подписание — подписи и печати
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/signatures/assets | Список факсимиле и печатей команды |
POST | /api/v1/signatures/assets | Загрузить факсимиле или печать |
POST | /api/v1/signatures/assets/team | Загрузить ассет команды (логотип, печать) |
GET | /api/v1/signatures/assets/user/{userId} | Список факсимиле и печатей пользователя |
DELETE | /api/v1/signatures/assets/{id} | Удалить факсимиле/печать |
GET | /api/v1/signatures/assets/{id}/file | Получить изображение факсимиле/печати |
Подписание — по ссылке
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/signatures/sign-public/{shortId} | Контекст подписания для публичного подписанта |
GET | /api/v1/signatures/sign-public/{shortId}/assets/{kind} | Изображение подписи или печати, доступное публичному подписанту |
GET | /api/v1/signatures/sign-public/{shortId}/comments | Комментарии (публично, по shortId) |
POST | /api/v1/signatures/sign-public/{shortId}/comments | Добавить комментарий (публично, как подписант) |
GET | /api/v1/signatures/sign-public/{shortId}/document.pdf | PDF документа для предпросмотра подписанту |
POST | /api/v1/signatures/sign-public/{shortId}/reject | Отклонить подписание |
POST | /api/v1/signatures/sign-public/{shortId}/send-otp | Отправить OTP подписанту |
POST | /api/v1/signatures/sign-public/{shortId}/sign | Подписать документ |
GET | /api/v1/signatures/sign-public/{shortId}/snapshot-to-sign | Snapshot для подписи (УКЭП) |
Подписание — проверка
| Метод | Путь | Операция |
|---|---|---|
GET | /api/v1/verify/blob/{blob} | Распаковать ссылку проверки в short ID |
GET | /api/v1/verify/{shortId} | Проверить подпись по short ID |
GET | /api/v1/verify/{shortId}/document | Отрендерить snapshot подписанного документа |
GET | /api/v1/verify/{shortId}/document.docx | Экспортировать подписанный документ в DOCX |
GET | /api/v1/verify/{shortId}/document.pdf | Экспортировать подписанный документ в PDF |
POST | /api/v1/verify/{shortId}/send-pdf | Отправить PDF подписанного документа на разрешённый адрес |
POST | /api/v1/verify/{shortId}/unlock | Разблокировать доступ к проверке кодом |