Как отправить документ из существующего шаблона на подписание?

Эта статья описывает процесс отправки документа на подписание с использованием шаблона через API Sign.Plus для электронной подписи.

Выполнив эти шаги, вы создадите конверт из шаблона, укажете данные получателей и отправите конверт на подписание.

Предварительные требования

• Учётная запись Sign.Plus с тарифом API
• Ваш Personal Access Token
• Существующий шаблон в вашей учётной записи Sign.Plus 

Шаг 1. Создайте конверт из шаблона

1. Используйте конечную точку POST /v2/envelope/from_template/{template_id}, чтобы создать новый конверт на основе шаблона.
2. Замените {template_id} на ID вашего существующего шаблона.
   Где найти ID моего шаблона?
   • Перейдите по адресу https://app.sign.plus/templates .
     
   • Нажмите на название нужного шаблона.
     
   • Скопируйте ID из правой боковой панели.
3. Отправьте POST-запрос на POST /v2/envelope/from_template/{template_id} со следующим телом JSON:
   {
"name": "My wonderful envelope from template"
}
4. Укажите ваш API-ключ в заголовке Authorization.
5. При успешном выполнении вы получите объект an Envelope. {
"id": "66eb7d0467d2d549b89fcb6d",
// ...
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"uid": null,
"name": "",
"email": "",
"role": "SIGNER",
"verification": null
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"uid": null,
"name": "",
"email": "",
"role": "RECEIVES_COPY",
"verification": null
},
{
"id": "66eb7d0467d2d549b89fcb72",
"uid": null,
"name": "",
"email": "",
"role": "SIGNER",
"verification": null
}
]
}
],
"documents": [
// ...
],
"notification": {
// ...
}
}
6. Сохраните возвращённый id как envelope_id для дальнейших вызовов API.
7. Запишите idкаждого получателя для использования на дальнейших этапах подписания.
   Примеры:
   • 66eb7d0467d2d549b89fcb71: первый SIGNER (шаг 1)
   • 66eb7d0467d2d549b89fcb71: RECEIVES_A_COPY (шаг 1)
   • 66eb7d0467d2d549b89fcb72: второй SIGNER (шаг 2)

Шаг 2. Укажите данные получателей

Если в вашем шаблоне не заданы фиксированные получатели и вам нужно указать или изменить их данные:

1. Используйте конечную точку POST /v2/envelope/{envelope_id}/signing_steps, чтобы обновить информацию о получателях.
2. Замените {envelope_id} на ID, полученный на шаге 1.
3. Отправьте запрос POST со следующим телом JSON:
   {
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"name": "John Doe",
"email": "john.doe@example.com",
"role": "SIGNER"
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"name": "Mark Twain",
"email": "m.twain@example.com",
"role": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"name": "Jane Smith",
"email": "j.smith@example.com",
"role": "SIGNER"
}
]
}
]
}
4. В случае успеха вы получите массив объектов SigningStep.

Шаг 3. Отправьте конверт на подписание

1. Используйте конечную точку POST /v2/envelope/{envelope_id}/send, чтобы отправить конверт.
2. Замените {envelope_id} на ID вашего конверта из шага 1.
3. Отправьте запрос POST на эту конечную точку.
4. В случае успеха конверт будет отправлен получателям на подписание.

Заключение

Теперь вы успешно отправили документ на подписание с помощью шаблона через API Sign.Plus для электронной подписи. Получатели получат уведомление по электронной почте со ссылкой для подписания документа.

Использование шаблонов позволяет значительно упростить процесс подписания документов, особенно для часто используемых документов с единым форматом и требованиями к подписанию.