Эта статья расскажет вам о процессе отправки документа для подписи, используя шаблон с Sign.Plus eSignature API.
Следуя этим шагам, вы создадите конверт из шаблона, задаете реквизиты получателя и отправляете конверт для подписи.
Предпосылки
- Аккаунт Sign.Plus с API-планом
- Your
Personal Access Token
- An existing template in your Sign.Plus account
Шаг 1: Создать конверт из шаблона
- Используйте конечную точку POST /v2/envelope/from_template/{template_id} для создания нового конверта из шаблона.
- Заменить
{template_id}
идентификатором вашего существующего шаблона.
Где я могу найти мой ID шаблона?- Перейдите на https://app.sign.plus/templates.
- Нажмите на нужное имя шаблона.
- Копировать ID из правой боковой панели.
- Перейдите на https://app.sign.plus/templates.
- Послать запрос POST на
POST /v2/envelope/from_template/{template_id}
со следующим телом JSON:{
"name": "Мой замечательный конверт из шаблона"
} - Включите ваш API ключ в заголовок
Authorization
. - On success, you will receive
an Envelope
object.{
"id": "66eb7d0467d2d549b89fcb6d",
// ...
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"uid": null,
"name": "",
"email": "",
"роль": "СИГНЕР",
"verification": null
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"uid": null,
"name": "",
"email": "",
"роль": "RECEIVES_COPY",
"verification": null
},
{
"id": "66eb7d0467d2d549b89fcb72",
"uid": null,
"name": "",
"email": "",
"роль": "СИГНЕР",
"verification": null
}
]
}
],
"documents": [
// . .
],
"notification": {
//
}
} - Сохраните возвращенное
id
какenvelope_id
для будущих вызовов API. - Record the
id
of each recipient for later use in the signing process.
Examples:-
66eb7d0467d2d549b89fcb71
: FirstSIGNER
(Step 1) -
66eb7d0467d2d549b89fcb71
:RECEIVES_A_COPY
(Step 1) -
66eb7d0467d2d549b89fcb72
: ВторойSIGNER
(Step 2)
-
Шаг 2: Установить детали получателя
Если ваш шаблон не имеет фиксированных получателей и вам необходимо установить или обновить данные получателя:
- Используйте конечную точку POST /v2/envelope/{envelope_id}/signing_steps для обновления информации получателя.
- Заменить
{envelope_id}
идентификатором, полученным на шаге 1. - Отправьте запрос
POST
со следующим телом JSON:{
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"name": "John Doe",
"email": "john. oe@example. om",
"role": "SIGNER"
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"name": "Mark Twain",
"email": "m. wain@example. om",
"роль": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"name": "Jane Smith",
"email": "j. mith@example. om",
"роль": "SIGNER"
}
]
}
]
} - При успешном завершении вы получите массив
SigningStep
.
Шаг 3: Отправить конверт для подписания
- Используйте POST /v2/envelope/{envelope_id}/send для отправки конверта.
- Заменить
{envelope_id}
на ваш конверт ID из Шага 1. - Отправить запрос
POST
на эту конечную точку. - При успешном завершении конверт будет отправлен получателю(ям) для подписи.
Заключение
Документ для подписи успешно отправлен с помощью шаблона API подписи Sign.Plus. Получатель (адреса) получит уведомление по электронной почте со ссылкой на подпись документа.
Использование шаблонов может значительно упростить процесс подписания документа, особенно для часто используемых документов с последовательными макетами и требованиями к подписанию.