Песочница для подписи Пеннео (предварительная версия)

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

Этот соединитель доступен в следующих продуктах и регионах:

Service Class Regions
Copilot Studio Premium Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Standard Все регионы Logic Apps , кроме следующих:
     - Azure для государственных организаций регионы
     - Azure регионы Китая
     - Министерство обороны США (DoD)
Power Apps Premium Все регионы Power Apps кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Premium Все регионы Power Automate за исключением следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Contact
Name Поддержка Penneo
URL https://www.support.penneo.com
Метаданные соединителя
Publisher Интеграция Пеннео
Источник Сваггер
Веб-сайт https://penneo.com
Политика конфиденциальности https://penneo.com/privacy-policy
Categories Продуктивность

Песочница для подписи Пеннео

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

Prerequisites

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

Поддерживаемые действия

Создание файла регистра

Создает новый файл регистра в Пенно с указанными документами и подписывателями. Файл дела будет создан в Penneo, а UUID и полезные данныеHash будут возвращены, которые можно использовать для проверки состояния создания через конечную точку состояния очереди.

Проверка состояния задания

Извлекает текущее состояние файла casefile, предоставив задание UUID и полезные данныеHash. Эта конечная точка используется для опроса состояния завершения задания после отправки запроса на создание файла дела. Конечная точка ограничена скоростью до 20 запросов в минуту на комбинацию uuid-payloadHash.

Получение сведений о файле дела

Извлекает сведения о конкретном файле дела из Penneo на основе идентификатора файла дела. К ним относятся подписи, документы и текущее состояние.

Скачивание документа

Загружает содержимое документа из Пенно в виде строки в кодировке Base64. По умолчанию возвращается подписанная версия документа; signed Используйте параметр для получения неподписанных версий. Если ваш файл дела содержит больше документов, убедитесь, что цикл по каждому документу.

Получение учетных данных

Соединитель настроен для использования OAuth с предоставлением кода авторизации. При использовании соединителя пользователям придется войти с помощью обычных учетных данных.

Getting Started

Создание файла дела

  1. Подготовка документов:

    • Преобразование PDF-документов в кодировку Base64
    • Убедитесь, что документы являются допустимыми PDF-файлами
  2. Настройка подписей:

    • Укажите имя и электронную почту подписывщика (обязательно)
    • При необходимости предоставьте роль, язык, заказ подписывания и т. д.
    • Настройка уведомлений электронной почты и пользовательских шаблонов электронной почты при необходимости
  3. Создайте файл дела:

    • Используйте действие "Создать новый файл дела"
    • Заполните сведения о файле дела:
      • Title
      • Документы (PDF-файлы в кодировке Base64)
      • Подписыватели (с именами и необязательными сведениями)
      • Необязательные параметры (срок действия, язык, видимость и т. д.)
  4. Проверьте состояние создания CaseFile:

    • После создания файла дела вы получите идентификатор UUID и полезные данныеHash
    • Используйте действие "Проверить состояние задания" для опроса завершения задания
    • Соблюдайте ограничение скорости в 20 запросов в минуту на комбинацию хэша uuid-hash

Примечание. Вы можете проверить, что делает каждое поле, проверив https://penneo.readme.io/reference/createcasefile.

Получение файла дела и его документов

  1. Получение сведений о файле дела:

    • Использование действия "Получение сведений о файле дела" с идентификатором файла дела
    • Ответ включает состояние файла регистра, подписывателей и список документов (с идентификаторами документа).
  2. Скачайте документ:

    • Используйте действие "Скачать документ" с идентификатором документа, полученным из сведений о файле дела.
    • Ответ содержит содержимое документа в виде строки в кодировке Base64, которую можно декодировать для извлечения PDF-файла.

Известные проблемы и ограничения

  1. Ограничение скорости. Конечная точка состояния задания check ограничена скоростью до 20 запросов в минуту в сочетании uuid-hash. Реализуйте соответствующую логику повторных попыток с экспоненциальным обратным выходом.

  2. Асинхронная обработка: создание файла регистра является асинхронным. Для проверки завершения необходимо использовать конечную точку состояния задания, а не ожидать немедленных результатов.

  3. Кодировка Base64: документы должны быть закодированы в кодировке Base64. Убедитесь, что правильная кодировка позволяет избежать сбоев запросов(можно использовать строку base64 в Power Platform для кодирования двоичных PDF-файлов).

  4. Среда песочницы: этот соединитель настроен для среды песочницы Penneo (sandbox.penneo.com).

  5. Размер документа: обработка больших документов может занять больше времени. Учитывайте ограничения размера документа при кодировке в base64.

Инструкции по развертыванию

Выполните следующие команды и следуйте инструкциям.

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Получение сведений о файле дела

Извлекает сведения о конкретном файле дела из Penneo, включая его подписи, документы и текущее состояние. Состояние файла дела: 0=new, 1=ожидание, 2=отклонено, 3=deleted, 4=signed, 5=completed, 6=failed, 7=expired, 8=анонимизировано. Используйте состояние 5 (завершено) в качестве триггера для скачивания подписанных документов.

Проверка состояния задания

Извлекает текущее состояние асинхронного задания, предоставив задание UUID и полезные данныеHash. Эта конечная точка используется для опроса состояния завершения задания после отправки запроса на создание файла дела. Действие ограничено скоростью до 20 запросов в минуту на комбинацию uuid-payloadHash.

Скачивание документа

Загружает содержимое документа из Пенно в виде строки в кодировке Base64. По умолчанию возвращается подписанная версия документа.

Создание файла регистра

Создает новый файл регистра в Пенно с указанными документами и подписывателями. Файл дела будет создан асинхронно, а идентификатор задания UUID и полезные данныеHash будут возвращены, которые можно использовать для проверки состояния создания с помощью действия "Проверить состояние задания". Вы можете настроить подписи, документы, порядок подписывания, уведомления электронной почты, управление доступом и другие параметры файла дела.

Получение сведений о файле дела

Извлекает сведения о конкретном файле дела из Penneo, включая его подписи, документы и текущее состояние. Состояние файла дела: 0=new, 1=ожидание, 2=отклонено, 3=deleted, 4=signed, 5=completed, 6=failed, 7=expired, 8=анонимизировано. Используйте состояние 5 (завершено) в качестве триггера для скачивания подписанных документов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор файла дела
caseFileId True integer

Идентификатор извлекаемого файла дела. Получите идентификатор файла дела с действием "Проверить состояние задания".

Возвращаемое значение

Сведения о файле дела, полученном из защищенного архива Penneo.

Тело
CaseFileDetails

Проверка состояния задания

Извлекает текущее состояние асинхронного задания, предоставив задание UUID и полезные данныеHash. Эта конечная точка используется для опроса состояния завершения задания после отправки запроса на создание файла дела. Действие ограничено скоростью до 20 запросов в минуту на комбинацию uuid-payloadHash.

Параметры

Имя Ключ Обязательно Тип Описание
uuid
uuid True uuid

Идентификатор UUID задания для проверки. Возвращается при создании задания.

полезные данныеHash
payloadHash True string

Хэш SHA-256 полезных данных. Возвращается при создании задания и используется для проверки подлинности запроса.

Возвращаемое значение

Тело
QueueJob

Скачивание документа

Загружает содержимое документа из Пенно в виде строки в кодировке Base64. По умолчанию возвращается подписанная версия документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True integer

Идентификатор скачиваемого документа. Получите documentIds с помощью действия "Получить сведения о файле дела".

Подписан
signed boolean

Получите подписанный или неподписанный документ. По умолчанию подписанный документ возвращается, если документ подписан.

Возвращаемое значение

Тело
DocumentContent

Создание файла регистра

Создает новый файл регистра в Пенно с указанными документами и подписывателями. Файл дела будет создан асинхронно, а идентификатор задания UUID и полезные данныеHash будут возвращены, которые можно использовать для проверки состояния создания с помощью действия "Проверить состояние задания". Вы можете настроить подписи, документы, порядок подписывания, уведомления электронной почты, управление доступом и другие параметры файла дела.

Параметры

Имя Ключ Обязательно Тип Описание
заголовок
title True string

Заголовок файла дела.

sendAt
sendAt integer

Метка времени при отправке файла дела. Null = немедленно

name
name True string

Имя подписывателя

role
role string

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

email
email email

Сообщение электронной почты для подписывания. Пеннео будет обрабатывать все коммуникации

failUrl
failUrl uri

URL-адрес перенаправления после сбоя

language
language string

Язык подписи

emailText
emailText string

Пользовательский текст для сообщения электронной почты запроса подписи. По умолчанию используется шаблон компании, если он не указан.

signOrder
signOrder integer

Порядок подписывания. 0 означает отсутствие принудительного порядка.

successUrl
successUrl uri

URL-адрес перенаправления после успешного выполнения

emailSubject
emailSubject string

Тема сообщения электронной почты запроса подписи. По умолчанию используется шаблон компании, если он не указан.

напоминаниеInterval
reminderInterval integer

За несколько дней до отправки напоминания

напоминаниеEmailText
reminderEmailText string

Пользовательский текст для сообщения электронной почты напоминания. По умолчанию используется шаблон компании, если он не указан.

completedEmailText
completedEmailText string

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

напоминаниеEmailSubject
reminderEmailSubject string

Тема сообщения электронной почты напоминания. По умолчанию используется шаблон компании, если он не указан.

completedEmailSubject
completedEmailSubject string

Тема завершенного сообщения электронной почты. По умолчанию используется шаблон компании, если он не указан.

enableInsecureSigning
enableInsecureSigning boolean

Если значение true, подписыватель может использовать сенсорные сигнатуры (рисование, текст, отправка изображения)

insecureSigningMethods
insecureSigningMethods array of string

Разрешены небезопасные методы подписывания. Значение по умолчанию для параметра компании, если пусто.

secureSigningMethods
secureSigningMethods array of string

Разрешенные безопасные методы электронной подписи. Переопределяет файл дела и параметры клиента при установке.

vatin
vatin string

Идентификационный номер НДС компании подписывающего объекта

ssnType
ssnType string

Тип SSN/mobile. Пример "dk:cpr", "se:pin", "no:nin", "be:nrn", "fi:pic" или "sms". По умолчанию используется значение "устаревшее"

activeAt
activeAt integer

Метка времени активации

expireAt
expireAt integer

Метка времени окончания срока действия

accessControl
accessControl boolean

Если этот параметр включен, перед доступом проверяется SSN/VATIN/phone

emailFormat
emailFormat string

Определяет формат электронной почты

onBehalfOf
onBehalfOf string

Компания или организация, которую подписыватель подписывает от имени

storeAsContact
storeAsContact boolean

Если задано значение true, вход будет храниться как контакт в Пеннео

socialSecurityNumberPlain
socialSecurityNumberPlain string

SSN или номер телефона подписывающего пользователя (рекомендуемый формат E.164)

expireAt
expireAt integer

Метка времени, когда срок действия файла дела истекает. Если это не указано, применяются значения по умолчанию

language
language string

Язык файла регистра будет применяться для каждого подписывателя, который не имеет языкового набора

PDF
pdf True string

PDF-файл в кодировке Base64

подписываемый
signable boolean

True создает подписываемый документ. False, документ добавляется в виде вложения и не является подписываемым.

roles
roles array of string

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

заголовок
title True string

Название документа

documentOrder
documentOrder integer

Порядок подписывания документа. По умолчанию предоставляется порядок.

метаданные
metaData string

Метаданные документа, доступные для поиска в Пенно

sensitiveData
sensitiveData boolean

Если задано значение true, перед доступом к документам подписывание должно проверить свое удостоверение. Отключает вложения электронной почты для подписанных документов.

signOnMeeting
signOnMeeting boolean

Указывает, должны ли документы быть подписаны во время собрания.

видимостьMode
visibilityMode integer

0 = подписи отображают все документы. 1 = подписи видят только документы, которые они должны подписать.

disableEmailAttachments
disableEmailAttachments boolean

Отключает вложения электронной почты для подписанных документов в сообщениях о завершении. Переопределяется, если конфиденциальность данных имеет значение true.

disableNotificationsOwner
disableNotificationsOwner boolean

Если владелец файла true case не получит уведомления о файле дела.

folderId
folderId integer

Идентификатор папки, в которой вы хотите разместить файл casefile

метаданные
metaData string

Метаданные файла дела, доступные для поиска в Пеннео

ссылка
reference string

Ссылка на файл дела будет показана в веб-приложении Penneo

name
name True string

Имя получателя

email
email True email

Электронная почта получателя

Возвращаемое значение

Тело
JobResponse

Определения

JobResponse

Имя Путь Тип Описание
jobs
jobs array of Job

Массив созданных заданий (обычно содержит одно задание)

состояние
status string

Состояние запроса на создание задания

message
message string

Читаемое человеком сообщение о создании рабочих мест

Job

Имя Путь Тип Описание
uuid
uuid uuid

Уникальный идентификатор задания, который можно использовать для проверки состояния

uuid
payload.uuid uuid

UUID созданного файла дела

bundleUuid
payload.bundleUuid uuid

UUID пакета, содержащего файл дела

etlVersionUuid
payload.etlVersionUuid uuid

UUID версии ETL, используемой для обработки

organizationUuid
payload.organizationUuid uuid

UUID организации, которая владеет этим файлом дела

customData
payload.customData object

Дополнительные метаданные и контекст для задания

createdAt
createdAt date-time

Метка времени ISO 8601 при создании задания

полезные данныеHash
payloadHash string

Хэш SHA-256 полезных данных, используемый для проверки состояния задания

QueueJob

Имя Путь Тип Описание
type
type string

Тип задания очереди (например, "casefile_creation")

uuid
uuid uuid

Уникальный идентификатор задания

result
result object

Результат выполнения задания очереди, возвращенный в формате JSON при завершении задания. Содержит результат и все соответствующие данные.

jobStatus
jobStatus string

Текущее состояние задания. Возможные значения "ожидающие" (ожидание обработки), "обработка" (в настоящее время выполняется), "завершено" (успешно завершено), "сбой" (сбой выполнения), "aborted_duplicated" (прервано из-за дублирования)

payload
payload object

Исходные полезные данные, отправленные заданием, хранящиеся в формате JSON. Содержит данные файла регистра и метаданные.

Повторных попыток
retries integer

Количество повторных попыток задания после сбоя

createdAt
createdAt date-time

Дата и время создания задания очереди

updatedAt
updatedAt date-time

Дата и время последнего обновления задания очереди

maxRetries
maxRetries integer

Максимальное число повторных попыток, разрешенных для этого задания, прежде чем оно помечается как неудачное

полезные данныеHash
payloadHash string

Хэш SHA-256 полезных данных, используемый для проверки и безопасности

errorMessage
errorMessage string

Сообщение об ошибке, описывающее, почему задание завершилось ошибкой, если применимо. Присутствует только при сбое задания.

CcRecipient

Имя Путь Тип Описание
name
name string

Имя получателя

email
email email

Электронная почта получателя

CaseFileDetails

Сведения о файле дела, полученном из защищенного архива Penneo.

Имя Путь Тип Описание
userId
userId integer

Идентификатор пользователя, которому принадлежит файл дела.

customerId
customerId integer

Идентификатор клиента, к которому принадлежит файл дела.

подписыватели
signers array of SignerDetails

Список подписок в файле дела.

id
id integer

Идентификатор файла дела.

заголовок
title string

Заголовок файла дела.

состояние
status integer

Состояние файла дела.

Документы
documents array of DocumentDetails

Список документов в файле дела.

expireAt
expireAt integer

Метка времени UNIX, когда срок действия файла дела истекает.

ccRecipients
ccRecipients array of CcRecipient

Список получателей CC, получающих копию подписанных документов.

создано
created integer

Метка времени UNIX при создании файла дела.

активировано
activated integer

Метка времени UNIX при активации файла дела.

Обновлено
updated integer

Метка времени UNIX при последнем обновлении файла дела.

завершено
completed integer

Метка времени UNIX при завершении файла дела.

SignerDetails

Подписыватель файла дела.

Имя Путь Тип Описание
name
name string

Имя подписывателя.

id
id integer

Идентификатор подписывателя.

подписьRequest
signingRequest SigningRequestDetails

Запрос подписи, связанный с подписывчиком.

ПодписываниеRequestDetails

Запрос подписи, связанный с подписывчиком.

Имя Путь Тип Описание
id
id integer

Идентификатор запроса подписи.

email
email string

Сообщение электронной почты для подписывания.

состояние
status integer

Состояние запроса подписи.

DocumentDetails

Документ в файле дела.

Имя Путь Тип Описание
id
id integer

Идентификатор документа. Используйте это для скачивания документа с действием "Скачать документ".

состояние
status integer

Состояние документа.

подписываемый
signable boolean

Значение True, если документ является подписываемым.

DocumentContent

Имя Путь Тип Описание
Содержимое документа
content byte

Содержимое документа в кодировке Base64.