DocuSign API: Создание составного шаблона с использованием серверных документов

Эффективная навигация по API DocuSign для рабочего процесса с документами

В постоянно меняющемся ландшафте цифровых протоколов API DocuSign выделяется как мощный инструмент, разработанный для разработчиков и предприятий для автоматизации электронных подписей. Составные шаблоны, в частности, позволяют использовать многократно используемые структуры документов, упрощая повторяющиеся процессы подписания. Этот подход особенно ценен для предприятий, работающих с большими объемами контрактов, где согласованность и эффективность могут значительно снизить операционные издержки. Используя серверные документы, команды могут предварительно заполнять и настраивать шаблоны без необходимости загрузки на стороне клиента, повышая безопасность и контроль.

Сравниваете платформы электронных подписей с DocuSign или Adobe Sign?

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

👉 Начните бесплатную пробную версию

Раскрытие составных шаблонов в API DocuSign

Составные шаблоны в API DocuSign — это мощная функция для объединения нескольких документов, получателей и полей подписи в один многократно используемый конверт. В отличие от базовых шаблонов, составные шаблоны позволяют объединять документы, размещенные на сервере, с динамическими элементами, что идеально подходит для таких сценариев, как адаптация персонала или соглашения о продажах, где документы необходимо собирать программным способом. Этот серверный подход обеспечивает безопасное хранение документов и доступ к ним через вызовы API, сводя к минимуму риски, связанные с загрузкой пользователями.

С точки зрения бизнеса, использование составных шаблонов может оптимизировать рабочие процессы за счет сокращения ручного вмешательства. Например, компания, предоставляющая финансовые услуги, может использовать их для объединения заявок на кредит с формами раскрытия информации, предварительно заполняя данные получателя из системы CRM. Гибкость API поддерживает масштабируемость, но требует тщательного планирования в отношении аутентификации, создания конвертов и обработки ошибок, чтобы избежать ловушек соответствия требованиям.

Пошаговое руководство: создание составного шаблона с использованием серверных документов

Чтобы создать составной шаблон с использованием API DocuSign и документов, размещенных на вашем сервере, разработчики обычно взаимодействуют с eSignature REST API (версия 2.1 или выше). Этот процесс включает аутентификацию через OAuth 2.0, определение шаблона и сборку конверта. Ниже мы приводим основные этапы со ссылками на официальную документацию DocuSign и передовой опыт корпоративного внедрения.

Шаг 1: Настройка аутентификации и доступа к API

Начните с получения учетных данных API через центр разработчиков DocuSign. Используйте JWT Grant или Authorization Code Grant для безопасного получения токена. Для серверных операций JWT является предпочтительным, поскольку он обеспечивает автоматизированную, неинтерактивную аутентификацию. Установите SDK DocuSign (доступен для Node.js, Python, Java и т. д.) для упрощения HTTP-запросов.

Пример Node.js с использованием SDK DocuSign:

const dsApi = require('docusign-esign');
const apiClient = new dsApi.ApiClient();
apiClient.setBasePath('https://demo.docusign.net/restapi'); // Используйте производственный URL для производственной среды
const accessToken = await getJwtToken(); // Ваша функция JWT
apiClient.addDefaultHeader('Authorization', `Bearer ${accessToken}`);
const envelopesApi = new dsApi.EnvelopesApi(apiClient);

Эта базовая настройка гарантирует, что все последующие вызовы будут аутентифицированы, что является важным шагом для поддержания целостности данных в бизнес-среде.

Шаг 2: Загрузка и ссылка на серверные документы

Серверные документы загружаются во временное хранилище DocuSign или на них ссылаются напрямую через URL/байтовый поток. Для составных шаблонов используйте массив compositeTemplates в определении конверта. Начните с загрузки документа с помощью метода uploadDocument или предоставьте его в виде байтов, закодированных в base64.

Ключевые соображения: документы должны быть в поддерживаемом формате (PDF, DOCX). Чтобы обеспечить безопасность, избегайте раскрытия конфиденциальных файлов; используйте API загрузки документов DocuSign для обработки передачи.

Пример тела запроса для загрузки документа:

{
  "fileName": "Agreement.pdf",
  "documentBase64": "JVBERi0xLjQK..." // Base64-кодировка серверного файла
}

После загрузки назначьте ему documentId (например, «1») для ссылки в составном шаблоне.

Шаг 3: Определение структуры составного шаблона

Составной шаблон объединяет встроенные документы (серверные) с существующими шаблонами. Постройте его структуру в свойстве compositeTemplates в EnvelopeDefinition.

Основные элементы:

• ServerTemplate: ссылается на существующий шаблон DocuSign по ID для многократно используемых компонентов, таких как теги подписи.
• InlineTemplate: встраивает серверные документы и динамически определяет получателей/теги.
• Sequence: упорядочивает составные шаблоны (например, серверный документ 1, затем шаблон 2).

Пример JSON определения конверта:

{
  "status": "sent",
  "compositeTemplates": [
    {
      "compositeTemplateId": "1",
      "serverTemplates": [
        {
          "sequence": "1",
          "templateId": "your-template-guid",
          "sharedTemplateInstanceRoleName": "Sender"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "2",
          "recipients": {
            "signers": [
              {
                "email": "recipient@example.com",
                "name": "John Doe",
                "recipientId": "1",
                "tabs": {
                  "signHereTabs": [
                    {
                      "xPosition": "100",
                      "yPosition": "200",
                      "documentId": "1",
                      "pageNumber": "1"
                    }
                  ]
                }
              }
            ]
          },
          "documents": [
            {
              "documentId": "1",
              "name": "ServerDoc.pdf",
              "documentBase64": "JVBERi0xLjQK...", // Ваш серверный документ
              "fileExtension": "pdf"
            }
          ]
        }
      ]
    }
  ]
}

Это объединяет серверный документ с шаблоном, размещая поля подписи через размещение тегов. Бизнес-наблюдатели отмечают, что точное размещение тегов (с использованием строк привязки или координат) имеет решающее значение для профессионального вывода, предотвращая смещение в многостраничных документах.

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

Вызовите метод createEnvelope в EnvelopesApi:

const envelope = new dsApi.EnvelopeDefinition();
envelope.setCompositeTemplates([compositeTemplate]); // Из шага 3
const results = await envelopesApi.createEnvelope('accountId', { envelopeDefinition: envelope });
console.log('Envelope ID:', results.envelopeId);

Отслеживайте статус через веб-хуки или опрос. Для производственной среды интегрируйте обработку ошибок для устранения ограничений квоты (например, планы API начинаются с 600 долларов в год, поддерживая 40 конвертов в месяц).

Шаг 5: Передовой опыт и устранение неполадок

• Безопасность: используйте шифрование конвертов и контроль доступа на основе ролей. Серверная обработка соответствует таким стандартам, как Закон США об электронных подписях ESIGN Act, обеспечивая юридическую силу.
• Масштабируемость: для использования с большими объемами выберите расширенные планы API (5760 долларов в год), поддерживающие массовую отправку.
• Общие проблемы: недействительная кодировка base64 (проверьте серверный файл); несоответствие ID шаблона (проверьте через GET /templates).
• Тестирование: используйте песочницу DocuSign для итераций без возникновения затрат.

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

Изучение более широкого набора продуктов DocuSign

DocuSign выходит за рамки основных электронных подписей, предлагая интегрированные решения, такие как интеллектуальное управление соглашениями (IAM) и управление жизненным циклом контрактов (CLM). IAM использует AI для анализа контрактов, оценки рисков и автоматизации, помогая предприятиям извлекать информацию из соглашений. CLM, как часть корпоративного уровня, обеспечивает сквозное управление контрактами от составления до продления с такими функциями, как библиотеки положений и отслеживание переговоров. Эти инструменты обычно адаптированы для крупных организаций, повышая соответствие требованиям и эффективность, но по высокой цене, без общедоступного ценообразования — обычно на основе переговоров о емкости.

Цены на электронные подписи начинаются с личных планов (10 долларов в месяц, 5 конвертов) и расширяются до Business Pro (40 долларов в месяц на пользователя), включая массовую отправку. Доступ к API требует отдельного плана разработчика, подчеркивая модель DocuSign на основе мест, что может увеличить затраты для растущих команд.

Конкурентная среда: нейтральное сравнение

На рынке электронных подписей есть сильные игроки, каждый со своими уникальными преимуществами. DocuSign лидирует по глобальному внедрению и глубине API, Adobe Sign превосходит в интеграции PDF, eSignGlobal фокусируется на соответствии требованиям в Азиатско-Тихоокеанском регионе (АТР), а HelloSign (теперь Dropbox Sign) отдает приоритет простоте для малого и среднего бизнеса. Ниже приведена таблица сравнения Markdown на основе ключевых бизнес-факторов:

Эта таблица подчеркивает компромиссы: глубина DocuSign подходит для сложных рабочих процессов, в то время как альтернативы предлагают преимущества в стоимости или регионе.

Adobe Sign интегрируется с Adobe Document Cloud, предлагая бесшовный опыт для пользователей, интенсивно работающих с PDF. Он поддерживает условные поля и мобильные подписи, цены аналогичны DocuSign, но выигрывают от аналитических инструментов Adobe. Тем не менее, его API, хотя и мощный, часто критикуют за более крутую кривую обучения в пользовательских интеграциях, чем SDK DocuSign.

eSignGlobal позиционирует себя как альтернатива, соответствующая требованиям, охватывающая 100 основных стран, с особым акцентом на Азиатско-Тихоокеанский регион (АТР). Ландшафт электронных подписей в АТР характеризуется фрагментацией, высокими стандартами и строгими правилами, в отличие от более основанного на рамках подхода в США (Закон ESIGN) и ЕС (eIDAS), который подчеркивает широкое юридическое признание. В АТР стандарты склоняются к модели «интеграции экосистемы», требующей глубокой интеграции на уровне оборудования/API с цифровыми идентификаторами правительства для бизнеса (G2B) — что выходит далеко за рамки проверки электронной почты или самодекларации, обычно встречающихся на западных рынках. eSignGlobal решает эту проблему, бесшовно интегрируясь с такими системами, как iAM Smart в Гонконге и Singpass в Сингапуре, обеспечивая юридическую силу в различных юрисдикциях. Его цены умеренно ниже, чем у конкурентов; базовый план стоит около 16,6 долларов в год (с ежегодной оплатой), что позволяет использовать до 100 подписанных документов, неограниченное количество мест для пользователей и проверку с помощью кодов доступа — при этом сохраняя соответствие требованиям. Это делает его очень экономичным для команд, которые отдают приоритет региональной гибкости.

Ищете более умную альтернативу DocuSign?

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

👉 Начните бесплатную пробную версию

HelloSign (переименованный в Dropbox Sign) привлекает небольшие предприятия своим интуитивно понятным интерфейсом и бесплатным базовым планом. Он поддерживает шаблоны и напоминания, но ему не хватает расширенных функций API DocuSign, что делает его менее подходящим для интенсивной автоматизации.

Региональные нюансы внедрения электронных подписей

В то время как Закон США об электронных подписях ESIGN Act и eIDAS ЕС обеспечивают базовую законность электронных подписей, экосистема АТР требует локализованной интеграции. Предприятия, работающие через границы, должны оценивать местоположение данных и задержку инструментов, поскольку задержки доставки документов могут повлиять на закрытие сделок.

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