Владелец пространства на плане «Про», «Команда» или «Корпоративный» создаёт токен в разделе «Настройки», «Интеграции». Полный справочник есть на странице Документация API, а машиночитаемое описание OpenAPI 3.1 по адресу /api/v1/openapi.json, чего большинству генераторов достаточно, чтобы создать типизированный клиент. Мы не публикуем SDK, написанный вручную.
Основные конечные точки
| Метод | Путь | Что делает |
|---|---|---|
POST | /api/v1/envelopes | Создать комплект из загруженных PDF вместе с полями |
POST | /api/v1/envelopes/{id}/send | Отправить черновик комплекта на подпись |
GET | /api/v1/envelopes | Показать список комплектов с фильтрами и страницами |
GET | /api/v1/envelopes/{id} | Прочитать состояние комплекта и ход подписания у получателей |
POST | /api/v1/envelopes/from-refs | Создать комплект по ссылкам на документы |
POST | /api/v1/envelopes/{id}/remind | Отправить напоминание подписантам, которые ещё не подписали |
POST | /api/v1/envelopes/{id}/void | Отменить комплект |
GET | /api/v1/envelopes/{id}/final | Скачать завершённый (сведённый) PDF |
GET | /api/v1/envelopes/{id}/certificate | Скачать сертификат аудита |
GET | /api/v1/envelopes/{id}/recipients | Показать получателей и ход подписания |
PATCH | /api/v1/envelopes/{id}/recipients/{rid} | Исправить данные получателя, в том числе после отправки |
POST | /api/v1/envelopes/{id}/recipients/{rid}/remind | Напомнить одному названному получателю |
GET | /api/v1/templates | Показать шаблоны пространства |
POST | /api/v1/templates/{id}/envelopes | Создать из шаблона (и по желанию отправить) |
GET | /api/v1/openapi.json | Описание OpenAPI 3.1 всего перечисленного |
Запрос с аутентификацией
curl https://vg-sign.com/api/v1/envelopes/{id} \
-H "Authorization: Bearer vgs_live_…"Подпись вебхука
Каждая доставка содержит дайджест HMAC-SHA256 необработанного тела запроса. Проверьте его секретом подписки, прежде чем доверять содержимому. Доставку пробуют до 3 раз (повторы примерно через 1 и 5 минут), а затем отмечают как неудачную. Идентификатор доставки не меняется между попытками. Используйте его, чтобы отбрасывать дубликаты.
X-VG-Signature: sha256=4c2a9bd3…71ff X-VG-Delivery-Id: 8f4a2c1e-9b3d-4f02-a71c-2d5e6b8c0a19
Сервер MCP
Claude, Claude Code и Cursor могут показывать список комплектов, создавать комплект из шаблона, отправлять его и скачивать подписанный PDF. Это сервер типа stdio поверх того же API REST и того же токена пространства; дополнительных прав он не получает. Токенов с ограниченными правами нет, так что помощник может делать всё, что может токен. Рассмотрите отдельное пространство для него. Замена токена действует сразу и прерывает все остальные интеграции, которые ещё используют старый, поэтому заменяйте его всякий раз, когда он мог попасть в чужие руки.
curl -fsSLO https://vg-sign.com/mcp/server.mjs curl -fsSL https://vg-sign.com/mcp/server.mjs.sha256 | sha256sum -c -
{
"mcpServers": {
"vg-sign": {
"command": "node",
"args": ["/path/to/server.mjs"],
"env": {
"VG_SIGN_API_TOKEN": "vgs_live_…",
"VG_SIGN_DOWNLOAD_DIR": "/path/to/a/downloads/folder"
}
}
}
}send_envelope, remind_envelope, void_envelope и create_envelope_from_template с send: true действуют на настоящие комплекты и отправляют письма настоящим людям. Отправку отменяет именно отмена комплекта; саму отмену другим вызовом не отменить.
Встроенное подписание
Разместите страницу подписания в своём продукте. Сначала ваш источник должен быть в списке разрешённых, попросите нас его добавить, а фрейм передаёт ход подписания в родительское окно.
<script src="https://vg-sign.com/embed.js"></script>
<div id="vg-sign" data-token="RECIPIENT_TOKEN"></div>
VGSign.mount({ onSigned: e => …, onDeclined: e => … })
// Under the hood the frame posts { source: 'vg-sign', type, token } to
// the parent window when the signer reaches a terminal state.