Lex Power Sign (versão prévia)
Lex Persona é um provedor europeu de serviços confiáveis qualificados que oferece uma variedade 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 signatário. Seus livros de assinatura são inseridos em fluxos de trabalho digitais. Automatize as conexões entre o Lex Enterprise e todas as suas ferramentas para eliminar tarefas repetitivas, obter eficiência e acelerar seus negócios.
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 | Suporte ao Lex Persona |
| URL | https://support.lex-persona.com |
| support@lex-persona.com |
| Metadados do conector | |
|---|---|
| Publicador | Lex Persona |
| Site | https://www.lex-persona.com |
| Política de privacidade | https://www.lex-persona.com/politique-de-confidentialite/ |
| Categorias | IA; Site |
Lex Persona é um provedor europeu de serviços confiáveis qualificados que oferece uma variedade de soluções de assinatura eletrônica. Com esse conector, você pode adicionar facilmente a funcionalidade de assinatura eletrônica ao seu aplicativo baseado na Microsoft (PowerApp, aplicativo Web baseado em .NET, Dynamics...) e ambiente (Outlook, Sharepoint, Teams...). O conector é apoiado pelo nosso gerente de fluxo de trabalho do Lex Enterprise. Você pode criar fluxos de trabalho de assinatura de elétrons compostos por diferentes tipos de etapas que podem ser executadas em sequência e/ou em paralelo. O conector dá suporte a todos os níveis de assinatura do 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 continuar:
- Assinatura do Lex Enterprise. Usar o plano de avaliação para testar
Os requisitos de ambiente são:
- Um plano do Microsoft Power Apps ou do Power Automate com o recurso de conector personalizado
- As ferramentas da CLI da plataforma Power
Como obter credenciais
Entre em contato com nossos representantes de vendas commercial@lex-persona.com para obter uma assinatura do Lex Enteprise ou uma conta em nossos sistemas de avaliação.
Conecte-se ao portal do 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 Autrorização das chamadas à API.
As etapas para criar um fluxo de trabalho de assinatura simples são as seguintes:
- logo após o tigger, recupere a ID de usuário conectada do Lex Enterprise (essa ID é necessária 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 de texto para pesquisar páginas de consentimento por nome (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 informações de signatários.
- pesquisar perfis de assinatura com a ação Pesquisar perfis de assinatura. Você pode usar o parâmetro de texto para pesquisar perfis de assinatura por nome (perfis de assinatura controlam alguns aspectos do comportamento das páginas de consentimento. Force 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...)
- adicione 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 a ser iniciado
Observe: O conector é emparelhado com nosso servidor de avaliação por padrão. Se você quiser emparelhar o conector com seu próprio locatário, deverá alterar 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 int seu conteúdo. No entanto, se você fornecer várias partes, somente a primeira será levada em conta (isso ocorre 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, será necessário executar uma chamada para Criar parte com o parâmetro createDocument definido como true para cada documento.
Erros e soluções comuns
No caso de uma falha de chamada de API, a resposta de chamada à API contém uma mensagem de erro abrangente exibida no histórico de execução do conector. A mensagem também contém uma ID de log, para que, se você precisar de mais informações sobre o erro, possa se conectar ao portal do Lex Enteprise e consultar o arquivo de log do servidor. Alternativley, você pode configurar uma solicitação do Postman para pesquisar nossos logs de servidores (plase consulte a documentação: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).
Os códigos de erro HTTP mais comuns retornados por nossa API são os seguintes:
- Erro 400 – Solicitação incorreta. Há algo errado em sua solicitação paga. 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 direitos de acesso do usuário do Lex Persona
- Erro 403 – Proibido. Sua chave de API está invlaid ou desabilitada
- Erro 404 – Não encontrado. Há um erro na URL de solicitação
Você também pode verificar nossa documentação para obter mais detalhes sobre cada código de erro possível de chamada à API (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)
perguntas frequentes
Quais são os formatos de documentos compatíveis com o 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. Nesse caso, nenhuma conversão será aplicada e as assinaturas terão o formato XAdES.
Também é possível carregar arquivos zip. O conector descompactará o arquivo morto 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
Sim. O número de signatários de um documento é ilimitado.
É possível assinar vários documentos ao mesmo tempo
Sim. Você pode adicionar vários documentos a um fluxo de trabalho e todos os documentos serão assinados simultaneamente. Observe, no entanto, que, nesse caso, o conjunto de documentos será juridicamente vinculado e que o sistema produzirá um arquivo de evidências exclusivo.
Você também pode criar mutlpiple workglows coantaining do mesmo signatário. No momento da assinatura, a lista de documentos será apresentada ao signatário e o signatário terá a oportunidade de selecionar os documentos que ela deseja assinar. Nesse caso, os documentos serão juridicamente independentes, um arquivo de provas será produzido 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
Sim. 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
Sim. 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 da validade das senhas de uma vez
A duração da validade de Senhas de Uma Hora é de dois minutos (um countdow é exibido nas páginas de consentimento).
É possível verificar uma validade de assinatura eletrônica
Você pode usar o painel Assinaturas do Adobe Acrobat para verificar a validade das assinaturas contidas em um documento em 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 do Lex Persona
Por padrão, mantemos os arquivos de evidências ans de documentos em nossos servidores. O Tou pode pesquisar e baixar documentos a qualquer momento. Se solicitado, no entanto, podemos excluir priodicamente seus documentos de nossos servidores.
O Lex Persona mantém os tokens de carimbo de data/hora
Não. Não mantemos os tokens de carimbo de data/hora. Se necessário, você pode extracxt esses tokens dos documentos assinados.
Há um período de retirada para um documento assinado
Sim. A retirada perionada depende das condições legais que se aplicam ao documento.
É possível cancelar um fluxo de trabalho de assinatura
Sim. Um usuário authoriezd pode cancelar um fluxo de trabalho de assinatura iniciado a qualquer momento. Nenhum arquivo de evicences será produzido e, se o documento já tiver sido assinado por um ou muitos signatários, os sgnatures serão anulados.
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 | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar contato |
Modificar informações de contato existentes |
| 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 |
Baixar os documentos de fluxo de trabalho |
| Baixar o arquivo de evidências |
Baixar o arquivo de evidências do fluxo de trabalho |
| Criar contato |
Adicionar um contato à lista de contatos do usuário atual |
| Criar documento |
Criar um documento com base em partes criadas previamente |
| Criar fluxo de trabalho |
Criar um fluxo de trabalho |
| Criar layout de metadados |
Criar um layout de metadados |
| Criar parte |
Criar uma parte do documento |
| Criar perfil de assinatura |
Criar um perfil de assinatura |
| Excluir contato |
Remover contato da lista de contects do usuário atual |
| Excluir documento |
Excluir um documento |
| Excluir fluxo de trabalho |
Excluir um fluxo de trabalho |
| Pesquisar contatos |
Pesquisar contatos |
| Pesquisar documentos |
Pesquisar documentos |
| Pesquisar fluxos de trabalho |
Pesquisar fluxos de trabalho |
| Pesquisar layouts de metadados |
Pesquisar layouts de fluxo de trabalho |
| Pesquisar perfis de assinatura |
Pesquisar perfis de assinatura |
| Página Recuperar consentimento |
Recuperar informações da página de consentimento da ID da página de consentimento |
| Páginas de consentimento da pesquisa |
Páginas de consentimento da pesquisa |
| Recuperar contato |
Recuperar informações de contato da ID de contato |
| Recuperar documento |
Recuperar um documento |
| Recuperar fluxo de trabalho |
Recuperar fluxo de trabalho 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 a ID do usuário conectado |
| Recuperar perfil de assinatura |
Recuperar um perfil de assinatura |
| Recuperar url de página constent |
Criar e recuperar a URL da página de consentimento para um destinatário |
Atualizar contato
Modificar informações de contato existentes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
ID do contato |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Email do contato
|
string |
Email do contato |
||
|
Número de telefone do contato
|
phoneNumber | string |
Número de telefone do contato |
|
|
Nome do contato
|
firstName | string |
Nome do contato |
|
|
Sobrenome do contato
|
lastName | string |
Sobrenome do contato |
|
|
País do contato
|
country | string |
País do contato |
Retornos
- Corpo
- contact
Atualizar documento
Atualizar um documento
Parâmetros
| Nome | Chave | Obrigató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 atribuído a este documento |
|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
|
imagePage
|
imagePage | float |
imagePage |
|
|
imageWidth
|
imageWidth | float |
imageWidth |
|
|
imageX
|
imageX | float |
imageX |
|
|
imageY
|
imageY | float |
imageY |
Retornos
- Corpo
- document
Atualizar fluxo de trabalho
Atualizar um fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigató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 |
|
|
Identificação de usuário
|
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 |
ID da etapa |
|
|
stepType
|
stepType | string |
assinatura ou aprovação |
|
|
consentPageId
|
consentPageId | True | string |
ID da página de consentimento (nível de assinatura) associada a este destinatário |
|
email
|
True | string |
email do destinatário |
|
|
userId
|
userId | string |
referenciar um usuário le em vez de criar um destinatário em tempo real |
|
|
número de telefone
|
phoneNumber | string |
número de telefone celular do reicpient |
|
|
primeiro nome
|
firstName | string |
nome do destinatário |
|
|
sobrenome
|
lastName | string |
sobrenome do destinatário |
|
|
country
|
country | string |
código 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 |
|
|
requiredRecipients
|
requiredRecipients | number |
número mínimo de signatários que devem assinar para dar a próxima etapa |
|
|
validityPeriod
|
validityPeriod | number |
Duração da validade da etapa |
|
|
inviteperiod
|
inviteperiod | number |
frequência de lembretes de assinatura |
|
|
maxInvites
|
maxInvites | number |
número máximo de lembretes de assinatura |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
controla a entrega do documento assinado aos signatários |
|
|
allowComments
|
allowComments | boolean |
permite/proíbe comentários nesta etapa |
|
|
hideAttachments
|
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 |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Eventos de fluxo de trabalho que serão notificados para este observador |
|
|
email
|
string |
|
||
|
Status do fluxo de trabalho
|
workflowStatus | string |
Status atual do fluxo de trabalho |
|
|
data1
|
data1 | string |
primeiros metadados |
|
|
data2
|
data2 | string |
segundos metadados |
|
|
data3
|
data3 | string |
terceiros metadados |
|
|
data4
|
data4 | string |
quarta metadados |
|
|
data5
|
data5 | string |
quintos metadados |
|
|
data6
|
data6 | string |
sextos metadados |
|
|
data7
|
data7 | string |
sétimos metadados |
|
|
data8
|
data8 | string |
metadados de altura |
Retornos
- Corpo
- workflow
Atualizar layout de metadados
Atualizar um layout de metadados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do 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á desabilitado
|
isDisabled | boolean |
Se definido como true, o layout será desabilitado |
|
|
ranhura
|
slot | string |
Item de metadados (dados1 a data8) |
|
|
padrão
|
default | string |
Valor padrão de metadados neste layout |
|
|
opcional
|
optional | boolean |
Se verdadeiro, fornecer um valor não é obrigatório |
|
|
somente leitura
|
readonly | boolean |
Wether o valor pode ser substituído |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Se definido como true, o valor persistirá entre fluxos de trabalho |
Retornos
Layout de metadados
- Corpo
- layout
Atualizar perfil de assinatura
Atualizar um perfil de assinatura
Parâmetros
| Nome | Chave | Obrigató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 esse perfil de assinatura o padrão |
|
|
Está desabilitado
|
isDisabled | string |
Desabilitar esse perfil de assinatura |
|
|
Nome
|
name | string |
O nome do perfil de assinatura |
|
|
Tipo de assinatura
|
signatureType | string |
pades, xades,xadesDetached,xadesDetachedManifest,cades, helios |
|
|
Forçar a rolagem até 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, desabilitado, 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 de singatures |
|
|
Tamanho do texto da assinatura
|
pdfSignatureImageTextSize | number |
Tamanho do texto exibido nas almofadas de singatures |
Retornos
- Corpo
- signatureProfile
Baixar documentos de fluxo de trabalho
Baixar os documentos de fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
Retornos
- response
- binary
Baixar o arquivo de evidências
Baixar o arquivo de evidências do fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
|
Aceitar
|
Accept | True | string |
Aceitar |
Retornos
- response
- binary
Criar contato
Adicionar um contato à lista de contatos do usuário atual
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
userId | True | string |
Usuário ao qual o contato pertence |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Email de contato
|
True | string |
Email de contato |
|
|
Número de telefone do contatct
|
phoneNumber | string |
número de telefone |
|
|
Nome do contato
|
firstName | True | string |
primeiro nome |
|
Sobrenome do contato
|
lastName | True | string |
sobrenome |
|
País de contato
|
country | string |
country |
Retornos
- Corpo
- contact
Criar documento
Criar um documento com base em partes criadas previamente
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho em questão |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
tipo de conteúdo
|
contentType | string |
tipo de conteúdo |
|
|
filename
|
filename | string |
filename |
|
|
hash
|
hash | string |
hash |
|
|
size
|
size | integer |
size |
|
|
signatureProfileId
|
signatureProfileId | string |
O perfil de assinatura deste documento |
Retornos
- Corpo
- document
Criar fluxo de trabalho
Criar um fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Identificação de usuário
|
userId | True | string |
ID do usuário do ownner 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 |
ID da etapa |
|
|
stepType
|
stepType | string |
assinatura ou aprovação |
|
|
consentPageId
|
consentPageId | True | string |
ID da página de consentimento (nível de assinatura) associada a este destinatário |
|
email
|
True | string |
email do destinatário |
|
|
userId
|
userId | string |
referenciar um usuário le em vez de criar um destinatário em tempo real |
|
|
número de telefone
|
phoneNumber | string |
número de telefone celular do reicpient |
|
|
primeiro nome
|
firstName | string |
nome do destinatário |
|
|
sobrenome
|
lastName | string |
sobrenome do destinatário |
|
|
country
|
country | string |
código 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 |
|
|
requiredRecipients
|
requiredRecipients | number |
número mínimo de signatários que devem assinar para dar a próxima etapa |
|
|
validityPeriod
|
validityPeriod | number |
Duração da validade da etapa |
|
|
inviteperiod
|
inviteperiod | number |
frequência de lembretes de assinatura |
|
|
maxInvites
|
maxInvites | number |
número máximo de lembretes de assinatura |
|
|
sendDownloadLink
|
sendDownloadLink | boolean |
controla a entrega do documento assinado aos signatários |
|
|
allowComments
|
allowComments | boolean |
permite/proíbe comentários nesta etapa |
|
|
hideAttachments
|
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 |
|
|
notifiedEvents
|
notifiedEvents | array of string |
Eventos de fluxo de trabalho que serão notificados para este observador |
|
|
email
|
string |
Email 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 |
|
|
data1
|
data1 | string |
Primeiros metadados |
|
|
data2
|
data2 | string |
Segundo metadados |
|
|
data3
|
data3 | string |
Terceiros metadados |
|
|
data4
|
data4 | string |
Quarto metadados |
|
|
data5
|
data5 | string |
Quinto metadados |
|
|
data6
|
data6 | string |
Sexto metadados |
|
|
data7
|
data7 | string |
Sétimos metadados |
|
|
data8
|
data8 | string |
Metadados heighth |
Retornos
- Corpo
- workflow
Criar layout de metadados
Criar um layout de metadados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do 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á desabilitado
|
isDisabled | boolean |
Se definido como true, o layout será desabilitado |
|
|
ranhura
|
slot | string |
Item de metadados (dados1 a data8) |
|
|
padrão
|
default | string |
Valor padrão de metadados neste layout |
|
|
opcional
|
optional | boolean |
Se verdadeiro, fornecer um valor não é obrigatório |
|
|
somente leitura
|
readonly | boolean |
Wether o valor pode ser substituído |
|
|
rememberLastValue
|
rememberLastValue | boolean |
Se definido como true, o valor persistirá entre fluxos de trabalho |
Retornos
Layout de metadados
- Corpo
- layout
Criar parte
Criar uma parte do documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho em questão |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Disposição do cotent
|
Content-Disposition | True | string |
Content-Dispotion |
|
Criar Documento
|
createDocuments | string |
Criar um documento a partir desta parte |
|
|
Ignorar anexos
|
ignoreAttachments | string |
Anexos serão ignorados |
|
|
ID do perfil de assinatura
|
signatureProfileId | string |
Parte considerada como um anexo se omitida |
|
|
Descompacte
|
unzip | string |
Descompactar arquivos |
|
|
Pdf para PdfA
|
pdf2pdfa | string |
Converter pdf em pdf/A |
|
|
Documento
|
document | True | binary |
Os dados de arquivo carregados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
documents | array of document |
Documentos criados |
|
ignoredAttachments
|
ignoredAttachments | integer |
ignoredAttachments |
|
Partes
|
parts | array of part |
Partes |
Criar perfil de assinatura
Criar um perfil de assinatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Inquilino
|
tenantId | True | string |
ID do locatário |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
É Padrão
|
isDefault | True | string |
Torna esse perfil de assinatura o padrão |
|
Está desabilitado
|
isDisabled | string |
Desabilitar esse 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,xadesDetached,xadesDetachedManifest,cades, helios |
|
Forçar a rolagem até 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, desabilitado, 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 de singatures |
|
|
Tamanho do texto da assinatura
|
pdfSignatureImageTextSize | number |
Tamanho do texto exibido nas almofadas de singatures |
Retornos
- Corpo
- signatureProfile
Excluir contato
Remover contato da lista de contects do usuário atual
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
ID do contato |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
Retornos
- Corpo
- contact
Excluir documento
Excluir um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Retornos
- Corpo
- document
Excluir fluxo de trabalho
Excluir um fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho a ser excluído |
Retornos
- Corpo
- workflow
Pesquisar contatos
Pesquisar contatos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar por texto |
|
|
Pesquisar email
|
items.email | string |
Pesquisar por email |
|
|
Pesquisar número de telefone
|
items.phoneNumber | string |
Pesquisar por número de telefone |
|
|
Nome da pesquisa
|
items.fisrtName | string |
Pesquisar pelo nome |
|
|
Sobrenome da pesquisa
|
items.lastName | string |
Pesquisar por sobrenome |
|
|
País de pesquisa
|
items.country | string |
Pesquisar por país |
|
|
Itens por página
|
itemsPerPage | number |
Número de itens por página na resposta |
|
|
Índice de página
|
pageIndex | number |
Índice da página retornada |
Retornos
- Corpo
- contacts
Pesquisar documentos
Pesquisar documentos
Parâmetros
| Nome | Chave | Obrigató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 usuários |
|
|
Pesquisar usuário
|
items.userId | string |
Pesquisar por proprietário |
|
|
ID do fluxo de trabalho de pesquisa
|
items.workflowId | string |
Pesquisar por ID de fluxo de trabalho |
|
|
Nome do fluxo de trabalho de pesquisa
|
items.workflowName | string |
Pesquisar por nome de fluxo de trabalho |
|
|
Pesquisar metadados 1
|
items.data1 | string |
Pesquisar por valor de metadados 1 |
|
|
Metadados de pesquisa 2
|
items.data2 | string |
Pesquisar por valor de metadados 2 |
|
|
Pesquisar metadados 3
|
items.data3 | string |
Pesquisar por valor de metadados 3 |
|
|
Pesquisar metadados 4
|
items.data4 | string |
Pesquisar por valor de metadados 4 |
|
|
Metadados de pesquisa 5
|
items.data5 | string |
Pesquisar por valor de metadados 5 |
|
|
Pesquisar metadados 6
|
items.data6 | string |
Pesquisar por valor de metadados 6 |
|
|
Pesquisar metadados 7
|
items.data7 | string |
Pesquisar por valor de metadados 7 |
|
|
Metadados de pesquisa 8
|
items.data8 | string |
Pesquisar por valor de metadados 8 |
|
|
Perfil de assinatura de pesquisa
|
items.signatureProfileId | string |
Pesquisar por perfil de assinatura |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisar por data de criação |
|
|
Data da atualização da pesquisa
|
items.updated | string |
Pesquisar pela data da última atualização |
|
|
Classificar por
|
sortBy | string |
O campo usado para classificar 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 de página
|
pageIndex | string |
Índice da página retornada |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | documents |
Pesquisar fluxos de trabalho
Pesquisar fluxos de trabalho
Parâmetros
| Nome | Chave | Obrigató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 usuários |
|
|
Pesquisar usuário
|
items.userId | string |
Pesquisar por proprietário |
|
|
Pesquisar email
|
items.email | string |
Pesquisar por email do proprietário |
|
|
Nome da pesquisa
|
items.firstname | string |
Pesquisar pelo nome do proprietário |
|
|
Sobrenome da pesquisa
|
items.lastname | string |
Pesquisar pelo sobrenome do proprietário |
|
|
Status da pesquisa
|
items.workflowStatus | string |
Pesquisar por status de fluxo de trabalho |
|
|
Pesquisar metadados 1
|
items.data1 | string |
Pesquisar por valor de metadados 1 |
|
|
Metadados de pesquisa 2
|
items.data2 | string |
Pesquisar por valor de metadados 2 |
|
|
Pesquisar metadados 3
|
items.data3 | string |
Pesquisar por valor de metadados 3 |
|
|
Pesquisar metadados 4
|
items.data4 | string |
Pesquisar por valor de metadados 4 |
|
|
Metadados de pesquisa 5
|
items.data5 | string |
Pesquisar por valor de metadados 5 |
|
|
Pesquisar metadados 6
|
items.data6 | string |
Pesquisar por valor de metadados 6 |
|
|
Pesquisar metadados 7
|
items.data7 | string |
Pesquisar por valor de metadados 7 |
|
|
Metadados de pesquisa 8
|
items.data8 | string |
Pesquisar por valor de metadados 8 |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisar por data de criação |
|
|
Data da atualização da pesquisa
|
items.updated | string |
Pesquisar pela data da última atualização |
|
|
Data de início da pesquisa
|
items.started | string |
Pesquisar por data de início |
|
|
Classificar por
|
sortBy | string |
O campo usado para classificar 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 de página
|
pageIndex | string |
Índice da página retornada |
Retornos
- Corpo
- workflows
Pesquisar layouts de metadados
Pesquisar layouts de fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Pesquisa desabilitada
|
items.isDisabled | string |
Pesquisar layouts desabilitados |
|
|
Nome de pesquisa
|
items.name | string |
Pesquisar por nome de layout |
|
|
Metadados de pesquisa
|
items.dataConfigurations.slot | string |
Pesquisar pela presença de metadados |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisar por data de criação |
|
|
Data da atualização da pesquisa
|
items.updated | string |
Pesquisar pela data da última atualização |
|
|
Classificar por
|
sortBy | string |
O campo usado para classificar 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 de página
|
pageIndex | string |
Índice da página retornada |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | layouts |
Pesquisar perfis de assinatura
Pesquisar perfis de assinatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Padrão de pesquisa
|
items.isDefault | string |
Pesquisar perfis de assinatura padrão |
|
|
Pesquisa desabilitada
|
items.isDisabled | string |
Pesquisar perfis de assinatura desabilitados |
|
|
Nome de pesquisa
|
items.name | string |
Pesquisar por nome de perfil de assinatura |
|
|
Pesquisar o tipo de documento.
|
items.documentType | string |
Pesquisar 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 |
Pesquisar por data de criação |
|
|
Data da atualização da pesquisa
|
items.updated | string |
Pesquisar pela data da última atualização |
|
|
Classificar por
|
sortBy | string |
O campo usado para classificar 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 de página
|
pageIndex | string |
Índice da página retornada |
Retornos
- Corpo
- signatureProfiles
Página Recuperar consentimento
Recuperar informações da página de consentimento da ID da página de consentimento
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
- Corpo
- consentPage
Páginas de consentimento da pesquisa
Páginas de consentimento da pesquisa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Pesquisar texto
|
text | string |
Pesquisar texto |
|
|
Padrão de pesquisa
|
items.isDefault | string |
Pesquisar página de consentimento padrão |
|
|
Pesquisa desabilitada
|
items.isDisabled | string |
Pesquisar páginas de consentimento desabilitadas |
|
|
Nome de pesquisa
|
items.name | string |
Pesquisar pelo nome da página de consentimento |
|
|
Tipo de etapa de pesquisa
|
items.stepType | string |
Pesquisar por tipo de etapa |
|
|
Pesquisar id do cliente
|
items.clientId | string |
Pesquisar por ID do cliente |
|
|
Data de criação da pesquisa
|
items.created | string |
Pesquisar por data de criação |
|
|
Data da atualização da pesquisa
|
items.updated | string |
Pesquisar pela data da última atualização |
|
|
Classificar por
|
sortBy | string |
O campo no qual classificar 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 de página
|
pageIndex | string |
Índice da página retornada |
Retornos
- Corpo
- consentPages
Recuperar contato
Recuperar informações de contato da ID de contato
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de contato
|
contactId | True | string |
ID do contato |
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
Retornos
- Corpo
- contact
Recuperar documento
Recuperar um documento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento |
Retornos
- Corpo
- document
Recuperar fluxo de trabalho
Recuperar fluxo de trabalho da ID do fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
Retornos
- Corpo
- workflow
Recuperar layout de metadados
Recuperar um layout de fluxo de trabalho
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Layout Id
|
layoutId | True | string |
ID do layout |
Retornos
Layout de metadados
- Corpo
- layout
Recuperar mapeamento de metadados
Recuperar o mapeamento de metadados do locatário especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Inquilino
|
tenantId | True | string |
ID do locatário |
Retornos
- Corpo
- dataMapping
Recuperar-me
Recuperar perfil de assinatura
Recuperar um perfil de assinatura
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do perfil de assinatura
|
spId | True | string |
ID do perfil de assinatura |
Retornos
- Corpo
- signatureProfile
Recuperar url de página constent
Criar e recuperar a URL da página de consentimento para um destinatário
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do fluxo de trabalho
|
workflowId | True | string |
ID do fluxo de trabalho |
|
Email do destinatário
|
recipientEmail | string |
Email do destinatário em questão |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
A URL da página de consentimento do destinatário em questão
|
inviteUrl | string |
A URL da página de consentimento do destinatário em questão |
Definições
consentPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
allowOrganization
|
allowOrganization | boolean |
Permite o uso de organizações |
|
authenticateUser
|
authenticateUser | boolean |
Impõe a autenticação do signatário |
|
clientId
|
clientId | string |
ID do cliente |
|
criadas
|
created | number |
Data de criação |
|
emUrl
|
emUrl | string |
URL do gerenciador de evidências |
|
hideDownloads
|
hideDownloads | boolean |
Os links de download de documentos não são reprodutos em páginas de consentimento |
|
hideMobileQrCode
|
hideMobileQrCode | boolean |
Oculta os códigos QR em páginas constent |
|
id
|
id | string |
A ID da página de consentimento |
|
isCountryRequired
|
isCountryRequired | boolean |
Torna o país obrigatório nas informações dos signatários |
|
está desabilitado
|
isDisabled | boolean |
A página de consentimento está desabilitada |
|
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 |
|
secondaryColor
|
secondaryColor | string |
Cor secundária da página de consentimento |
|
sharedPassphrase
|
sharedPassphrase | string |
Frase secreta 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 do Inquilino |
|
tsaUrl
|
tsaUrl | string |
Url de autoridade de carimbo de data/hora |
|
atualizado
|
updated | number |
Data da última modificação |
|
verifyEmail
|
verifyEmail | boolean |
Se definido como tue, os signatários receberão OTPs por emails |
|
verifyPhoneNumber
|
verifyPhoneNumber | boolean |
Se definido como true, os signatários receberão OTPs por mensagens de texto |
consentPages
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of consentPage |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
contato
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
country
|
country | string |
País de contato |
|
criadas
|
created | integer |
Data de criação do contato |
|
email
|
string |
Email de contato |
|
|
primeiro nome
|
firstName | string |
Contate firstName |
|
id
|
id | string |
ID de contato |
|
sobrenome
|
lastName | string |
Contact lastName |
|
nome
|
name | string |
Nome do contato (nome + sobrenome)) |
|
número de telefone
|
phoneNumber | string |
Contate o número de telefone |
|
tenantId
|
tenantId | string |
ID do Inquilino |
|
atualizado
|
updated | integer |
Data da última modificação do contato |
|
userId
|
userId | string |
ID do proprietário do contato |
contacts
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of contact |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
dataMapping
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
descrição
|
data1.description | string |
Descrição de metadados |
|
nome
|
data1.name | string |
Nome dos metadados |
|
padrão
|
data1.pattern | string |
Padrão de metadados |
|
opções
|
data1.options | array of object |
opções |
|
value
|
data1.options.value | string |
Valor dos metadados |
|
tipo
|
data1.type | string |
tipo |
|
descrição
|
data2.description | string |
Descrição de metadados |
|
nome
|
data2.name | string |
Nome dos metadados |
|
padrão
|
data2.pattern | string |
Padrão de metadados |
|
opções
|
data2.options | array of object |
opções |
|
value
|
data2.options.value | string |
Valor dos metadados |
|
tipo
|
data2.type | string |
tipo |
|
descrição
|
data3.description | string |
Descrição de metadados |
|
nome
|
data3.name | string |
Nome dos metadados |
|
padrão
|
data3.pattern | string |
Padrão de metadados |
|
opções
|
data3.options | array of object |
opções |
|
value
|
data3.options.value | string |
Valor dos metadados |
|
tipo
|
data3.type | string |
tipo |
|
descrição
|
data4.description | string |
Descrição de metadados |
|
nome
|
data4.name | string |
Nome dos metadados |
|
padrão
|
data4.pattern | string |
Padrão de metadados |
|
opções
|
data4.options | array of object |
opções |
|
value
|
data4.options.value | string |
Valor dos metadados |
|
tipo
|
data4.type | string |
tipo |
|
descrição
|
data5.description | string |
Descrição de metadados |
|
nome
|
data5.name | string |
Nome dos metadados |
|
padrão
|
data5.pattern | string |
Padrão de metadados |
|
opções
|
data5.options | array of object |
opções |
|
value
|
data5.options.value | string |
Valor dos metadados |
|
tipo
|
data5.type | string |
tipo |
|
descrição
|
data6.description | string |
Descrição de metadados |
|
nome
|
data6.name | string |
Nome dos metadados |
|
padrão
|
data6.pattern | string |
Padrão de metadados |
|
opções
|
data6.options | array of object |
opções |
|
value
|
data6.options.value | string |
Valor dos metadados |
|
tipo
|
data6.type | string |
tipo |
|
descrição
|
data7.description | string |
Descrição de metadados |
|
nome
|
data7.name | string |
Metadados |
|
padrão
|
data7.pattern | string |
Padrão de metadados |
|
opções
|
data7.options | array of object |
opções |
|
value
|
data7.options.value | string |
Metadados |
|
tipo
|
data7.type | string |
tipo |
|
descrição
|
data8.description | string |
Descrição de metadados |
|
nome
|
data8.name | string |
Nome dos metadados |
|
padrão
|
data8.pattern | string |
Padrão de metadados |
|
opções
|
data8.options | array of object |
opções |
|
value
|
data8.options.value | string |
Valor dos metadados |
|
tipo
|
data8.type | string |
tipo |
documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
criadas
|
created | integer |
Data de criação |
|
groupId
|
groupId | string |
Id fo o grupo do proprietário do documento |
|
id
|
id | string |
ID do documento |
|
Partes
|
parts | array of part |
Partes |
|
pdfSignatureFields
|
pdfSignatureFields | array of pdfSigField |
pdfSignatureFields |
|
signatureProfileId
|
signatureProfileId | string |
ID do perfil de assinatura do documento |
|
tenantId
|
tenantId | string |
ID do locatário |
|
atualizado
|
updated | integer |
Data da última modificação |
|
userId
|
userId | string |
ID do usuário do proprietário do documento |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupos autorizados a exibir o documento |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
Lista de usuários permitidos para exibir 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 |
Documentos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of document |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
layout
Layout de metadados
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
criadas
|
created | number |
Data de criação |
|
id
|
id | string |
Layout Id |
|
está desabilitado
|
isDisabled | boolean |
Se definido como true, o layout foi desabilitado |
|
nome
|
name | string |
O nome do Layout |
|
tenantId
|
tenantId | string |
ID do locatário |
|
atualizado
|
updated | number |
Data da última modificação |
|
dataConfigurations
|
dataConfigurations | array of object | |
|
ranhura
|
dataConfigurations.slot | string |
Item de metadados (dados1 a data8) |
|
padrão
|
dataConfigurations.default | string |
Valor padrão de metadados neste layout |
|
opcional
|
dataConfigurations.optional | boolean |
Se for true, fornecer um valor para esses metadados não é obrigatório |
|
somente leitura
|
dataConfigurations.readonly | boolean |
Wether o valor pode ser substituído |
|
rememberLastValue
|
dataConfigurations.rememberLastValue | boolean |
Se definido como true, o valor persistirá entre fluxos de trabalho |
Layouts
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of object | |
|
criadas
|
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 retornada |
|
totalItems
|
totalItems | number |
Número total de itens relacionados à solicitação |
part
Parte do documento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo de conteúdo
|
contentType | string |
tipo de conteúdo |
|
filename
|
filename | string |
filename |
|
hash
|
hash | string |
hash |
|
size
|
size | integer |
size |
pdfSigField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
imageHeight
|
imageHeight | float |
imageHeight |
|
imagePage
|
imagePage | float |
imagePage |
|
imageWidth
|
imageWidth | float |
imageWidth |
|
imageX
|
imageX | float |
imageX |
|
imageY
|
imageY | float |
imageY |
signatureProfile
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
criadas
|
created | number |
Data de criação |
|
documentType
|
documentType | string |
Tipo de documentos |
|
forceScrollDocument
|
forceScrollDocument | boolean |
Forçar o signatário a rolar até a parte inferior do documento |
|
id
|
id | string |
a ID do perfil de assinatura |
|
isDefault
|
isDefault | boolean |
Torna esse perfil de assinatura o padrão |
|
está desabilitado
|
isDisabled | boolean |
Desabilitar esse perfil de assinatura |
|
nome
|
name | string |
O nome do perfil de assinatura |
|
pdfSignatureImageText
|
pdfSignatureImageText | string |
Texto exibido em blocos de assinaturas |
|
pdfSignatureImageTextColor
|
pdfSignatureImageTextColor | string |
Cor do texto exibido nas almofadas de singatures |
|
pdfSignatureImageTextSize
|
pdfSignatureImageTextSize | number |
Tamanho do texto exibido nas almofadas de singatures |
|
pdfVisibleSignatureMode
|
pdfVisibleSignatureMode | string |
Modo de assinatura visível (permitido, desabilitado, noImage) |
|
Tipo de assinatura
|
signatureType | string |
pades, xades, xadesDetached, xadesDetachedManifest, cades, helios |
|
tenantId
|
tenantId | string |
ID do Inquilino |
|
atualizado
|
updated | number |
Data da última modificação |
signatureProfiles
| Nome | 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 retornada |
|
totalItems
|
totalItems | number |
Número total de itens relacionados à solicitação |
usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
approveAllowed
|
approveAllowed | boolean |
Se definido como true, o usuário poderá aprovar documentos |
|
country
|
country | string |
País do usuário |
|
criadas
|
created | integer |
Data de criação |
|
email
|
string |
Email do usuário |
|
|
primeiro nome
|
firstName | string |
FirstName do usuário |
|
groupId
|
groupId | string |
ID do grupo do usuário |
|
id
|
id | string |
ID do usuário |
|
está desabilitado
|
isDisabled | boolean |
Se for true, o usuário será desabilitado |
|
lastLogin
|
lastLogin | integer |
A última data de logon do usuário |
|
sobrenome
|
lastName | string |
LastName do usuário |
|
nome
|
name | string |
Nome (nome + sobrenome) do usuário |
|
organizationTitles
|
organizationTitles | array of |
As funções do usuário em suas organizações |
|
número de telefone
|
phoneNumber | string |
Número de telefone do usuário |
|
signAllowed
|
signAllowed | boolean |
Se definido como true, o usuário poderá assinar documentos |
|
assunto
|
subject | string |
O código de subkect interno do usuário |
|
tenantId
|
tenantId | string |
ID do locatário |
|
atualizado
|
updated | integer |
Data da última modificação |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupo no qual o usuário pode atuar como um observador |
fluxo de trabalho
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
criadas
|
created | integer |
criadas |
|
currentRecipientEmails
|
currentRecipientEmails | array of |
currentRecipientEmails |
|
currentRecipientUsers
|
currentRecipientUsers | array of |
currentRecipientUsers |
|
data1
|
data1 | string |
Metadados 1 |
|
data2
|
data2 | string |
Metadados 2 |
|
data3
|
data3 | string |
Metadados 3 |
|
data4
|
data4 | string |
Metadados 4 |
|
data5
|
data5 | string |
Metadados 5 |
|
data6
|
data6 | string |
Metadados 6 |
|
data7
|
data7 | string |
Metadados 7 |
|
data8
|
data8 | string |
Metadados 8 |
|
descrição
|
description | string |
Descrição do fluxo de trabalho |
|
email
|
string |
Email do proprietário do fluxo de trabalho |
|
|
primeiro nome
|
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 |
|
logs
|
logs | array of |
Logs de itens do wokflow |
|
nome
|
name | string |
Nome (nome + sobrenome) do proprietário do fluxo de trabalho |
|
notifiedEvents
|
notifiedEvents | array of string |
Lis de eventos notificados pelo fluxo de trabalho |
|
progresso
|
progress | integer |
Progresso do fluxo de trabalho em porcentagens |
|
etapas
|
steps | array of object |
etapas |
|
allowComments
|
steps.allowComments | boolean |
Permite/proíbe comentários interativos permitidos na etapa |
|
hideAttachments
|
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 da etapa |
|
invitePeriod
|
steps.invitePeriod | integer |
invitePeriod |
|
isFinished
|
steps.isFinished | boolean |
isFinished |
|
isStarted
|
steps.isStarted | boolean |
isStarted |
|
logs
|
steps.logs | array of |
logs |
|
maxInvites
|
steps.maxInvites | integer |
maxInvites |
|
destinatários
|
steps.recipients | array of object |
destinatários |
|
consentPageId
|
steps.recipients.consentPageId | string |
consentPageId |
|
country
|
steps.recipients.country | string |
country |
|
email
|
steps.recipients.email | string |
|
|
primeiro nome
|
steps.recipients.firstName | string |
primeiro nome |
|
sobrenome
|
steps.recipients.lastName | string |
sobrenome |
|
número de telefone
|
steps.recipients.phoneNumber | string |
número de telefone |
|
userId
|
steps.recipients.userId | string |
userId |
|
requiredRecipients
|
steps.requiredRecipients | integer |
requiredRecipients |
|
sendDownloadLink
|
steps.sendDownloadLink | boolean |
sendDownloadLink |
|
stepType
|
steps.stepType | string |
stepType |
|
validityPeriod
|
steps.validityPeriod | integer |
validityPeriod |
|
tenantId
|
tenantId | string |
tenantId |
|
atualizado
|
updated | integer |
atualizado |
|
userId
|
userId | string |
userId |
|
viewAuthorizedGroups
|
viewAuthorizedGroups | array of string |
Lista de grupos em que os usuários podem atuar como observadores |
|
viewAuthorizedUsers
|
viewAuthorizedUsers | array of string |
viewAuthorizedUsers |
|
watchers
|
watchers | array of object |
watchers |
|
email
|
watchers.email | string |
|
|
notifiedEvents
|
watchers.notifiedEvents | array of string |
notifiedEvents |
|
userId
|
watchers.userId | string |
userId |
|
workflowStatus
|
workflowStatus | string |
workflowStatus |
workflows
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of workflow |
items |
|
itemsPerPage
|
itemsPerPage | integer |
itemsPerPage |
|
pageIndex
|
pageIndex | integer |
pageIndex |
|
totalItems
|
totalItems | integer |
totalItems |
binário
Esse é o tipo de dados básico 'binary'.