Как отправить документ на подпись?

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

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

Требования

• Учётная запись Sign.Plus с тарифом API
• Ваш Personal Access Token

Шаг 1: создание конверта

Конверт — это контейнер для документов, которые должны подписать получатели.

1. Отправьте запрос к эндпоинту POST /v2/envelope, чтобы создать новый конверт. {
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
}
2. Укажите ваш API-ключ в заголовке Authorization .

3. При успешном выполнении запроса вы получите объект Envelope.

   { "id": "<string>" ... }

4. Сохраните id в качестве envelope_id

Шаг 2: добавление документа в конверт

1. Используйте эндпоинт POST /v2/envelope/{envelope_id}/document, чтобы добавить документ.

2. Замените {envelope_id} на идентификатор, полученный на шаге 1.

3. Отправьте POST-запрос с файлом документа в теле запроса в формате multipart/form-data.

4. В случае успеха вы получите в ответ объект Document.
   { "id": "<string>" ... }

5. Сохраните id в качестве document_id для дальнейшего использования.

Шаг 3: указание получателя конверта

1. Используйте эндпоинт POST /v2/envelope/{envelope_id}/signing_steps, чтобы добавить получателя.

2. Замените {envelope_id} на ID вашего конверта.

3. Отправьте запрос POST со следующим телом JSON:

   {
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] }

4. В случае успешного выполнения вы получите массив SigninStep.

5. Просмотрите массив и найдите значение id получателя, для которого нужно добавить область подписи (аннотацию подписи). Сохраните это значение id в качестве recipient_id.

Шаг 4: добавление аннотации подписи в документ

Перед добавлением аннотации подписи убедитесь, что вы определили свою подпись на платформе Sign.Plus.

1. Используйте эндпоинт POST /v2/envelope/{envelope_id}/annotation, чтобы добавить аннотацию подписи.
2. Замените {envelope_id} на ID вашего конверта. 
3. Отправьте POST-запрос со следующим телом JSON:
   {
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}

   Замените <recipient_id> и <document_id> на соответствующие значения.

Шаг 5: отправка конверта на подпись

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

Заключение

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

Более подробную информацию о каждом эндпоинте API, используемом в этом процессе, вы найдёте в нашей документации по API.