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

Кто может использовать эту функцию?

Available on all Developer API plans.

Все члены

Эта статья расскажет о процессе отправки документа для подписи, используя Sign.Plus eSignature API.

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

Предпосылки

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

Конверт - это контейнер для подписи документов получателями.

  1. Послать запрос конечной точке POST /v2/envelope для создания нового конверта. {
    "name": "Мой замечательный конверт",
    "flow_type": "REQUEST_SIGNATURE",
    "legality_level": "SES",
    "expires_at": 1831280113,
    "Песочница": true
    }
  2. Включите ваш API ключ в заголовок Authorization .
  3. После успеха вы получите объект Конверта.

    { "id": "<string>" ... }
  4. Сохраните id в качестве конверта

Шаг 2: Добавьте документ в ваш конверт

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

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

  3. Отправить запрос POST с файлом документа в теле запроса в виде мультичасти/формы-данных.
  4. On success, you'll receive a Document object as a response.
    { "id": "<string>" ... }

  5. Сохраните id в качестве document_id позже.

Шаг 3: Установите получателя для вашего конверта

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

  2. Replace {envelope_id} with your envelope ID.

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

    {
    "signing_steps": [
    {
    "recipients": [
    {
    "name": "John Doe", "email": "john. oe@example. om", "роль": "СИГНЕР"
    } ] } ] }
  4. Успешно вы получите массив SigninStep.

  5. Просмотрите массив и выберите имя получателя id для которого вы хотите добавить рамку подписи (аннотация с подписью). Save this id as the recipient_id.

Шаг 4: Вставьте примечание о подписи в документ

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

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

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

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

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

Заключение

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

Для получения более подробной информации о каждой конечной точке API, используемой в этом процессе, обратитесь к нашей документации по API.

Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 0
More Articles in this section