Penneo Sign Sandbox (versión preliminar)
Penneo transforma procesos complejos en una experiencia sin problemas centrada en el ser humano. Al integrar firmas digitales en flujos de trabajo automatizados, nuestra plataforma hace que sea fácil validar quién aprobó qué datos y cuándo, lo que reduce las cargas administrativas al tiempo que garantiza el cumplimiento y la seguridad completos. Este conector le permite enviar documentos para la firma.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - regiones de Azure Government - Azure regiones de China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contact | |
|---|---|
| Name | Compatibilidad con Penneo |
| URL | https://www.support.penneo.com |
| Metadatos del conector | |
|---|---|
| Publicador | Integración de Penneo |
| source | Swagger |
| Sitio web | https://penneo.com |
| Directiva de privacidad | https://penneo.com/privacy-policy |
| Categories | Productividad |
Penneo Sign Sandbox
Penneo transforma procesos complejos en una experiencia sin problemas centrada en el ser humano. Al integrar firmas digitales en flujos de trabajo automatizados, nuestra plataforma hace que sea fácil validar quién aprobó qué datos y cuándo, lo que reduce las cargas administrativas al tiempo que garantiza el cumplimiento y la seguridad completos.
Prerequisites
Para usar este conector, necesitará una cuenta de Penneo Sandbox activa.
Acciones soportadas
Creación de un nuevo archivo de casos
Crea un nuevo archivo de mayúsculas y minúsculas en Penneo con los documentos y firmantes especificados. El archivo case se creará en Penneo y se devolverá un UUID y una cargaHash que se puede usar para comprobar el estado de creación a través del punto de conexión de estado de la cola.
Comprobar el estado del trabajo
Recupera el estado actual de un archivo case proporcionando el UUID del trabajo y payloadHash. Este punto de conexión se usa para sondear el estado de finalización del trabajo después de enviar una solicitud de creación de archivos de caso. El punto de conexión está limitado a 20 solicitudes por minuto por combinación uuid-payloadHash.
Obtención de credenciales
El conector se ha configurado para usar OAuth con concesión de código de autorización. Los usuarios tendrán que iniciar sesión con sus credenciales normales cuando usen el conector.
Getting Started
Creación de un archivo de casos
Preparar los documentos:
- Convertir los documentos PDF en codificación base64
- Asegurarse de que los documentos son archivos PDF válidos
Configurar firmantes:
- Proporcione el nombre del firmante y el correo electrónico (obligatorio)
- Opcionalmente, proporcione el rol, el idioma, el orden de firma, etc.
- Configuración de notificaciones por correo electrónico y plantillas de correo electrónico personalizadas si es necesario
Cree el archivo de casos:
- Use la acción "Crear un nuevo archivo de casos"
- Rellene los detalles del archivo de casos:
- Title
- Documentos (ARCHIVOS PDF codificados en base64)
- Firmantes (con nombres y detalles opcionales)
- Configuración opcional (expiración, idioma, visibilidad, etc.)
Compruebe el estado de creación de CaseFile:
- Después de crear un archivo de caso, recibirá un UUID y payloadHash.
- Use la acción "Comprobar el estado del trabajo" para sondear la finalización del trabajo
- Respetar el límite de velocidad de 20 solicitudes por minuto por combinación uuid-hash
Nota: Puede comprobar lo que hace cada campo comprobando https://penneo.readme.io/reference/createcasefile.
Problemas conocidos y limitaciones
Limitación de velocidad: el punto de conexión comprobar el estado del trabajo está limitado a 20 solicitudes por minuto por combinación uuid-hash. Implemente la lógica de reintento adecuada con retroceso exponencial.
Procesamiento asincrónico: la creación de archivos de casos es asincrónica. Debe usar el punto de conexión de estado del trabajo para comprobar la finalización en lugar de esperar resultados inmediatos.
Codificación base64: los documentos deben estar codificados en base64. Asegúrese de que la codificación adecuada para evitar errores de solicitud (puede usar la función de cadena base64 en Power Platform para codificar los archivos PDF binarios).
Entorno de espacio aislado: este conector está configurado para el entorno de espacio aislado de Penneo (
sandbox.penneo.com).Tamaño del documento: los documentos grandes pueden tardar más tiempo en procesarse. Considere los límites de tamaño del documento al codificar en base64.
Instrucciones de implementación
Ejecute los siguientes comandos y siga las indicaciones:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Comprobar el estado del trabajo |
Recupera el estado actual de un trabajo asincrónico proporcionando el UUID del trabajo y payloadHash. Este punto de conexión se usa para sondear el estado de finalización del trabajo después de enviar una solicitud de creación de archivos de caso. La acción está limitada a 20 solicitudes por minuto por combinación uuid-payloadHash. |
| Creación de un nuevo archivo de casos |
Crea un nuevo archivo de mayúsculas y minúsculas en Penneo con los documentos y firmantes especificados. El archivo case se creará de forma asincrónica y se devolverá un UUID de trabajo y una cargaHash que se puede usar para comprobar el estado de creación a través de la acción Comprobar estado del trabajo. Puede configurar firmantes, documentos, orden de firma, notificaciones por correo electrónico, control de acceso y otras configuraciones de archivos de casos. |
Comprobar el estado del trabajo
Recupera el estado actual de un trabajo asincrónico proporcionando el UUID del trabajo y payloadHash. Este punto de conexión se usa para sondear el estado de finalización del trabajo después de enviar una solicitud de creación de archivos de caso. La acción está limitada a 20 solicitudes por minuto por combinación uuid-payloadHash.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
uuid
|
uuid | True | uuid |
UUID del trabajo que se va a comprobar. Esto se devuelve cuando se crea el trabajo. |
|
payloadHash
|
payloadHash | True | string |
Hash SHA-256 de la carga útil. Esto se devuelve cuando se crea el trabajo y se usa para comprobar la autenticidad de la solicitud. |
Devoluciones
- Body
- QueueJob
Creación de un nuevo archivo de casos
Crea un nuevo archivo de mayúsculas y minúsculas en Penneo con los documentos y firmantes especificados. El archivo case se creará de forma asincrónica y se devolverá un UUID de trabajo y una cargaHash que se puede usar para comprobar el estado de creación a través de la acción Comprobar estado del trabajo. Puede configurar firmantes, documentos, orden de firma, notificaciones por correo electrónico, control de acceso y otras configuraciones de archivos de casos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
title
|
title | True | string |
Título del archivo de mayúsculas y minúsculas. |
|
sendAt
|
sendAt | integer |
Marca de tiempo cuando se debe enviar el archivo case. Null = inmediatamente |
|
|
name
|
name | True | string |
Nombre del firmante |
|
role
|
role | string |
Rol para el firmante. Permitido: letras, números, espacios, comas, subrayado, guion. Debe comenzar con una letra o número y no debe terminar con un espacio. |
|
|
email
|
Correo electrónico del firmante. Penneo controlará todas las comunicaciones |
|||
|
failUrl
|
failUrl | uri |
Dirección URL de redireccionamiento después de un error |
|
|
language
|
language | string |
Lenguaje de firmante |
|
|
emailText
|
emailText | string |
Texto personalizado para el correo electrónico de solicitud de firma. Si no se proporciona, el valor predeterminado es la plantilla de empresa. |
|
|
signOrder
|
signOrder | integer |
Orden de firma. 0 significa que no se aplica ninguna orden. |
|
|
successUrl
|
successUrl | uri |
Url de redireccionamiento después de que se ha realizado correctamente |
|
|
emailSubject
|
emailSubject | string |
Asunto del correo electrónico de solicitud de firma. Si no se proporciona, el valor predeterminado es la plantilla de empresa. |
|
|
reminderInterval
|
reminderInterval | integer |
Días antes de enviar el aviso |
|
|
reminderEmailText
|
reminderEmailText | string |
Texto personalizado para el correo electrónico del recordatorio. Si no se proporciona, el valor predeterminado es la plantilla de empresa. |
|
|
completedEmailText
|
completedEmailText | string |
Texto personalizado para el correo electrónico completado. Si no se proporciona, el valor predeterminado es la plantilla de empresa. |
|
|
reminderEmailSubject
|
reminderEmailSubject | string |
Asunto del correo electrónico del recordatorio. Si no se proporciona, el valor predeterminado es la plantilla de empresa. |
|
|
completedEmailSubject
|
completedEmailSubject | string |
Asunto del correo electrónico completado. Si no se proporciona, el valor predeterminado es la plantilla de empresa. |
|
|
enableInsecureSigning
|
enableInsecureSigning | boolean |
Si es true, el firmante puede usar firmas táctiles (dibujo, texto, carga de imágenes) |
|
|
insecureSigningMethods
|
insecureSigningMethods | array of string |
Métodos de firma no seguros permitidos. El valor predeterminado es la configuración de la empresa si está vacía. |
|
|
vatin
|
vatin | string |
Número de identificación del IVA de la compañía del firmante |
|
|
ssnType
|
ssnType | string |
Tipo de SSN/móvil. Ejemplo 'dk:cpr', 'se:pin', 'no:nin', 'be:nrn', 'fi:pic' o 'sms'. El valor predeterminado es "heredado". |
|
|
activeAt
|
activeAt | integer |
Marca de tiempo de activación |
|
|
expireAt
|
expireAt | integer |
Marca de tiempo de expiración |
|
|
control de acceso
|
accessControl | boolean |
Si está habilitado, SSN/VATIN/phone se valida antes del acceso. |
|
|
emailFormat
|
emailFormat | string |
Define el formato de correo electrónico |
|
|
onBehalfOf
|
onBehalfOf | string |
La empresa o organización de la que este firmante inicia sesión en nombre de |
|
|
storeAsContact
|
storeAsContact | boolean |
Si es true, el firmante se almacenará como contacto en Penneo. |
|
|
socialSecurityNumberPlain
|
socialSecurityNumberPlain | string |
Número de teléfono o SSN del firmante (se recomienda el formato E.164) |
|
|
expireAt
|
expireAt | integer |
Marca de tiempo cuando expire el archivo case. Si no se proporciona, se aplican los valores predeterminados |
|
|
language
|
language | string |
El idioma del archivo case, se aplicará para cada firmante que no tenga un conjunto de idioma. |
|
|
pdf
|
True | string |
PDF codificado en Base64 |
|
|
signable
|
signable | boolean |
True crea un documento que se puede firmar. False, el documento se agrega como datos adjuntos y no se puede firmar. |
|
|
roles
|
roles | array of string |
Los roles de firmante pueden firmar este documento. El valor predeterminado es todos los firmantes si están vacíos. |
|
|
title
|
title | True | string |
Título del documento |
|
documentOrder
|
documentOrder | integer |
Orden de firma del documento. El valor predeterminado es el orden proporcionado. |
|
|
metadatos
|
metaData | string |
Metadatos del documento, que se pueden buscar en Penneo |
|
|
sensitiveData
|
sensitiveData | boolean |
Si es true, los firmantes deben validar su identidad antes de acceder a los documentos. Deshabilita los datos adjuntos de correo electrónico para documentos firmados. |
|
|
signOnMeeting
|
signOnMeeting | boolean |
Especifica si los documentos se deben firmar durante una reunión. |
|
|
visibilityMode
|
visibilityMode | integer |
0 = Los firmantes ven todos los documentos. 1 = Los firmantes solo ven los documentos que necesitan firmar. |
|
|
disableEmailAttachments
|
disableEmailAttachments | boolean |
Deshabilita los datos adjuntos de correo electrónico para los documentos firmados en los correos electrónicos de finalización. Se invalida si sensitiveData es true. |
|
|
disableNotificationsOwner
|
disableNotificationsOwner | boolean |
Si el propietario del archivo de caso verdadero no recibirá notificaciones para el archivo de caso. |
|
|
folderId
|
folderId | integer |
Identificador de carpeta donde desea colocar el archivo case |
|
|
metadatos
|
metaData | string |
Metadatos del archivo de casos, que se pueden buscar en Penneo |
|
|
referencia
|
reference | string |
La referencia del archivo de casos, se mostrará en la aplicación web Penneo. |
|
|
name
|
name | True | string |
Nombre del destinatario |
|
email
|
True |
Correo electrónico del destinatario |
||
|
storeAsContact
|
storeAsContact | boolean |
El firmante se almacenará como contacto. El valor predeterminado es true. |
Devoluciones
- Body
- JobResponse
Definiciones
JobResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
jobs
|
jobs | array of Job |
Matriz de trabajos creados (normalmente contiene un trabajo) |
|
status
|
status | string |
Estado de la solicitud de creación de trabajos |
|
message
|
message | string |
Mensaje legible sobre la creación de trabajos |
Job
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
uuid
|
uuid | uuid |
Identificador único del trabajo que se puede usar para comprobar el estado |
|
uuid
|
payload.uuid | uuid |
UUID del archivo de caso creado |
|
bundleUuid
|
payload.bundleUuid | uuid |
UUID del lote que contiene el archivo case |
|
etlVersionUuid
|
payload.etlVersionUuid | uuid |
UUID de la versión ETL usada para el procesamiento |
|
organizationUuid
|
payload.organizationUuid | uuid |
UUID de la organización que posee este archivo de caso |
|
customData
|
payload.customData | object |
Metadatos y contexto adicionales para el trabajo |
|
createdAt
|
createdAt | date-time |
Marca de tiempo ISO 8601 cuando se creó el trabajo |
|
payloadHash
|
payloadHash | string |
Hash SHA-256 de la carga útil, usado para la comprobación al comprobar el estado del trabajo |
QueueJob
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
type
|
type | string |
Tipo del trabajo de cola (por ejemplo, "casefile_creation") |
|
uuid
|
uuid | uuid |
Identificador único del trabajo |
|
result
|
result | object |
Resultado de la ejecución del trabajo de cola, que se devuelve como JSON cuando se completa el trabajo. Contiene el resultado y los datos pertinentes. |
|
jobStatus
|
jobStatus | string |
Estado actual del trabajo. Valores posibles 'pendientes' (esperando a procesarse), 'processing' (actualmente ejecutados), 'completed' (completado correctamente), 'failed' (error de ejecución), 'aborted_duplicated' (anulado debido a la duplicación) |
|
payload
|
payload | object |
La carga original enviada con el trabajo, almacenada como JSON. Contiene los datos y metadatos del archivo de casos. |
|
Reintentos
|
retries | integer |
Número de veces que se ha reintentado el trabajo después de un error |
|
createdAt
|
createdAt | date-time |
Fecha y hora en que se creó el trabajo de cola |
|
actualizadoA
|
updatedAt | date-time |
Fecha y hora en que se actualizó por última vez el trabajo de cola |
|
maxRetries
|
maxRetries | integer |
Número máximo de reintentos permitidos para este trabajo antes de que se marque como erróneo. |
|
payloadHash
|
payloadHash | string |
Hash SHA-256 de la carga útil, usado con fines de comprobación y seguridad |
|
errorMessage
|
errorMessage | string |
Mensaje de error que describe por qué se produjo un error en el trabajo, si procede. Solo está presente cuando jobStatus es "failed". |