Власник простору на плані «Про», «Команда» чи «Корпоративний» створює токен у розділі «Налаштування», «Інтеграції». Повний довідник є на сторінці Документація 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.