OK dokument (Editora Independente) (Pré-visualização)
O dokument OK oferece uma assinatura eletrônica fácil de usar e personalizável e uma plataforma de distribuição de documentos digitais que se integra perfeitamente aos seus sistemas existentes
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - 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 |
| tomas.szarka@seyfor.com |
| Metadados do conector | |
|---|---|
| Editora | Seyfor Slovensko, a.s. |
| Sítio Web | https://okdokument.com/ |
| Política de privacidade | https://okdokument.com/_user/files/OKdokument/gdpr-en.pdf |
| Categorias | Produtividade |
OK dokument - assinatura electrónica
OK dokument oferece uma assinatura eletrônica fácil de usar e personalizável e plataforma de distribuição de conteúdo digital que se integra perfeitamente com seus sistemas existentes.
Editora
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 OK dokument .
Operações suportadas
1. Upload de documentos
Ação utilizada para carregar um ficheiro PDF para o serviço de assinatura de documentos. Essa ação usa uma string base64 e a carrega para a plataforma OK dokument API.
Documento passa por vários estados durante sua vida. OK dokument API usa os seguintes estados do documento:
- tags – estado que pesquisa tags de texto e insere acrofields de assinatura. Após a inserção bem-sucedida de acrofields, ele muda automaticamente de estado para tosign
- tostamp – indicar que inserir carimbo digital no documento
- tosign – documento pronto a assinar
- assinado – documento assinado (dentro de uma determinada assinaturaRequestID)
- ErrorsEndInfo – Erro ao chamar o serviço de informações
- cancelado – documento cancelado – signatário pressionou o botão "Cancelar" no documento
Acrofields de assinatura
Acrofield é um tipo de campo ativo suportado em PDF. Um 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 o JasperReport.
Etiquetas
Uma tag representa um valor de texto exclusivo que o servidor de API verifica. Se encontrá-lo, ele insere o acrofield de assinatura em seu lugar. A pesquisa de tags é fornecida pelo estado do documento "tags", que deve ser definido quando o serviço JSON/document é chamado. OKdokument API suporta as seguintes tags para assinatura opcional:
_SO1_
_SO2_
_SO3_
_SO4_
_SO5_
A API OKdokument suporta as seguintes tags para assinatura obrigatória: _SC1__SC2__SC3_ _SC4__SC5_
Se forem usadas etiquetas obrigatórias, todos os acrofields de assinatura obrigatórios visíveis devem ser assinados antes de enviar o documento.
Caso não seja possível preparar documentos com acrofields ou tags de assinatura ao registrar signatureRequest, é possível ativar a funcionalidade "sign anywhere", que permitirá ao usuário assinar o documento em qualquer local, simples onde o usuário clica/toca
Converter documento em PDF
OKdokument API suporta a conversão de .doc, .docx, .xls.xlsx em formato de arquivo PDF. O arquivo de origem pode conter também tags, OKdokument API primeiro fará a conversão do arquivo e, em seguida, insere automaticamente acrofields assinatura.
Para converter o arquivo em PDF você deve preencher o nome do documento. Este parâmetro é obrigatório se você quiser fazer a conversão do arquivo para o formato PDF. Para a conversão, o arquivo postfix deve ser:
- contract.doc
- contract.docx
- contract.xls
- contract.xlsx
Armazenamento e exclusão de documentos
OK dokument API não serve a função de um arquivo permanente de documento assinado. São aplicadas as seguintes regras:
- O documento assinado é automaticamente excluído 10 dias após a assinatura
- O documento não assinado é automaticamente eliminado após 30 dias após o carregamento
2. Pedido de assinatura
Esta ação é usada para gerar ID de solicitação de assinatura. Dentro desta ação, você tem que usar a ID do documento. A ID do documento é um resultado da ação de carregamento do documento.
Nesta ação, você pode transformar seu processo de assinatura em um processo de assinatura de vários estágios. Adicionar o parâmetro adicional "Campos de assinatura" permite gerenciar 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_
Esta ação pode ser usada várias vezes no seu processo. A ação de solicitação de assinatura é gerada no serviço OK dokument como "Solicitação de assinatura" e essa ID é exclusiva para cada ação "Assinar".
Para enviar uma solicitação de assinatura de documento, use a URL do atributo de resposta e use-a em e-mail, notificação por push ou MS Teams para pedir 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 novo signatureRequestId e preparar o documento para a próxima assinatura. Do que o processo repete as etapas 3 – 5.
Exemplo de pedido 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 no pedido de assinatura
Regras adicionais podem ser usadas para:
- Desativar ou ativar a funcionalidade Assinar em Qualquer Local
- Valor predefinido para o nome do signatário
- Habilitando a entrada para o nome do signatário
- ativando o envio de solicitação de assinatura do OK Dokument
- ativar lembrete por e-mail
- Configuração de OTP (one time password) via e-mail ou SMS
- assinar documento com OTP
- desativar a assinatura com o mouse
| Nome da Regra | Parâmetro | Description |
|---|---|---|
| signAnywhereEnabled | verdadeiro/falso | parâmetro para desativar a função Sign Anywhere |
| guiRequestSignerName | verdadeiro/falso | 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, máximo de 40 caracteres. Se guiRequestSignerName estiver habilitado, o nome do signatário poderá ser alterado pelo signatário. |
| signAnywhereEnabled | verdadeiro/falso | parâmetro para desativar a função Sign Anywhere |
| e-mailPara | E-mail do signatário | Os signatários enviam um e-mail para o qual o URL da solicitação de assinatura será |
| ser entregues. | ||
| e-mailDe | E-mail do remetente | E-mail dos remetentes. Obrigatório se a regra emailTo for usada |
| nomeDe | Nome do remetente | Nome dos remetentes, que será usado nos modelos de e-mail |
| e-mailNotificação | Regra que permite o lembrete por e-mail. Lembrete por e-mail envia e-mail todas as manhãs às 7:00 para solicitações de assinatura que não estão assinadas. O e-mail é enviado para emailTo e emailFrom – de acordo com a configuração signatureRequest. | |
| e-mailFinal | E-mail do signatário | E-mail para entregar o documento assinado. Se emailFinal estiver sem parâmetro, o documento assinado será enviado para emailTo. |
| openOtpPhone | Telefone signatário | Número de telefone dos signatários para o qual a senha única para acessar o documento será entregue. Para usar SMS OTP, você deve comprar pacote de solicitação de assinatura com SMS. |
| openOtpEmail | E-mail do signatário | Os signatários enviam um e-mail para o qual será entregue a senha única para acessar o documento. |
| signOtpPhone | Telefone 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 assinatura acrofield. |
| signOtpEmail | E-mail do signatário | Os signatários enviam um e-mail para o qual a senha única para assinar o documento será entregue. A assinatura OTP requer assinatura acrofield. |
| idioma | SK, CS, EN, RO, UK, PL, PT, HU | Idioma do modelo de e-mail e SMS, Se a regra não estiver definida, o eslovaco como idioma padrão é usado. |
| mouseAssinatura | false | Regra para desativar a assinatura com o mouse. |
Sintaxe para escrever regras de solicitação de assinatura
RuleName-Value
Sintaxe para escrever regras de solicitação de assinatura múltipla
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 Assinar em Qualquer Lugar desabilitado, nome do signatário habilitado com valor pré-preenchido, e-mail OTP definido para abrir solicitação de assinatura, e-mail para onde a solicitação de assinatura é enviada, idioma do modelo de e-mail, e-mail do remetente da 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
Prazo de validade
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 este parâmetro expirationTime. Tempo de expiração do ID do pedido de assinatura. Tempo em milissegundos desde 1 de janeiro de 1970 00:00:00 UTC
OKdokument API permite que você compartilhe signatureRequest url via e-mail. Para enviar e-mail, você tem que usar regras:
- emailTo – e-mail do signatário
- emailFrom – e-mail do remetente
- nameFrom – nome do remetente
O e-mail será entregue a partir da okdokument@okdokument.sk, mas quando o signatário apertar o botão responder/responder a todos, a resposta será enviada diretamente para o remetente (emailFrom). Recomendamos também o uso das seguintes regras para configuração adicional no processo de assinatura:
- emailFinal – email para envio do documento assinado. Por padrão, emailTo é usado, mas pode ser alterado. Em caso de assinatura multi-round, use esta regra na última rodada de assinatura e preencha os endereços de e-mail de todos os cantores. Exemplo: emailFinalemail@address.com|email2@address.com
- emailNotification - e-mail para enviar lembrete de que o documento está aguardando assinatura.
- idioma – idioma do modelo de e-mail
- Nome do arquivo – Nome do documento, que será usado no modelo de e-mail. Se o nome do arquivo não for preenchido, o ID do documento técnico será usado como um nome de documento
3. Aguarde a assinatura
A ação de gatilho "Aguarde assinatura" pode ser usada em seu processo. A ação "Esperar assinatura" está aguardando até que a assinatura do documento seja confirmada no serviço OK dokument clicando no botão Enviar. Uma vez que a assinatura é enviada, esta ação de gatilho é concluída. Você pode usar essa ação se precisar aguardar a confirmação da assinatura do documento em seu processo.
4. Faça o download do documento assinado
Essa ação permite que você baixe o documento assinado e processe o documento em etapas adicionais em seu sistema ou salve-o no SharePoint ou em outro sistema de armazenamento de documentos.
5. Eliminar documento
Depois que o documento for assinado, você poderá excluí-lo do serviço OK dokument usando a ação excluir manualmente. Todos os documentos carregados são eliminados automaticamente após 60 dias e os documentos assinados são eliminados após 10 dias.
Obtenção de credenciais
Você pode obter a chave de API necessária para usar o serviço OK dokument inscrevendo-se em https://okdokument.com/en/about/api/.
Problemas conhecidos e limitações
Atualmente, existem limitações para o uso de acrofields e tags. O único uso possível de tags ou acrofields é o formato de string predefinido em seu processo: _SC1_, _SC2_, _SC3_, _SC4_, _SC5_ ou _SO1_, _SO2_, _SO3_, _SO4_, _SO5_ .
Nomes internos personalizados do acrofield estão atualmente em uso:
| Caixa de verificação | Acrofield |
|---|---|
| Caixa de seleção opcional | Monóxido de Carbono |
| Caixa de seleção obrigatória | CR |
| Campo de texto | Acrofield |
|---|---|
| Campo de texto opcional | PARA |
| Campo de texto obrigatório | TC |
| Grupo de botões de opção | Acrofield |
|---|---|
| Grupo de botões de opção opcional | RO |
| Grupo de botões de opção obrigatórios | 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.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| OK dokument API Key | securestring | A chave API do aplicativo/assinatura emitida pela Anasoft | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Download do Documento Assinado |
Download do Documento Assinado |
| Exclusão de documento |
Exclusão de documento |
| Pedido de Assinatura |
Pedido de Assinatura |
| Upload de documentos |
Upload de documentos |
Download do Documento Assinado
Download do Documento Assinado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
Document ID | True | string |
ID do documento da ação Carregamento de Documento |
Devoluções
Conteúdo do documento
- Conteúdo do documento
- binary
Exclusão de documento
Exclusão de documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
Document ID | True | string |
ID do documento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
código |
|
mensagem
|
message | string |
mensagem |
|
código de estado
|
statusCode | integer |
código de estado |
Pedido de Assinatura
Pedido de Assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
id | True | string |
ID do documento da ação Carregamento de Documento |
|
Campos de assinatura
|
SIGNATURE | string |
Campos de assinatura no documento |
|
|
Prazo de validade
|
expirationTime | string |
Tempo de expiração em milissegundos |
|
|
Nome
|
name | string |
Nome do acrofield |
|
|
Valor
|
value | string |
Valor de Acrofield |
|
|
Somente Leitura
|
readOnly | boolean |
Acrofield é somente leitura |
|
|
Regras Adicionais
|
rules | string |
Regras para definir o processo de solicitação de assinatura |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Pedido de Assinatura
|
result | string |
ID do Pedido de Assinatura |
|
URL de solicitação de assinatura
|
url | string |
URL |
Upload de documentos
Upload de documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Operação de documentos
|
state | string |
Operação de documentos |
|
|
Ficheiro
|
file | True | binary |
Conteúdo do ficheiro |
|
Nome do ficheiro
|
filename | string |
Nome do ficheiro com extensão |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
result | string |
ID do documento |
Acionadores
| Aguarde a assinatura do documento |
Aguarde a assinatura do documento |
Aguarde a assinatura do documento
Aguarde a assinatura do documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Pedido de Assinatura
|
signatureRequestId | True | string |
ID de solicitação de assinatura da ação de solicitação de assinatura |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
code | string |
código |
|
código de estado
|
statusCode | integer |
código de estado |
Definições
binário
Este é o tipo de dados básico 'binário'.