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

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

Available on all Developer API plans.

Все члены

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

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

Предпосылки

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

  1. Используйте конечную точку POST /v2/envelope/from_template/{template_id} для создания нового конверта из шаблона.
  2. Заменить {template_id}идентификатором вашего существующего шаблона.
    Где я могу найти мой ID шаблона?
    • Перейдите на https://app.sign.plus/templates.
      Скриншот 2024-10-07 по адресу 17.44.20.png
    • Нажмите на нужное имя шаблона.
      Template ID.png
    • Копировать ID из правой боковой панели.
  3. Послать запрос POST на POST /v2/envelope/from_template/{template_id} со следующим телом JSON:
    {
    "name": "Мой замечательный конверт из шаблона"
    }
  4. Включите ваш API ключ в заголовок Authorization.
  5. On success, you will receive an Envelopeobject. {
    "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": {
    //
    }
    }
  6. Сохраните возвращенное id как envelope_id для будущих вызовов API.
  7. Record the idof each recipient for later use in the signing process.
    Examples:
    • 66eb7d0467d2d549b89fcb71: First SIGNER(Step 1)
    • 66eb7d0467d2d549b89fcb71: RECEIVES_A_COPY(Step 1)
    • 66eb7d0467d2d549b89fcb72: Второй SIGNER(Step 2)

Шаг 2: Установить детали получателя

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

  1. Используйте конечную точку POST /v2/envelope/{envelope_id}/signing_steps для обновления информации получателя.
  2. Заменить {envelope_id} идентификатором, полученным на шаге 1.
  3. Отправьте запрос 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"
    }
    ]
    }
    ]
    }
  4. При успешном завершении вы получите массив SigningStep.

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

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

Заключение

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

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

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