OK dokument (Independent Publisher) (Versão prévia)

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes:      – Governo dos EUA (GCC)      – Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:      – Regiões do Azure Governamental      - Regiões do Azure China      - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes:      – Governo dos EUA (GCC)      – Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes:      – Governo dos EUA (GCC)      – Governo dos EUA (GCC High)      - China Cloud operado pela 21Vianet      - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Seyfor Slovensko a.s.
URL	https://www.seyfor.com
Email	tomas.szarka@seyfor.com

Metadados do conector
Publicador	Seyfor Slovensko, a.s.
Site	https://okdokument.com/
Política de privacidade	https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf
Categorias	Produtividade

OK dokument - assinatura eletrônica

O ok dokument oferece uma assinatura eletrônica fácil de usar e personalizável e uma plataforma de distribuição de conteúdo digital que se integra perfeitamente aos seus sistemas existentes.

Publicador

Seyfor Slovensko, a.s.

Pré-requisitos

Você precisa ter uma conta e https://app.okdokument.com uma chave de API válida gerada pelo serviço de dokument OK .

Operações com suporte

1. Upload de documento

Ação usada para carregar um arquivo PDF no serviço de assinatura de documento. Essa ação usa uma cadeia de caracteres base64 e a carrega na plataforma de API de dokument OK .

O documento passa por vários estados durante seu tempo de vida. A API de dokument OK usa os seguintes estados de documento:

• marcas – estado que pesquisa marcas de texto e insere acrofields de assinatura. Após a inserção bem-sucedida de acrofields, ele altera automaticamente o estado para a atribuição
• tostamp – estado que insere o carimbo digital no documento
• tosign – documento pronto para ser assinado
• assinado – documento assinado (em determinada signatureRequestID)
• errorsendinfo – erro ao chamar o serviço de informações
• cancelado – documento cancelado – o signatário pressionou o botão "Cancelar" no documento

Acrofields de assinatura

Acrofield é um tipo de campo ativo com suporte em PDF. Um campo de acrofield de assinatura é um tipo especial de campo ativo que permite que uma assinatura seja inserida em um documento em um local fixo. Os Acrofields podem ser inseridos em PDFs com ferramentas PDF especializadas, como o Adobe PRO, ou com ferramentas de modelo, como JasperReport.

Etiquetas

Uma marca representa um valor de texto exclusivo que o servidor de API verifica. Se o encontrar, ele inserirá o campo de acrofield de assinatura em seu lugar. A pesquisa de marca é fornecida pelo estado do documento "marcas", que deve ser definido quando o serviço JSON/documento é chamado. A API OKdokument dá suporte às seguintes marcas para assinatura opcional:

_SO1_ _SO2_ _SO3_ _SO4_ _SO5_

A API OKdokument dá suporte às seguintes marcas para assinatura obrigatória: _SC1__SC2__SC3_ _SC4__SC5_

Se as marcas obrigatórias forem usadas, todos os acrofields de assinatura obrigatória visíveis deverão ser assinados antes de enviar o documento.

Caso não seja possível preparar documentos com acrofields de assinatura ou marcas ao registrar signatureRequest, é possível habilitar a funcionalidade "entrar em qualquer lugar", o que permitirá que o usuário assine o documento em qualquer local, simples em que o usuário clica/toca

Converter documento em PDF

A API OKdokument dá suporte à conversão de .doc, .docx, .xls, .xlsx em formato de arquivo PDF. O arquivo de origem também pode conter marcas, a API OKdokument primeiro fará a conversão de arquivo e, em seguida, insere automaticamente acrofields de assinatura.

Para converter o arquivo em PDF, você deve preencher o nome do documento. Esse parâmetro será obrigatório se você quiser fazer a conversão de arquivo no formato PDF. Para conversão, o postfixo de arquivo deve ser:

• contract.doc
• contract.docx
• contract.xls
• contract.xlsx

Armazenando e excluindo documentos

A API ok dokument não atende à função de um arquivo permanente de documento assinado. As seguintes regras são aplicadas:

1. O documento assinado é excluído automaticamente 10 dias após a assinatura
2. O documento não assinado é excluído automaticamente após 30 dias após o upload

2. Solicitação de Assinatura

Essa ação é usada para gerar a ID da solicitação de assinatura. Nesta ação, você precisa usar a ID do Documento. A ID do Documento é resultado da ação de upload do documento.
Nesta ação, você pode transformar seu processo de assinatura em um processo de assinatura de várias fases. A adição de parâmetro adicional "Campos de assinatura" permite que você gerencie o que deve estar disponível em cada solicitação de assinatura. Você pode usar acrofields com nomes internos

_SO1_ _SO2_ _SO3_ _SO4_ _SO5_

OR

_SC1_ _SC2_ _SC3_ _SC4_ _SC5_

Essa ação pode ser usada várias vezes em seu processo. A ação de solicitação de assinatura é gerada no serviço de dokument OK como "Solicitação de assinatura" e essa ID é exclusiva para cada ação "Sign".

Para enviar solicitação de assinatura de documento, use a URL do atributo de resposta e use-a por email, notificação por push ou MS Teams para solicitar que alguém assine um documento específico.

Depois que o documento for assinado, você poderá usar "Solicitação de assinatura" para alterar o estado do documento para "tosign" e criar nova signatureRequestId e preparar o documento para a próxima assinatura. Do que o processo repete as etapas 3 a 5.

Exemplo de solicitação de assinatura com um acrofield obrigatório

_SC1_

Exemplo de solicitação de assinatura com um acrofield obrigatório e em acrofield opcional em uma solicitação de assinatura_SC1_;_SO2_

Regras adicionais na solicitação de assinatura

Regras adicionais podem ser usadas para:

• Desabilitar ou habilitar o recurso Sign Anywhere
• Valor predefine para o nome do signatário
• habilitando a entrada para o nome do signatário
• habilitando o envio de solicitação de assinatura do OK Dokument
• habilitar o lembrete de email
• Configuração de OTP (senha única) por email ou SMS
• assinar documento com o OTP
• desabilitar a assinatura com o mouse

Nome da Regra	Parâmetro	Description
signAnywhereEnabled	true/false	parâmetro para desabilitar a função sign anywhere
guiRequestSignerName	true/false	parâmetro para habilitar a entrada para o nome do signatário
guiSignerName	Nome do signatário	valor predefinido para o nome do signatário, no máximo 40 caracteres. Se guiRequestSignerName estiver habilitado, o nome do signatário poderá ser alterado pelo signatário.
signAnywhereEnabled	true/false	parâmetro para desabilitar a função sign anywhere
emailTo	Email do signatário	Email de signatários para o qual a URL de solicitação de assinatura será
ser entregue.
emailFrom	Email do remetente	Remetentes de email. Obrigatório se a regra emailTo for usada
nameFrom	Nome do remetente	Nome dos remetentes, que será usado nos modelos de email
notificação de e-mail		Regra que habilita o lembrete de email. O lembrete de email envia emails todas as manhãs às 7:00 para solicitações de assinatura que não estão assinadas. O email é enviado para emailTo e emailFrom – de acordo com - a configuração signatureRequest.
emailFinal	Email do signatário	Email para entregar o documento assinado. Se emailFinal estiver sem parâmetro, o documento assinado será enviado para emailTo.
openOtpPhone	Telefone do signatário	Número de telefone dos signatários para o qual a senha única para acessar o documento será entregue. Para usar o SMS OTP, você deve comprar o pacote de solicitação de assinatura com SMS.
openOtpEmail	Email do signatário	Os signatários enviarão um email para o qual a senha única para acessar o documento será entregue.
signOtpPhone	Telefone do signatário	Número de telefone dos signatários para o qual a senha única para assinar o documento será entregue. A assinatura OTP requer acrofield de assinatura.
signOtpEmail	Email do signatário	Os signatários enviarão um email para o qual a senha única para assinar o documento será entregue. A assinatura OTP requer acrofield de assinatura.
lang	sk, cs, en, ro, uk, pl, pt, hu	Linguagem de email e modelo de SMS, se a regra não estiver definida, o eslovaco como um idioma padrão será usado.
mouseSignature	false	Regra para desabilitar a assinatura com o mouse.

Sintaxt para escrever regras de solicitação de assinatura
RuleName-Value

Sintaxt para escrever várias regras de solicitação de assinatura
RuleName1-Value_RuleName2-Value_RuleName3-Value

Exemplo de solicitação de assinatura com o Sign Anywhere habilitado
signAnywhereEnabled-true

Exemplo de solicitação de assinatura com o sign anywhere desabilitado e o nome do Signatário habilitado com valor pré-preenchido
guiSignerName-John Doe_guiRequestSignerName-true_signAnywhereEnabled-false

Exemplo de solicitação de assinatura com Sign Anywhere desabilitado, nome do Signatário habilitado com valor pré-preenchido, email OTP definido para abrir solicitação de assinatura, email para onde a solicitação de assinatura é enviada, idioma do modelo de email, email do remetente de solicitação de assinatura
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

Tempo de expiração

O valor padrão para a expiração da solicitação de assinatura é de 24 horas. Você pode estender esse intervalo de tempo até 10 dias usando esse parâmetro expirationTime. Hora de expiração da ID da solicitação de assinatura. Tempo em Milissegundos desde 1º de janeiro de 1970 00:00:00 UTC

Email

A API OKdokument permite que você compartilhe a URL signatureRequest por email. Para enviar emails, você precisa usar regras:

• emailTo – email do signatário
• emailFrom – email do remetente
• nameFrom – nome do remetente

O email será entregue okdokument@okdokument.sk, mas quando o signatário atingir o botão responder/responder a todos, a resposta será enviada diretamente ao remetente (emailFrom). Recomendamos também usar as seguintes regras para configuração adicional no processo de assinatura:

• emailFinal – email para enviar o documento assinado. Por padrão, emailTo é usado, mas pode ser alterado. No caso de assinatura de várias rodadas, use essa regra na última rodada de assinatura e preencha os endereços de email de todos os cantores. Exemplo: emailFinalemail@address.com|email2@address.com
• emailNotification – email para enviar um lembrete de que o documento está aguardando assinatura.
• idioma – idioma do modelo de email
• nome do arquivo – nome do documento, que será usado no modelo de email. Se o nome do arquivo não estiver preenchido, a ID do documento técnico será usada como um nome de documento

3. Aguardar assinatura

A ação de gatilho "Aguardar assinatura" pode ser usada em seu processo. A ação "Aguardar Assinatura" está aguardando até que a assinatura do documento seja confirmada no serviço ok dokument clicando no botão Enviar. Depois que a assinatura for enviada, essa ação de gatilho será concluída. Você pode usar essa ação se precisar aguardar a confirmação da assinatura do documento em seu processo.

4. Baixar documento assinado

Essa ação permite baixar o documento assinado e processar o documento em etapas adicionais em seu sistema ou salvá-lo no SharePoint ou em outro sistema de armazenamento de documentos.

5. Excluir documento

Depois que o documento for assinado, você poderá excluir o documento do serviço ok dokument usando a exclusão de ação manualmente. Todos os documentos carregados são excluídos automaticamente após 60 dias e os documentos assinados são excluídos após 10 dias.

Obtendo credenciais

Você pode obter a chave de API necessária para usar o serviço ok dokument assinando em https://okdokument.com/en/about/api/.

Problemas e limitações conhecidos

Atualmente, há limitações para usar acrofields e marcas. O único uso possível de marcas ou acrofields é o formato de cadeia de caracteres predefinido em seu processo: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ ou _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .

Nomes internos de acrofield personalizados estão atualmente em uso:

Caixa de seleção	Acrofield
Caixa de seleção opcional	Monóxido de Carbono
Caixa de seleção obrigatória	CR

Campo texto	Acrofield
Campo de texto opcional	TO
Campo texto obrigatório	TC

Grupo de botões de opção	Acrofield
Grupo de botões opcionais de opção de opção	RO
Grupo de botões de opção obrigatória	RC

Caixa de combinação	Acrofield
Caixa de combinação opcional	CBO
Caixa de combinação obrigatória	CBC

Instruções de implantação

Use as instruções localizadas aqui para implantar esse conector como conector personalizado no Microsoft Power Automate, Power Apps ou Azure LogicApps.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API de dokument OK	secureString	A chave da API de aplicativo/assinatura emitida pela Anasoft	Verdade

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Baixar documento assinado	Baixar documento assinado
Exclusão de documento	Exclusão de documento
Solicitação de Assinatura	Solicitação de Assinatura
Upload do documento	Upload do documento

Baixar documento assinado

Exclusão de documento

Solicitação de Assinatura

Upload do documento

Gatilhos

Aguardar assinatura do documento

Aguardar assinatura do documento

Aguardar assinatura do documento

Definições

binário