Lex Power Sign (Pré-visualização)
A Lex Persona é um prestador europeu de serviços de confiança qualificado que oferece uma gama de soluções de assinatura eletrónica. Com o Lex Enterprise, você tem acesso a todos os níveis de assinatura do eIDAS, juntamente com um grande número de métodos de autenticação de assinantes. Seus livros de assinatura são incorporados em fluxos de trabalho digitais. Automatize as conexões entre o Lex Enterprise e todas as suas ferramentas para eliminar tarefas repetitivas, ganhar eficiência e acelerar seus negócios.
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 | Suporte Lex Persona |
| URL | https://support.lex-persona.com |
| support@lex-persona.com |
| Metadados do conector | |
|---|---|
| Editora | Lex Persona |
| Sítio Web | https://www.lex-persona.com |
| Política de privacidade | https://www.lex-persona.com/politique-de-confidentialite/ |
| Categorias | IA; Sítio Web |
A Lex Persona é um prestador europeu de serviços de confiança qualificado que oferece uma gama de soluções de assinatura eletrónica. Com esse conector, você pode adicionar facilmente o recurso de assinatura eletrônica ao seu aplicativo baseado na Microsoft (PowerApp, aplicativo Web baseado em .NET, Dynamics...) e ao ambiente (Outlook, Sharepoint, Teams...). O conector é apoiado pelo nosso gestor de fluxo de trabalho Lex Enterprise. Você pode criar fluxos de trabalho de assinatura eletrônica compostos por diferentes tipos de etapas que podem ser executadas em sequência e/ou em paralelo. O conector suporta todos os níveis de assinatura eIDAS e oferece uma ampla gama de métodos de autenticação de signatários (OTP, SSO, France Connect, Identité Numérique La Poste, tokens de hardware...)
Pré-requisitos
Você precisará ter o seguinte para prosseguir:
- Subscrição do Lex Enterprise. Use o plano de avaliação para testar
Os requisitos ambientais são:
- Um plano Microsoft Power Apps ou Power Automate com recurso de conector personalizado
- As ferramentas da CLI da plataforma Power
Como obter credenciais
Entre em contato com nossos representantes de vendas para obter uma assinatura Lex Enteprise ou uma conta em commercial@lex-persona.com nossos sistemas de avaliação.
Conecte-se ao portal Lex Enterprise com sua conta e gere uma chave de API.
Introdução ao conector
Primeiro, crie uma conexão para o conector. Defina o método de autenticação como chave de API, forneça sua chave de API ("Bearer act_XXXXXXX") e especifique que a chave de API deve ser colocada no cabeçalho de Autrorization das chamadas de API.
As etapas para criar um fluxo de trabalho de assinatura simples são as seguintes:
- logo após o tigre, recupere o ID de usuário do Lex Enterprise conectado (esse ID é necessário para criar um fluxo de trabalho) com a ação Recuperar-me
- páginas de consentimento de pesquisa com as páginas de consentimento de pesquisa action_. Você pode usar o parâmetro text para pesquisar páginas de consentimento por nome (as páginas de consentimento definem o nível de assinatura e são pré-configuradas em seu ambiente Lex Enterprise)
- crie um fluxo de trabalho de assinatura com a ação Criar fluxo de trabalho . Nesta etapa, você deve fornecer as informações dos signatários.
- Pesquisar perfis de assinatura com a ação Pesquisar perfis de assinatura. Você pode usar o parâmetro text para pesquisar perfis de assinatura por nome (os perfis de assinatura controlam alguns aspetos do comportamento das páginas de consentimento. Forçar o signatário a rolar até a parte inferior do documento antes de assinar, por exemplo)
- Recuperar um documento do seu ambiente (Sharepoint, Outlook, OneDrive...)
- adicionar o documento ao fluxo de trabalho com a ação Criar parte , definindo o parâmetro createDocument como true
- iniciar o fluxo de trabalho com a ação Atualizar fluxo de trabalho , definindo o Status do Fluxo de Trabalho como iniciado
Atenção: O conector é emparelhado com o nosso servidor de avaliação por padrão. Se quiser emparelhar o conector com seu próprio locatário, altere a URL do host na definição de segurança do conector ou no arquivo apiDefinitions.json:
- "host": "yourtenant.lexpersona.com",
Conhecer problemas e limitações
A ação Criar documento aceita uma lista de partes do documento em sua carga útil. No entanto, se você fornecer várias partes, apenas a primeira será levada em conta (isso é devido a um bug em nossa API. Ele será corrigido na próxima versão do conector).
Consequentemente, se você quiser adicionar vários documentos a um fluxo de trabalho, é necessário executar uma chamada para Criar parte com o parâmetro createDocument definido como true para cada documento.
Erros e soluções comuns
Em caso de falha de uma chamada de API, a resposta da chamada de API contém uma mensagem de erro abrangente que é exibida no histórico de execução do conector. A mensagem contém também um ID de registo, para que, se precisar de mais informações sobre o erro, possa ligar-se ao portal Lex Enteprise e consultar o ficheiro de registo do servidor. Alternativley, você pode configurar um pedido de carteiro para pesquisar os logs de nossos servidores (plase consultar a documentação: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Os códigos de erro HTTP mais comuns retornados pela nossa API são os seguintes:
- Erro 400 - Solicitação incorreta. Há algo errado no seu pedido paylod. Consulte o log para encontrar informações sobre a causa do erro
- Erro 401 - Não autorizado. Yo não tem os direitos de acesso para executar esta operação. Verifique os seus direitos de acesso de utilizador do Lex Persona
- Erro 403 - Proibido. Sua chave de API está invlaid ou desabilitada
- Erro 404 - Não encontrado. Existe um erro no URL do seu pedido
Você também pode verificar nossa documentação para obter mais detalhes sobre cada chamada de API possíveis códigos de erro (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
FAQ
Quais são os formatos de documentos suportados pelo conector
Os documentos que você pode enviar para assinatura podem ter os formatos pdf, docx, pptx e xlsx. O conector converterá os documentos em pdf, se necessário, e as assinaturas terão o formato PAdES.
Também é possível assinar documentos XML. Neste caso, nenhuma conversão será aplicada e as assinaturas terão o formato XAdES.
Também é possível fazer upload de arquivos zip. O conector descompactará o arquivo e adicionará cada documento ao fluxo de trabalho.
Você também pode adicionar anexos a fluxos de trabalho de assinaturas. O anexo não está assinado e pode ter qualquer formato.
Um documento pode ter vários signatários
Yes. O número de signatários de um documento é ilimitado.
É possível assinar vários documentos ao mesmo tempo
Yes. Você pode adicionar vários documentos a um fluxo de trabalho e todos os documentos serão assinados simultaneamente. Note-se, no entanto, que, neste caso, o conjunto de documentos estará juridicamente ligado e que o sistema produzirá um ficheiro único de provas.
Você também pode criar brilhos de trabalho mutlpiple coantaining o mesmo signatário. No momento da assinatura, a lista de documentos será apresentada ao signatário, e este terá a oportunidade de selecionar os documentos que deseja assinar. Neste caso, os documentos serão juridicamente independentes, e será produzido um arquivo de provas para cada documento.
É possível assinar um documento offline
Não. Uma conexão intenet é necessária para acessar as páginas de consentimento.
É possível enviar remiders de assinatura automática para os signatários
Yes. Você pode configurar o período de lembrete e o número máximo de lembretes a serem enviados.
É possível modificar um fluxo de trabalho de assinatura já iniciado
Yes. Antes de qualquer assinatura, você pode modificar qualquer coisa no fluxo de trabalho. Após a primeira assinatura, é impossível modificar os documentos, mas você ainda pode modificar as etapas do fluxo de trabalho.
Qual é a duração de validade das senhas de uso único
A duração de validade do One Time Passwords é de dois minutos (uma contagem é exibida nas páginas de consentimento).
É possível verificar a validade de uma assinatura eletrónica?
Você pode usar o painel Assinaturas do Adobe Acrobat para verificar a validade das assinaturas contidas em um documento pdf. Como alternativa, você pode usar um serviço Web de validação de assinatura confiável (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation por exemplo)
Quais são as condições de armazenamento de documentos Lex Persona?
Por padrão, mantemos os arquivos de documentos e evidências em nossos servidores. Tou pode pesquisar e baixar documentos a qualquer momento. Se solicitado, podemos, no entanto, excluir priodicamente seus documentos de nossos servidores.
A Lex Persona mantém os tokens de carimbos de data/hora?
Não. Não guardamos os tokens de carimbos de data/hora. Se necessário, você pode extracxt esses tokens dos documentos assinados.
Existe um prazo de retratação para um documento assinado
Yes. O período de retirada depende das condições legais que se aplicam ao documento.
É possível cancelar um fluxo de trabalho de assinatura
Yes. Um usuário autorizado pode cancelar um fluxo de trabalho de assinatura iniciado a qualquer momento. Nenhum processo de despejo será produzido e se o documento já foi assinado por um ou muitos signatários, os sgnatures serão anulados.
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 |
|---|---|---|---|
| Chave de API | securestring | A chave de API para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atualizar contato |
Modificar uma informação de contato existente |
| Atualizar documento |
Atualizar um documento |
| Atualizar fluxo de trabalho |
Atualizar um fluxo de trabalho |
| Atualizar layout de metadados |
Atualizar um layout de metadados |
| Atualizar perfil de assinatura |
Atualizar um perfil de assinatura |
| Baixar documentos de fluxo de trabalho |
Faça o download dos documentos do fluxo de trabalho |
| Criar contacto |
Adicionar um contato à lista de contatos do usuário atual |
| Criar documento |
Criar um documento a partir de partes criadas anteriormente |
| Criar layout de metadados |
Criar um layout de metadados |
| Criar perfil de assinatura |
Criar um perfil de assinatura |
| Criar peça |
Criar uma parte do documento |
| Criar um fluxo de trabalho |
Criar um fluxo de trabalho |
| Download do arquivo de evidências |
Baixe o arquivo de evidências do fluxo de trabalho |
| Eliminar documento |
Eliminar um documento |
| Excluir contato |
Remover contato da lista de contects do usuário atual |
| Excluir fluxo de trabalho |
Excluir um fluxo de trabalho |
| Fluxos de trabalho de pesquisa |
Fluxos de trabalho de pesquisa |
| Layouts de metadados de pesquisa |
Layouts de fluxo de trabalho de pesquisa |
| Pesquisar contactos |
Pesquisar contactos |
| Pesquisar documentos |
Pesquisar documentos |
| Pesquisar perfis de assinatura |
Pesquisar perfis de assinatura |
| Pesquisar páginas de consentimento |
Pesquisar páginas de consentimento |
| Recuperar contato |
Recuperar informações de contato do ID de contato |
| Recuperar documento |
Recuperar um documento |
| Recuperar fluxo de trabalho |
Recuperar fluxo de trabalho a partir da ID do fluxo de trabalho |
| Recuperar layout de metadados |
Recuperar um layout de fluxo de trabalho |
| Recuperar mapeamento de metadados |
Recuperar o mapeamento de metadados do locatário especificado |
| Recuperar-me |
Recuperar o ID do usuário conectado |
| Recuperar perfil de assinatura |
Recuperar um perfil de assinatura |
| Recuperar página de consentimento |
Recuperar informações da página de consentimento do ID da página de consentimento |
| Recuperar url da página constent |
Criar e recuperar o URL da página de consentimento para um destinatário |
Atualizar contato
Modificar uma informação de contato existente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
ID do contacto |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
E-mail do contato
|
string |
E-mail do contato |
||
|
Número de telefone do contacto
|
phoneNumber | string |
Número de telefone do contacto |
|
|
Nome próprio do contacto
|
firstName | string |
Nome próprio do contacto |
|
|
Apelido do contacto
|
lastName | string |
Apelido do contacto |
|
|
País do contacto
|
country | string |
País do contacto |
Devoluções
- Body
- contact
Atualizar documento
Atualizar um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
signatureProfileId
|
signatureProfileId | string |
O perfil de assinatura a ser acessado neste documento |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagemPágina
|
imagePage | float |
imagemPágina |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imagem X
|
imageX | float |
imagem X |
|
|
imagemY
|
imageY | float |
imagemY |
Devoluções
- Body
- document
Atualizar fluxo de trabalho
Atualizar um fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
Id do fluxo de trabalho a ser atualizado |
|
Tipo de conteúdo
|
Content-Type | string |
Tipo de conteúdo |
|
|
ID do Utilizador
|
userId | string |
Id do proprietário do fluxo de trabalho |
|
|
Nome
|
name | string |
Nome do fluxo de trabalho |
|
|
Description
|
description | string |
Descrição do fluxo de trabalho |
|
|
id
|
id | string |
passo Id |
|
|
stepType
|
stepType | string |
assinatura ou aprovação |
|
|
consentimentoPageId
|
consentPageId | True | string |
ID da página de consentimento (nível de assinatura) associada a este destinatário |
|
e-mail
|
True | string |
e-mail do destinatário |
|
|
userId
|
userId | string |
fazer referência a um usuário LE em vez de criar um destinatário instantaneamente |
|
|
Número de telefone
|
phoneNumber | string |
Número de telemóvel de Reicpient |
|
|
primeiroNome
|
firstName | string |
nome próprio do destinatário |
|
|
sobrenome
|
lastName | string |
Apelido do destinatário |
|
|
country
|
country | string |
indicativo do país do destinatário |
|
|
preferredLocale
|
preferredLocale | string |
código de localidade do destinatário |
|
|
organizationId
|
organizationId | string |
Id da organização LE do destinatário |
|
|
requiredDestinatários
|
requiredRecipients | number |
Número mínimo de signatários que devem assinar para dar o próximo passo |
|
|
validadePeríodo
|
validityPeriod | number |
Duração da validade do passo |
|
|
período de convite
|
inviteperiod | number |
Frequência de lembretes de assinatura |
|
|
maxConvites
|
maxInvites | number |
Número máximo de lembretes de assinatura |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
Controla a entrega do documento assinado aos signatários |
|
|
permitirComentários
|
allowComments | boolean |
permite/proíbe comentários sobre esta etapa |
|
|
ocultarAnexos
|
hideAttachments | boolean |
Controla a exibição de anexos aos signatários |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
Controla a exibição de outros signatários para o signatário |
|
|
Eventos notificados
|
notifiedEvents | array of string |
Eventos de fluxo de trabalho notificados |
|
|
userId
|
userId | string |
ID do usuário do observador |
|
|
notificadoEvents
|
notifiedEvents | array of string |
Eventos de fluxo de trabalho que serão notificados a este observador |
|
|
e-mail
|
string |
|
||
|
Status do fluxo de trabalho
|
workflowStatus | string |
Status atual do fluxo de trabalho |
|
|
dados1
|
data1 | string |
Primeiros metadados |
|
|
dados2
|
data2 | string |
segundo metadados |
|
|
dados3
|
data3 | string |
terceiros metadados |
|
|
dados4
|
data4 | string |
quarto metadados |
|
|
dados5
|
data5 | string |
Quinto Metadados |
|
|
dados6
|
data6 | string |
sexto metadado |
|
|
dados7
|
data7 | string |
Sétimo Metadados |
|
|
dados8
|
data8 | string |
Metadados Heighth |
Devoluções
- Body
- workflow
Atualizar layout de metadados
Atualizar um layout de metadados
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de Inquilino
|
layoutId | True | string |
Id do layout |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Nome
|
name | True | string |
O nome do layout |
|
Está desativado
|
isDisabled | boolean |
Se definido como true, o layout será desativado |
|
|
Faixa horária
|
slot | string |
Item de metadados (data1 a data8) |
|
|
predefinição
|
default | string |
Valor padrão de metadados neste layout |
|
|
optional
|
optional | boolean |
Se verdadeiro, fornecer um valor não é obrigatório |
|
|
só de leitura
|
readonly | boolean |
Se o valor pode ser sobrecarregado |
|
|
lembrarLastValue
|
rememberLastValue | boolean |
Se definido como true, o valor persiste nos fluxos de trabalho |
Devoluções
Layout de metadados
- Body
- layout
Atualizar perfil de assinatura
Atualizar um perfil de assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do perfil de assinatura
|
spId | True | string |
ID do perfil de assinatura |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
É padrão
|
isDefault | string |
Torna este perfil de assinatura o padrão |
|
|
Está desativado
|
isDisabled | string |
Desativar este perfil de assinatura |
|
|
Nome
|
name | string |
O nome do perfil de assinatura |
|
|
Tipo de assinatura
|
signatureType | string |
pades,xades,xadesDestacado,xadesDestacadoManifest,cades,helios |
|
|
Forçar a rolagem para a parte inferior do documento
|
forceScrollDocument | boolean |
Forçar o signatário a rolar até a parte inferior do documento |
|
|
Modo de assinatura visível
|
pdfVisibleSignatureMode | string |
Modo de assinatura visível (permitido, desativado, noImage) |
|
|
Texto da assinatura
|
pdfSignatureImageText | string |
Texto exibido em blocos de assinaturas |
|
|
Cor do texto da assinatura
|
pdfSignatureImageTextColor | string |
Cor do texto exibido nas almofadas singatures |
|
|
Tamanho do texto da assinatura
|
pdfSignatureImageTextSize | number |
Tamanho do texto exibido nas almofadas de singatures |
Devoluções
- Body
- signatureProfile
Baixar documentos de fluxo de trabalho
Faça o download dos documentos do fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
Devoluções
- response
- binary
Criar contacto
Adicionar um contato à lista de contatos do usuário atual
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
userId | True | string |
Utilizador a quem pertence o contacto |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
E-mail de contacto
|
True | string |
E-mail de contacto |
|
|
Número de telefone do contatct
|
phoneNumber | string |
Número de telefone |
|
|
Nome próprio do contato
|
firstName | True | string |
primeiroNome |
|
Sobrenome do contato
|
lastName | True | string |
sobrenome |
|
País de contacto
|
country | string |
country |
Devoluções
- Body
- contact
Criar documento
Criar um documento a partir de partes criadas anteriormente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho em causa |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
TipoDeConteúdo
|
contentType | string |
TipoDeConteúdo |
|
|
filename
|
filename | string |
filename |
|
|
hash
|
hash | string |
hash |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
O perfil de assinatura deste documento |
Devoluções
- Body
- document
Criar layout de metadados
Criar um layout de metadados
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de Inquilino
|
tenantId | True | string |
Id do layout |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Nome
|
name | True | string |
O nome do layout |
|
Está desativado
|
isDisabled | boolean |
Se definido como true, o layout será desativado |
|
|
Faixa horária
|
slot | string |
Item de metadados (data1 a data8) |
|
|
predefinição
|
default | string |
Valor padrão de metadados neste layout |
|
|
optional
|
optional | boolean |
Se verdadeiro, fornecer um valor não é obrigatório |
|
|
só de leitura
|
readonly | boolean |
Se o valor pode ser sobrecarregado |
|
|
lembrarLastValue
|
rememberLastValue | boolean |
Se definido como true, o valor persiste nos fluxos de trabalho |
Devoluções
Layout de metadados
- Body
- layout
Criar perfil de assinatura
Criar um perfil de assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de Inquilino
|
tenantId | True | string |
ID do inquilino |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
É padrão
|
isDefault | True | string |
Torna este perfil de assinatura o padrão |
|
Está desativado
|
isDisabled | string |
Desativar este perfil de assinatura |
|
|
Nome
|
name | True | string |
O nome do perfil de assinatura |
|
Tipo de documento
|
documentType | True | string |
PDF, XML, Word, Excel, PowerPoint, Outros |
|
Tipo de assinatura
|
signatureType | True | string |
pades,xades,xadesDestacado,xadesDestacadoManifest,cades,helios |
|
Forçar a rolagem para a parte inferior do documento
|
forceScrollDocument | True | boolean |
Forçar o signatário a rolar até a parte inferior do documento |
|
Modo de assinatura visível
|
pdfVisibleSignatureMode | string |
Modo de assinatura visível (permitido, desativado, noImage) |
|
|
Texto da assinatura
|
pdfSignatureImageText | string |
Texto exibido em blocos de assinaturas |
|
|
Cor do texto da assinatura
|
pdfSignatureImageTextColor | string |
Cor do texto exibido nas almofadas singatures |
|
|
Tamanho do texto da assinatura
|
pdfSignatureImageTextSize | number |
Tamanho do texto exibido nas almofadas de singatures |
Devoluções
- Body
- signatureProfile
Criar peça
Criar uma parte do documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho em causa |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Disposição cotente
|
Content-Disposition | True | string |
Conteúdo-Dispoção |
|
Criar documento
|
createDocuments | string |
Criar um documento a partir desta parte |
|
|
Ignorar anexos
|
ignoreAttachments | string |
Os anexos serão ignorados |
|
|
ID do perfil de assinatura
|
signatureProfileId | string |
Parte considerada como anexo se omitida |
|
|
Descompacte
|
unzip | string |
Descompactar arquivos |
|
|
Pdf para PdfA
|
pdf2pdfa | string |
Converter pdf em pdf/A |
|
|
Documento
|
document | True | binary |
Os dados do ficheiro carregado |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentação
|
documents | array of document |
Documentos criados |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
peças
|
parts | array of part |
peças |
Criar um fluxo de trabalho
Criar um fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Utilizador
|
userId | True | string |
ID de usuário do proprietário do fluxo de trabalho |
|
Tipo de conteúdo
|
Content-Type | string |
Tipo de conteúdo |
|
|
Nome
|
name | True | string |
Nome do fluxo de trabalho |
|
Description
|
description | string |
Descrição do fluxo de trabalho |
|
|
id
|
id | string |
passo Id |
|
|
stepType
|
stepType | string |
assinatura ou aprovação |
|
|
consentimentoPageId
|
consentPageId | True | string |
ID da página de consentimento (nível de assinatura) associada a este destinatário |
|
e-mail
|
True | string |
e-mail do destinatário |
|
|
userId
|
userId | string |
fazer referência a um usuário LE em vez de criar um destinatário instantaneamente |
|
|
Número de telefone
|
phoneNumber | string |
Número de telemóvel de Reicpient |
|
|
primeiroNome
|
firstName | string |
nome próprio do destinatário |
|
|
sobrenome
|
lastName | string |
Apelido do destinatário |
|
|
country
|
country | string |
indicativo do país do destinatário |
|
|
preferredLocale
|
preferredLocale | string |
código de localidade do destinatário |
|
|
organizationId
|
organizationId | string |
Id da organização LE do destinatário |
|
|
requiredDestinatários
|
requiredRecipients | number |
Número mínimo de signatários que devem assinar para dar o próximo passo |
|
|
validadePeríodo
|
validityPeriod | number |
Duração da validade do passo |
|
|
período de convite
|
inviteperiod | number |
Frequência de lembretes de assinatura |
|
|
maxConvites
|
maxInvites | number |
Número máximo de lembretes de assinatura |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
Controla a entrega do documento assinado aos signatários |
|
|
permitirComentários
|
allowComments | boolean |
permite/proíbe comentários sobre esta etapa |
|
|
ocultarAnexos
|
hideAttachments | boolean |
Controla a exibição de anexos aos signatários |
|
|
hideWorkflowRecipients
|
hideWorkflowRecipients | boolean |
Controla a exibição de outros signatários para o signatário |
|
|
Eventos notificados
|
notifiedEvents | array of string |
Eventos de fluxo de trabalho notificados |
|
|
userId
|
userId | string |
ID de utilizador do observador |
|
|
notificadoEvents
|
notifiedEvents | array of string |
Eventos de fluxo de trabalho que serão notificados a este observador |
|
|
e-mail
|
string |
E-mail do observador |
||
|
ID do modelo
|
templateId | string |
Id do modelo do qual o fluxo de trabalho deriva |
|
|
Layout Id
|
layoutId | string |
Layout de metadados usado pelo worklow |
|
|
dados1
|
data1 | string |
Primeiros metadados |
|
|
dados2
|
data2 | string |
Metadados secundários |
|
|
dados3
|
data3 | string |
Terceiros metadados |
|
|
dados4
|
data4 | string |
Quarto metadados |
|
|
dados5
|
data5 | string |
Quinto metadado |
|
|
dados6
|
data6 | string |
Sexto metadado |
|
|
dados7
|
data7 | string |
Sétima metainformação |
|
|
dados8
|
data8 | string |
Oitavo metadados |
Devoluções
- Body
- workflow
Download do arquivo de evidências
Baixe o arquivo de evidências do fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
|
Aceitar
|
Accept | True | string |
Aceitar |
Devoluções
- response
- binary
Eliminar documento
Eliminar um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Devoluções
- Body
- document
Excluir contato
Remover contato da lista de contects do usuário atual
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
ID do contacto |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
Devoluções
- Body
- contact
Excluir fluxo de trabalho
Excluir um fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho a ser excluído |
Devoluções
- Body
- workflow
Fluxos de trabalho de pesquisa
Fluxos de trabalho de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Aceitar
|
Accept | string |
Aceitar |
|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Layout de metadados de pesquisa
|
items.layoutId | string |
Pesquisar por layout de metadados |
|
|
Modelo de pesquisa
|
items.templateId | string |
Pesquisar por modelo de fluxo de trabalho |
|
|
Grupo de pesquisa
|
items.groupId | string |
Pesquisar por grupo de utilizadores |
|
|
Pesquisar utilizador
|
items.userId | string |
Pesquisa por proprietário |
|
|
Pesquisar e-mail
|
items.email | string |
Procurar por e-mail do proprietário |
|
|
Pesquisar nome próprio
|
items.firstname | string |
Pesquisa por nome próprio do proprietário |
|
|
Pesquisar apelido
|
items.lastname | string |
Pesquisa por apelido do proprietário |
|
|
Estado da pesquisa
|
items.workflowStatus | string |
Pesquisar por status do fluxo de trabalho |
|
|
Metadados de pesquisa 1
|
items.data1 | string |
Pesquisa por valor de metadados 1 |
|
|
Metadados de pesquisa 2
|
items.data2 | string |
Pesquisa por valor de metadados 2 |
|
|
Metadados de pesquisa 3
|
items.data3 | string |
Pesquisa por valor de metadados 3 |
|
|
Metadados de pesquisa 4
|
items.data4 | string |
Pesquisa por valor de metadados 4 |
|
|
Metadados de pesquisa 5
|
items.data5 | string |
Pesquisa por valor de metadados 5 |
|
|
Metadados de pesquisa 6
|
items.data6 | string |
Pesquisa por valor de metadados 6 |
|
|
Metadados de pesquisa 7
|
items.data7 | string |
Pesquisa por valor de metadados 7 |
|
|
Pesquisar metadados 8
|
items.data8 | string |
Pesquisa por valor de metadados 8 |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisa por data de criação |
|
|
Data de atualização da pesquisa
|
items.updated | string |
Pesquisar por data da última atualização |
|
|
Data de início da pesquisa
|
items.started | string |
Pesquisa por data de início |
|
|
Ordenar por
|
sortBy | string |
O campo utilizado para ordenar o resultado da pesquisa |
|
|
Ordem de classificação
|
sortOrder | string |
A direção da classificação |
|
|
Itens por página
|
itemsPerPage | string |
Número de itens por página na resposta |
|
|
Índice da página
|
pageIndex | string |
Índice da página devolvida |
Devoluções
- Body
- workflows
Layouts de metadados de pesquisa
Layouts de fluxo de trabalho de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Pesquisa desativada
|
items.isDisabled | string |
Pesquisar layouts desativados |
|
|
Pesquisar nome
|
items.name | string |
Pesquisar por nome de layout |
|
|
Metadados de pesquisa
|
items.dataConfigurations.slot | string |
Pesquisa por presença de metadados |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisa por data de criação |
|
|
Data de atualização da pesquisa
|
items.updated | string |
Pesquisar por data da última atualização |
|
|
Ordenar por
|
sortBy | string |
O campo utilizado para ordenar o resultado da pesquisa |
|
|
Ordem de classificação
|
sortOrder | string |
A direção da classificação |
|
|
Itens por página
|
itemsPerPage | string |
Número de itens por página na resposta |
|
|
Índice da página
|
pageIndex | string |
Índice da página devolvida |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | layouts |
Pesquisar contactos
Pesquisar contactos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisa por texto |
|
|
Pesquisar e-mail
|
items.email | string |
Pesquisar por e-mail |
|
|
Pesquisar número de telefone
|
items.phoneNumber | string |
Pesquisar por número de telefone |
|
|
Pesquisar nome próprio
|
items.fisrtName | string |
Pesquisa por nome próprio |
|
|
Pesquisar apelido
|
items.lastName | string |
Pesquisa por apelido |
|
|
Pesquisar país
|
items.country | string |
Pesquisa por país |
|
|
Itens por página
|
itemsPerPage | number |
Número de itens por página na resposta |
|
|
Índice da página
|
pageIndex | number |
Índice da página devolvida |
Devoluções
- Body
- contacts
Pesquisar documentos
Pesquisar documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Layout de metadados de pesquisa
|
items.layoutId | string |
Pesquisar por layout de metadados |
|
|
Grupo de pesquisa
|
items.groupId | string |
Pesquisar por grupo de utilizadores |
|
|
Pesquisar utilizador
|
items.userId | string |
Pesquisa por proprietário |
|
|
ID do fluxo de trabalho de pesquisa
|
items.workflowId | string |
Pesquisar por ID do fluxo de trabalho |
|
|
Nome do fluxo de trabalho de pesquisa
|
items.workflowName | string |
Pesquisar por nome do fluxo de trabalho |
|
|
Metadados de pesquisa 1
|
items.data1 | string |
Pesquisa por valor de metadados 1 |
|
|
Metadados de pesquisa 2
|
items.data2 | string |
Pesquisa por valor de metadados 2 |
|
|
Metadados de pesquisa 3
|
items.data3 | string |
Pesquisa por valor de metadados 3 |
|
|
Metadados de pesquisa 4
|
items.data4 | string |
Pesquisa por valor de metadados 4 |
|
|
Metadados de pesquisa 5
|
items.data5 | string |
Pesquisa por valor de metadados 5 |
|
|
Metadados de pesquisa 6
|
items.data6 | string |
Pesquisa por valor de metadados 6 |
|
|
Metadados de pesquisa 7
|
items.data7 | string |
Pesquisa por valor de metadados 7 |
|
|
Pesquisar metadados 8
|
items.data8 | string |
Pesquisa por valor de metadados 8 |
|
|
Pesquisar perfil de assinatura
|
items.signatureProfileId | string |
Pesquisar por perfil de assinatura |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisa por data de criação |
|
|
Data de atualização da pesquisa
|
items.updated | string |
Pesquisar por data da última atualização |
|
|
Ordenar por
|
sortBy | string |
O campo utilizado para ordenar o resultado da pesquisa |
|
|
Ordem de classificação
|
sortOrder | string |
A direção da classificação |
|
|
Itens por página
|
itemsPerPage | string |
Número de itens por página na resposta |
|
|
Índice da página
|
pageIndex | string |
Índice da página devolvida |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | documents |
Pesquisar perfis de assinatura
Pesquisar perfis de assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Padrão de pesquisa
|
items.isDefault | string |
Pesquisar perfis de assinatura padrão |
|
|
Pesquisa desativada
|
items.isDisabled | string |
Pesquisar perfis de assinatura desativados |
|
|
Pesquisar nome
|
items.name | string |
Pesquisar por nome de perfil de assinatura |
|
|
Tipo de documento de pesquisa
|
items.documentType | string |
Pesquisa por tipo de documento |
|
|
Tipo de assinatura de pesquisa
|
items.signatureType | string |
Pesquisar por tipo de assinatura |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisa por data de criação |
|
|
Data de atualização da pesquisa
|
items.updated | string |
Pesquisar por data da última atualização |
|
|
Ordenar por
|
sortBy | string |
O campo utilizado para ordenar o resultado da pesquisa |
|
|
Ordem de classificação
|
sortOrder | string |
A direção da classificação |
|
|
Itens por página
|
itemsPerPage | string |
Número de itens por página na resposta |
|
|
Índice da página
|
pageIndex | string |
Índice da página devolvida |
Devoluções
- Body
- signatureProfiles
Pesquisar páginas de consentimento
Pesquisar páginas de consentimento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Padrão de pesquisa
|
items.isDefault | string |
Pesquisar página de consentimento padrão |
|
|
Pesquisa desativada
|
items.isDisabled | string |
Pesquisar páginas de consentimento desativadas |
|
|
Pesquisar nome
|
items.name | string |
Pesquisar por nome de página de consentimento |
|
|
Tipo de etapa de pesquisa
|
items.stepType | string |
Pesquisar por tipo de passo |
|
|
ID do cliente de pesquisa
|
items.clientId | string |
Pesquisa por ID do cliente |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisa por data de criação |
|
|
Data de atualização da pesquisa
|
items.updated | string |
Pesquisar por data da última atualização |
|
|
Ordenar por
|
sortBy | string |
O campo no qual ordenar o resultado da pesquisa |
|
|
Ordem de classificação
|
sortOrder | string |
A direção da classificação |
|
|
Itens por página
|
itemsPerPage | string |
Número de itens por página na resposta |
|
|
Índice da página
|
pageIndex | string |
Índice da página devolvida |
Devoluções
- Body
- consentPages
Recuperar contato
Recuperar informações de contato do ID de contato
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
ID do contacto |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
Devoluções
- Body
- contact
Recuperar documento
Recuperar um documento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Devoluções
- Body
- document
Recuperar fluxo de trabalho
Recuperar fluxo de trabalho a partir da ID do fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
Devoluções
- Body
- workflow
Recuperar layout de metadados
Recuperar um layout de fluxo de trabalho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Layout Id
|
layoutId | True | string |
Id do layout |
Devoluções
Layout de metadados
- Body
- layout
Recuperar mapeamento de metadados
Recuperar o mapeamento de metadados do locatário especificado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID de Inquilino
|
tenantId | True | string |
ID do inquilino |
Devoluções
- Body
- dataMapping
Recuperar-me
Recuperar perfil de assinatura
Recuperar um perfil de assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do perfil de assinatura
|
spId | True | string |
ID do perfil de assinatura |
Devoluções
- Body
- signatureProfile
Recuperar página de consentimento
Recuperar informações da página de consentimento do ID da página de consentimento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página de consentimento
|
cpId | True | string |
ID da página de consentimento |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
Devoluções
- Body
- consentPage
Recuperar url da página constent
Criar e recuperar o URL da página de consentimento para um destinatário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
|
E-mail do destinatário
|
recipientEmail | string |
E-mail do destinatário em questão |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
O URL da página de consentimento para o destinatário em questão
|
inviteUrl | string |
O URL da página de consentimento para o destinatário em questão |
Definições
página de consentimento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
permitirOrganização
|
allowOrganization | boolean |
Permite o uso de organizações |
|
autenticarUsuário
|
authenticateUser | boolean |
Impõe a autenticação do signatário |
|
clientId
|
clientId | string |
ID de Cliente |
|
criado
|
created | number |
Data de criação |
|
emUrl
|
emUrl | string |
Url do gestor de evidências |
|
ocultarDownloads
|
hideDownloads | boolean |
Os links para download de documentos não são divulgados nas páginas de consentimento |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Oculta os códigos QR em páginas constantes |
|
id
|
id | string |
O ID da página de consentimento |
|
isCountryRequired
|
isCountryRequired | boolean |
Torna o país obrigatório nas informações dos signatários |
|
isDisabled
|
isDisabled | boolean |
A página de consentimento está desativada |
|
logoResourceId
|
logoResourceId | string |
ID do recurso de logotipo da página de consentimento |
|
nome
|
name | string |
O nome da página de consentimento |
|
primaryColor
|
primaryColor | string |
Cor primária da página de consentimento |
|
secundárioColor
|
secondaryColor | string |
Cor secundária da página de consentimento |
|
frase secreta compartilhada
|
sharedPassphrase | string |
Senha compartilhada |
|
Modo de assinatura
|
signing mode | string |
Modo de assinatura (local ou servidor) |
|
stepType
|
stepType | string |
tipo de etapa (assinatura ou aprovação) |
|
tenantId
|
tenantId | string |
ID de Inquilino |
|
tsaUrl
|
tsaUrl | string |
URL da autoridade de carimbo de data/hora |
|
atualizado
|
updated | number |
Data da última modificação |
|
verificarE-mail
|
verifyEmail | boolean |
Se definido como ter, os signatários receberão OTPs por e-mails |
|
verificar número de telefone
|
verifyPhoneNumber | boolean |
Se definido como true, os signatários receberão OTPs por mensagens de texto |
Páginas de Consentimento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItens
|
totalItems | integer |
totalItens |
contato
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
country
|
country | string |
País de contacto |
|
criado
|
created | integer |
Data de criação do contato |
|
e-mail
|
string |
E-mail de contacto |
|
|
primeiroNome
|
firstName | string |
Contato firstName |
|
id
|
id | string |
ID de contacto |
|
sobrenome
|
lastName | string |
Sobrenome de contato |
|
nome
|
name | string |
Nome do contato (nome + sobrenome)) |
|
Número de telefone
|
phoneNumber | string |
Número de telefone de contacto |
|
tenantId
|
tenantId | string |
ID de Inquilino |
|
atualizado
|
updated | integer |
Data da última modificação do contato |
|
userId
|
userId | string |
ID do proprietário do contato |
contacts
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItens
|
totalItems | integer |
totalItens |
mapeamento de dados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
data1.description | string |
Descrição dos metadados |
|
nome
|
data1.name | string |
Nome dos metadados |
|
padrão
|
data1.pattern | string |
Padrão de metadados |
|
options
|
data1.options | array of object |
options |
|
valor
|
data1.options.value | string |
Valor dos metadados |
|
tipo
|
data1.type | string |
tipo |
|
descrição
|
data2.description | string |
Descrição dos metadados |
|
nome
|
data2.name | string |
Nome dos metadados |
|
padrão
|
data2.pattern | string |
Padrão de metadados |
|
options
|
data2.options | array of object |
options |
|
valor
|
data2.options.value | string |
Valor dos metadados |
|
tipo
|
data2.type | string |
tipo |
|
descrição
|
data3.description | string |
Descrição dos metadados |
|
nome
|
data3.name | string |
Nome dos metadados |
|
padrão
|
data3.pattern | string |
Padrão de metadados |
|
options
|
data3.options | array of object |
options |
|
valor
|
data3.options.value | string |
Valor dos metadados |
|
tipo
|
data3.type | string |
tipo |
|
descrição
|
data4.description | string |
Descrição dos metadados |
|
nome
|
data4.name | string |
Nome dos metadados |
|
padrão
|
data4.pattern | string |
Padrão de metadados |
|
options
|
data4.options | array of object |
options |
|
valor
|
data4.options.value | string |
Valor dos metadados |
|
tipo
|
data4.type | string |
tipo |
|
descrição
|
data5.description | string |
Descrição dos metadados |
|
nome
|
data5.name | string |
Nome dos metadados |
|
padrão
|
data5.pattern | string |
Padrão de metadados |
|
options
|
data5.options | array of object |
options |
|
valor
|
data5.options.value | string |
Valor dos metadados |
|
tipo
|
data5.type | string |
tipo |
|
descrição
|
data6.description | string |
Descrição dos metadados |
|
nome
|
data6.name | string |
Nome dos metadados |
|
padrão
|
data6.pattern | string |
Padrão de metadados |
|
options
|
data6.options | array of object |
options |
|
valor
|
data6.options.value | string |
Valor dos metadados |
|
tipo
|
data6.type | string |
tipo |
|
descrição
|
data7.description | string |
Descrição dos metadados |
|
nome
|
data7.name | string |
Nome dos metadados |
|
padrão
|
data7.pattern | string |
Padrão de metadados |
|
options
|
data7.options | array of object |
options |
|
valor
|
data7.options.value | string |
Valor dos metadados |
|
tipo
|
data7.type | string |
tipo |
|
descrição
|
data8.description | string |
Descrição dos metadados |
|
nome
|
data8.name | string |
Nome dos metadados |
|
padrão
|
data8.pattern | string |
Padrão de metadados |
|
options
|
data8.options | array of object |
options |
|
valor
|
data8.options.value | string |
Valor dos metadados |
|
tipo
|
data8.type | string |
tipo |
documento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criado
|
created | integer |
Data de criação |
|
groupId
|
groupId | string |
Id do grupo do proprietário do documento |
|
id
|
id | string |
ID do documento |
|
peças
|
parts | array of part |
peças |
|
pdfCampos de Assinatura
|
pdfSignatureFields | array of pdfSigField |
pdfCampos de Assinatura |
|
signatureProfileId
|
signatureProfileId | string |
ID do perfil de assinatura do documento |
|
tenantId
|
tenantId | string |
ID do inquilino |
|
atualizado
|
updated | integer |
Data da última modificação |
|
userId
|
userId | string |
ID do usuário proprietário do documento |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupos autorizados a visualizar o documento |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Lista de usuários autorizados a visualizar o documento |
|
workflowId
|
workflowId | string |
Id do fluxo de trabalho ao qual o documento pertence |
|
nome do fluxo de trabalho
|
workflowName | string |
Nome do fluxo de trabalho ao qual o documento pertence |
Documentação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItens
|
totalItems | integer |
totalItens |
esquema
Layout de metadados
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criado
|
created | number |
Data de criação |
|
id
|
id | string |
Layout Id |
|
isDisabled
|
isDisabled | boolean |
Se definido como true, o layout foi desativado |
|
nome
|
name | string |
O nome do layout |
|
tenantId
|
tenantId | string |
ID do inquilino |
|
atualizado
|
updated | number |
Data da última modificação |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
Faixa horária
|
dataConfigurations.slot | string |
Item de metadados (data1 a data8) |
|
predefinição
|
dataConfigurations.default | string |
Valor padrão de metadados neste layout |
|
optional
|
dataConfigurations.optional | boolean |
Se verdadeiro, fornecer um valor para esses metadados não é obrigatório |
|
só de leitura
|
dataConfigurations.readonly | boolean |
Se o valor pode ser sobrecarregado |
|
lembrarLastValue
|
dataConfigurations.rememberLastValue | boolean |
Se definido como true, o valor persiste nos fluxos de trabalho |
Layouts
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
criado
|
items.created | number |
Data de criação |
|
dataConfigurations
|
items.dataConfigurations | array of layout | |
|
itemsPerPage
|
itemsPerPage | number |
Número de itens por página |
|
pageIndex
|
pageIndex | number |
Índice da página devolvida |
|
totalItens
|
totalItems | number |
Número total de elementos abrangidos pelo pedido |
part
Parte do documento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
TipoDeConteúdo
|
contentType | string |
TipoDeConteúdo |
|
filename
|
filename | string |
filename |
|
hash
|
hash | string |
hash |
|
size
|
size | integer |
size |
pdfCampo Sig
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagemPágina
|
imagePage | float |
imagemPágina |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imagem X
|
imageX | float |
imagem X |
|
imagemY
|
imageY | float |
imagemY |
signatureProfile
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criado
|
created | number |
Data de criação |
|
Tipo de documento
|
documentType | string |
Tipo de documentos |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Forçar o signatário a rolar até a parte inferior do documento |
|
id
|
id | string |
o ID do perfil de assinatura |
|
isDefault
|
isDefault | boolean |
Torna este perfil de assinatura o padrão |
|
isDisabled
|
isDisabled | boolean |
Desativar este perfil de assinatura |
|
nome
|
name | string |
O nome do perfil de assinatura |
|
pdfAssinaturaImagemTexto
|
pdfSignatureImageText | string |
Texto exibido em blocos de assinaturas |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Cor do texto exibido nas almofadas singatures |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Tamanho do texto exibido nas almofadas de singatures |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Modo de assinatura visível (permitido, desativado, noImage) |
|
Tipo de assinatura
|
signatureType | string |
pades, xades, xadesDestacado, xadesDestacadoManifesto, cades, helios |
|
tenantId
|
tenantId | string |
ID de Inquilino |
|
atualizado
|
updated | number |
Data da última modificação |
signatureProfiles
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of signatureProfile | |
|
itemsPerPage
|
itemsPerPage | number |
Número de itens por página |
|
pageIndex
|
pageIndex | number |
Índice da página devolvida |
|
totalItens
|
totalItems | number |
Número total de elementos abrangidos pelo pedido |
utilizador
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
aprovarPermitido
|
approveAllowed | boolean |
Se definido como true, o usuário pode aprovar documentos |
|
country
|
country | string |
País do utilizador |
|
criado
|
created | integer |
Data de criação |
|
e-mail
|
string |
E-mail do usuário |
|
|
primeiroNome
|
firstName | string |
Nome-nome do utilizador |
|
groupId
|
groupId | string |
ID do grupo de utilizadores |
|
id
|
id | string |
ID do utilizador |
|
isDisabled
|
isDisabled | boolean |
Se verdadeiro, o usuário está desativado |
|
últimoLogin
|
lastLogin | integer |
A data do último login do usuário |
|
sobrenome
|
lastName | string |
Sobrenome do usuário |
|
nome
|
name | string |
Nome (nome + apelido) do utilizador |
|
organizaçãoTítulos
|
organizationTitles | array of |
As funções do usuário em suas organizações |
|
Número de telefone
|
phoneNumber | string |
Número de telefone do utilizador |
|
signPermitido
|
signAllowed | boolean |
Se definido como true, o usuário pode assinar documentos |
|
Assunto
|
subject | string |
O código subkect interno do usuário |
|
tenantId
|
tenantId | string |
ID do inquilino |
|
atualizado
|
updated | integer |
Data da última modificação |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupo no qual o usuário pode atuar como observador |
fluxo de trabalho
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
criado
|
created | integer |
criado |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
dados1
|
data1 | string |
Metadados 1 |
|
dados2
|
data2 | string |
Metadados 2 |
|
dados3
|
data3 | string |
Metadados 3 |
|
dados4
|
data4 | string |
Metadados 4 |
|
dados5
|
data5 | string |
Metadados 5 |
|
dados6
|
data6 | string |
Metadados 6 |
|
dados7
|
data7 | string |
Metadados 7 |
|
dados8
|
data8 | string |
Metadados 8 |
|
descrição
|
description | string |
Descrição do fluxo de trabalho |
|
e-mail
|
string |
Email do proprietário do fluxo de trabalho |
|
|
primeiroNome
|
firstName | string |
Nome do proprietário do fluxo de trabalho |
|
groupId
|
groupId | string |
Id do grupo do proprietário do fluxo de trabalho |
|
id
|
id | string |
ID do fluxo de trabalho |
|
sobrenome
|
lastName | string |
Sobrenome do proprietário do fluxo de trabalho |
|
layoutId
|
layoutId | string |
Id do layout de metadados do fluxo de trabalho |
|
registos
|
logs | array of |
Registra itens do wokflow |
|
nome
|
name | string |
Nome (nome + sobrenome) do proprietário do fluxo de trabalho |
|
notificadoEvents
|
notifiedEvents | array of string |
Lis de eventos notificados pelo fluxo de trabalho |
|
Progressos
|
progress | integer |
Progresso do fluxo de trabalho em percentagens |
|
steps
|
steps | array of object |
steps |
|
permitirComentários
|
steps.allowComments | boolean |
Permite/proíbe comentários interativos ara permitido na etapa |
|
ocultarAnexos
|
steps.hideAttachments | boolean |
Controla a exibição de anexos aos signatários |
|
hideWorkflowRecipients
|
steps.hideWorkflowRecipients | boolean |
Controla a exibição de outros signatários para o signatário |
|
id
|
steps.id | string |
ID do passo |
|
convidarPeríodo
|
steps.invitePeriod | integer |
convidarPeríodo |
|
isConcluído
|
steps.isFinished | boolean |
isConcluído |
|
estáIniciado
|
steps.isStarted | boolean |
estáIniciado |
|
registos
|
steps.logs | array of |
registos |
|
maxConvites
|
steps.maxInvites | integer |
maxConvites |
|
recipients
|
steps.recipients | array of object |
recipients |
|
consentimentoPageId
|
steps.recipients.consentPageId | string |
consentimentoPageId |
|
country
|
steps.recipients.country | string |
country |
|
e-mail
|
steps.recipients.email | string |
|
|
primeiroNome
|
steps.recipients.firstName | string |
primeiroNome |
|
sobrenome
|
steps.recipients.lastName | string |
sobrenome |
|
Número de telefone
|
steps.recipients.phoneNumber | string |
Número de telefone |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredDestinatários
|
steps.requiredRecipients | integer |
requiredDestinatários |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validadePeríodo
|
steps.validityPeriod | integer |
validadePeríodo |
|
tenantId
|
tenantId | string |
tenantId |
|
atualizado
|
updated | integer |
atualizado |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupos nos quais os usuários podem atuar como observadores |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
e-mail
|
watchers.email | string |
|
|
notificadoEvents
|
watchers.notifiedEvents | array of string |
notificadoEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItens
|
totalItems | integer |
totalItens |
binário
Este é o tipo de dados básico 'binário'.