Ok dokument (Publicador independiente) (versión preliminar)
Ok dokument ofrece una plataforma de distribución de documentos digitales y firmas electrónicas personalizables y fáciles de usar que se integra perfectamente en los sistemas existentes.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de 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 - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de 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 de 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) |
| Contacto | |
|---|---|
| Nombre | Seyfor Slovensko a.s. |
| URL | https://www.seyfor.com |
| Correo Electrónico | tomas.szarka@seyfor.com |
| Metadatos del conector | |
|---|---|
| Publicador | Seyfor Slovensko, a.s. |
| Sitio web | https://okdokument.com/ |
| Directiva de privacidad | https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf |
| Categorías | Productividad |
Ok dokument : firma electrónica
Ok dokument ofrece una plataforma de distribución de contenido digital y firma electrónica personalizable y fácil de usar que se integra perfectamente con sus sistemas existentes.
Publicador
Seyfor Slovensko, a.s.
Prerrequisitos
Debe tener una cuenta en https://app.okdokument.com y una clave de API válida generada por el servicio Ok dokument .
Operaciones admitidas
1. Carga de documentos
Acción que se usa para cargar un archivo PDF en el servicio de firma de documentos. Esta acción realiza una cadena base64 y la carga en la plataforma de LA API de dokument ok .
El documento pasa varios estados durante su vigencia. Ok dokument API usa los siguientes estados de documento:
- tags: indica que busca etiquetas de texto e inserta campos de acrocampos de firma. Después de insertar correctamente los campos de acrocampos, cambia automáticamente el estado a tosign
- tostamp: estado que inserta la marca digital en el documento
- tosign : documento listo para firmar
- firmado: documento firmado (dentro de la firma especificadaRequestID)
- errorsendinfo: error al llamar al servicio de información
- canceled – canceled document – signer pressed the "Cancel" button in the document
Campos de acrocampos de firma
Acrofield es un tipo de campo activo admitido en PDF. Un acrofield de firma es un tipo especial de campo activo que permite insertar una firma en un documento en una ubicación fija. Los campos Acrofields se pueden insertar en archivos PDF con herramientas PDF especializadas como Adobe PRO o con herramientas de plantilla como JasperReport.
Etiquetas
Una etiqueta representa un valor de texto único que examina el servidor de API. Si lo encuentra, inserta el campo de firma en su lugar. La búsqueda de etiquetas se proporciona mediante el estado del documento "etiquetas", que debe establecerse cuando se llama al servicio JSON/document. La API de OKdokument admite las siguientes etiquetas para la firma opcional:
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
La API de OKdokument admite las siguientes etiquetas para la firma obligatoria: _SC1__SC2__SC3_ _SC4__SC5_
Si se usan etiquetas obligatorias, todos los campos de firma obligatorios visibles deben firmarse antes de enviar el documento.
En caso de que no sea posible preparar documentos con acrofields o etiquetas de firma al registrar signatureRequest, es posible habilitar la funcionalidad de "firmar en cualquier lugar", lo que permitirá al usuario firmar el documento en cualquier ubicación, sencillo donde el usuario hace clic o pulsa
Conversión de documento a PDF
OKdokument API admite la conversión de .doc, .docx, .xls, .xlsx en formato de archivo PDF. El archivo de origen también puede contener etiquetas, la API de OKdokument realizará primero la conversión de archivos y, a continuación, insertará automáticamente los campos de acrocampos de firma.
Para convertir el archivo en PDF, debe rellenar el nombre del documento. Este parámetro es obligatorio si desea realizar la conversión de archivos al formato PDF. Para la conversión, el postfijo de archivo debe ser:
- contract.doc
- contract.docx
- contract.xls
- contract.xlsx
Almacenamiento y eliminación de documentos
Ok dokument API no desempeña el rol de un archivo permanente del documento firmado. Se aplican las siguientes reglas:
- El documento firmado se elimina automáticamente 10 días después de la firma
- El documento sin firmar se elimina automáticamente después de 30 días después de la carga
2. Solicitud de firma
Esta acción se usa para generar el identificador de solicitud de firma. Dentro de esta acción, debe usar el identificador de documento. El id. de documento es un resultado de la acción de carga del documento.
En esta acción, puede transformar el proceso de firma en un proceso de firma de varias fases. Agregar el parámetro adicional "Campos de firma" le permite administrar lo que debe estar disponible en cada solicitud de firma. Puede usar campos de acrocampos con nombres internos.
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
OR
_SC1_
_SC2_
_SC3_
_SC4_
_SC5_
Esta acción se puede usar varias veces en el proceso. La acción de solicitud de firma se genera en el servicio Ok dokument como "Solicitud de firma" y este identificador es único para cada acción "Firmar".
Para enviar una solicitud de firma de documento, use la dirección URL del atributo de respuesta y úsela en el correo electrónico, la notificación push o MS Teams para pedir a alguien que firme un documento específico.
Una vez firmado el documento, puede usar "Solicitud de firma" para cambiar el estado del documento a "tosign" y crear un nuevo signatureRequestId y preparar el documento para la siguiente firma. Que el proceso repite los pasos 3 a 5.
Ejemplo de solicitud de firma con un campo de acrocampo obligatorio
_SC1_
Ejemplo de solicitud de firma con un campo de acrocampo obligatorio y en acrofield opcional en una solicitud de firma_SC1_;_SO2_
Reglas adicionales en la solicitud de firma
Se pueden usar reglas adicionales para:
- Deshabilitar o habilitar la característica Sign Anywhere
- Valor predefinido para el nombre del firmante
- habilitación de la entrada para el nombre del firmante
- habilitación del envío de la solicitud de firma desde OK Dokument
- habilitar el aviso de correo electrónico
- Configuración de OTP (contraseña única) a través de correo electrónico o SMS
- firmar documento con OTP
- deshabilitar la firma con el mouse
| Nombre de la regla | Parámetro | Description |
|---|---|---|
| signAnywhereEnabled | true/false | parámetro para deshabilitar la función sign anywhere |
| guiRequestSignerName | true/false | parámetro para habilitar la entrada para el nombre del firmante |
| guiSignerName | Nombre del firmante | valor predefinido para el nombre del firmante, máximo de 40 caracteres. Si guiRequestSignerName está habilitado, el firmante puede cambiar el nombre del firmante. |
| signAnywhereEnabled | true/false | parámetro para deshabilitar la función sign anywhere |
| emailTo | Correo electrónico del firmante | Los firmantes enviarán un correo electrónico a la dirección URL de solicitud de firma. |
| que se entregue. | ||
| emailFrom | Correo electrónico del remitente | Correo electrónico de remitentes. Obligatorio si se usa la regla emailTo |
| nameFrom | Nombre del remitente | El nombre de los remitentes, que se usará en las plantillas de correo electrónico |
| emailNotification | Regla que habilita el aviso de correo electrónico. El aviso de correo electrónico envía un correo electrónico cada mañana a las 7:00 para las solicitudes de firma que no están firmadas. El correo electrónico se envía a emailTo y emailFrom, según la configuración de signatureRequest. | |
| emailFinal | Correo electrónico del firmante | Correo electrónico para entregar el documento firmado. Si emailFinal no tiene parámetro, el documento firmado se enviará a emailTo. |
| openOtpPhone | Teléfono del firmante | Número de teléfono de los firmantes al que se entregará la contraseña de un solo uso para acceder al documento. Para usar SMS OTP, debe comprar el paquete de solicitud de firma con SMS. |
| openOtpEmail | Correo electrónico del firmante | Los firmantes envían un correo electrónico al que se entregará la contraseña de un solo uso para acceder al documento. |
| signOtpPhone | Teléfono del firmante | Número de teléfono de los firmantes al que se entregará la contraseña de un solo uso para firmar el documento. La firma OTP requiere acrofield de firma. |
| signOtpEmail | Correo electrónico del firmante | Los firmantes envían un correo electrónico al que se entregará la contraseña única para firmar el documento. La firma OTP requiere acrofield de firma. |
| lang | sk, cs, en, ro, uk, pl, pt, hu | Idioma de la plantilla de correo electrónico y SMS, si la regla no está establecida, se usa Eslovaco como idioma predeterminado. |
| mouseSignature | false | Regla para deshabilitar la firma con el mouse. |
Sintaxis para escribir reglas de solicitud de firma
RuleName-Value
Sintaxis para escribir varias reglas de solicitud de firma
RuleName1-Value_RuleName2-Value_RuleName3-Value
Ejemplo de solicitud de firma con la opción Sign Anywhere habilitada
signAnywhereEnabled-true
Ejemplo de solicitud de firma con la opción Sign Anywhere deshabilitada y el nombre del firmante habilitado con el valor rellenado previamente
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false
Ejemplo de solicitud de firma con deshabilitado Sign Anywhere, enabled Signer name with prefilled value, defined OTP email to open signature request, email where signature request is sent, email template language, signature request sender email email
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false_openOtpEmail-john.doe@somefakeemail.com_emailTo-john.doe@somefakeemail.com_lang-sk_emailFrom-sender@someofficetenant.onmicrosoft.com_mouseSignature-false
Hora de expiración
El valor predeterminado para la expiración de la solicitud de firma es de 24 horas. Puede ampliar este intervalo de tiempo hasta 10 días mediante este parámetro expirationTime. Hora de expiración del identificador de solicitud de firma. Hora en milisegundos desde el 1 de enero de 1970 00:00:00 UTC
Correo Electrónico
OKdokument API le permite compartir la dirección URL de signatureRequest a través de correo electrónico. Para enviar correo electrónico, debe usar reglas:
- emailTo: correo electrónico del firmante
- emailFrom: correo electrónico del remitente
- nameFrom: nombre del remitente
El correo electrónico se entregará desde okdokument@okdokument.sk, pero cuando el firmante alcance el botón responder o responder todo, la respuesta se enviará directamente al remitente (emailFrom). También se recomienda usar las siguientes reglas para la configuración adicional en el proceso de firma:
- emailFinal: correo electrónico para enviar el documento firmado. De forma predeterminada, se usa emailTo, pero se puede cambiar. En el caso de la firma de varias rondas, use esta regla en la última ronda de firma y rellene todas las direcciones de correo electrónico de los cantantes. Ejemplo: emailFinalemail@address.com|email2@address.com
- emailNotification: correo electrónico para enviar recordatorio de que el documento está esperando la firma.
- language: idioma de la plantilla de correo electrónico
- filename: nombre del documento, que se usará en la plantilla de correo electrónico. Si no se rellena el nombre de archivo, el identificador de documento técnico se usará como nombre de documento.
3. Esperar firma
La acción de desencadenador "Esperar firma" se puede usar en el proceso. La acción "Esperar firma" está esperando hasta que la firma del documento se confirme en el servicio Ok dokument haciendo clic en el botón Enviar. Una vez enviada la firma, esta acción del desencadenador se ha completado. Puede usar esta acción si necesita esperar la confirmación de firma del documento en el proceso.
4. Descargar documento firmado
Esta acción le permite descargar el documento firmado y procesarlo en pasos adicionales del sistema o guardarlo en SharePoint u otro sistema de almacenamiento de documentos.
5. Eliminar documento
Una vez firmado el documento, puede eliminar el documento del servicio Ok dokument mediante la acción delete manualmente. Todos los documentos cargados se eliminan automáticamente después de 60 días y los documentos firmados se eliminan después de 10 días.
Obtención de credenciales
Puede obtener la clave de API necesaria para usar el servicio Ok dokument si se suscribe a https://okdokument.com/en/about/api/.
Problemas conocidos y limitaciones
Actualmente hay limitaciones en el uso de acrofields y etiquetas. El único uso posible de etiquetas o acrofields es el formato de cadena predefinido en el proceso: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ o _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .
Los nombres internos de acrofield personalizados están actualmente en uso:
| Casilla | Acrofield |
|---|---|
| Casilla opcional | monóxido de carbono |
| Casilla obligatoria | CR |
| Campo de texto | Acrofield |
|---|---|
| TextField opcional | PARA |
| Campo de texto obligatorio | TC |
| Grupo de botones de radio | Acrofield |
|---|---|
| Grupo de botones de radio opcional | RO |
| Grupo obligatorio de botones de radio | RC |
| Cuadro combinado | Acrofield |
|---|---|
| Cuadro combinado opcional | CBO |
| Cuadro combinado obligatorio | CBC |
Instrucciones de implementación
Use las instrucciones que se encuentran aquí para implementar este conector como conector personalizado en Microsoft Power Automate, Power Apps o Azure LogicApps.
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| OK dokument API Key | securestring | La clave de API de aplicación o suscripción emitida por Anasoft | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Carga de documentos |
Carga de documentos |
| Descargar documento firmado |
Descargar documento firmado |
| Eliminación de documentos |
Eliminación de documentos |
| Solicitud de firma |
Solicitud de firma |
Carga de documentos
Carga de documentos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Operación de documento
|
state | string |
Operación de documento |
|
|
Archivo
|
file | True | binary |
Contenido del archivo |
|
Filename
|
filename | string |
Nombre de archivo con extensión |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de documento
|
result | string |
Id. de documento |
Descargar documento firmado
Descargar documento firmado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
Document ID | True | string |
Id. de documento de la acción Carga de documentos |
Devoluciones
Contenido del documento
- Contenido del documento
- binary
Eliminación de documentos
Eliminación de documentos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
Document ID | True | string |
Id. de documento |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
código |
|
Mensaje
|
message | string |
Mensaje |
|
código de estado
|
statusCode | integer |
código de estado |
Solicitud de firma
Solicitud de firma
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de documento
|
id | True | string |
Id. de documento de la acción Carga de documentos |
|
Campos de firma
|
SIGNATURE | string |
Campos de firma en el documento |
|
|
Hora de expiración
|
expirationTime | string |
Hora de expiración en milisegundos |
|
|
Nombre
|
name | string |
Nombre del campo de acrocampo |
|
|
Importancia
|
value | string |
Valor de Acrofield |
|
|
Solo lectura
|
readOnly | boolean |
Acrofield es de solo lectura |
|
|
Reglas adicionales
|
rules | string |
Reglas para definir el proceso de solicitud de firma |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de solicitud de firma
|
result | string |
Identificador de solicitud de firma |
|
Dirección URL de solicitud de firma
|
url | string |
URL |
Desencadenadores
| Esperar la firma del documento |
Esperar la firma del documento |
Esperar la firma del documento
Esperar la firma del documento
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de solicitud de firma
|
signatureRequestId | True | string |
Identificador de solicitud de firma de la acción solicitud de firma |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
código |
|
código de estado
|
statusCode | integer |
código de estado |
Definiciones
binary
Este es el tipo de datos básico "binary".