Assinaturas eletrônicas conectivas
O Connective eSignatures é uma solução de assinatura digital de renome que oferece uma vasta quantidade de métodos de assinatura e conformidade com as regulamentações (internacionais) mais rigorosas. O eSignatures permite transformar qualquer processo baseado em papel em um fluxo digital de ponta a ponta com uma experiência de usuário incomparável. Simplifique o processo de assinatura exatamente como você deseja e envie, assine e rastreie todos os tipos de documentos diretamente de seus aplicativos de negócios favoritos. Junte-se a mais de 500 clientes satisfeitos.
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 Conectivo |
| URL | https://connective.eu/contact-support/ |
| service@connective.eu |
| Metadados do conector | |
|---|---|
| Editora | Conectivo |
| Sítio Web | https://www.connective.eu |
| Política de privacidade | https://connective.eu/privacy-policy/ |
| Categorias | Operações de TI; Produtividade |
A Connective, especialista em assinaturas digitais, serviços de identidade e geração inteligente de documentos, disponibilizou o Connective eSignatures Connector for Power Automate para uso. O Connector permite que as empresas encaminhem documentos que exigem uma assinatura digital diretamente de seus aplicativos favoritos do Microsoft 365 – do Microsoft Teams ao Word, SharePoint, Dynamics, OneDrive e muitos outros.
Como começar a usar o conector
Para começar a fazer uso do conector, entre em contato com seu gerente de relacionamento na Connective ou acesse nossa página de contato em nosso site para receber as credenciais.
Esta página irá detalhar melhor as diferentes ações disponíveis, bem como fornecer informações sobre as diferentes formas como essas ações podem ser implementadas.
Não hesite em dar uma olhada em nosso site de documentação para obter mais informações ou entrar em contato com a equipe de suporte através do formulário de contato de suporte ou caixa de correio de suporte: service@connective.eu
Está disponível um glossário para explicar os diferentes termos utilizados nesta documentação
Ações
O conector Connective eSignatures é baseado na API v3 de eSignatures. A API de assinaturas eletrônicas é uma API REST que permite que aplicativos externos se integrem e usem os recursos listados neste documento para criar e gerenciar fluxos de assinatura.
As ações disponíveis podem ser agrupadas em diferentes grupos
| Grupo de Ação | Ações disponíveis |
|---|---|
| Carregar documentos | Criar pacote |
| Adicionar documento ao pacote | |
| Obter locais de assinatura | |
| Definir informações do processo | |
| Definir status do pacote | |
| Criar Pacote Instantâneo | |
| Recuperando o status de um documento | Obter status do pacote |
| Obter lista de pacotes | |
| Ações diversas | Ignorar signatários |
| Download do Pacote | |
| Extensão de expiração do pacote | |
| Enviar lembrete de pacote | |
| Excluir pacote | |
| Recuperando a prova de auditoria | Recuperar provas de auditoria de pacote |
| Recuperar provas de auditoria de documentos | |
| Recuperar provas de auditoria de pacote com ID de correlação | |
| Recuperar provas de auditoria de documentos com ID de correlação | |
| Adicionar prova de uma fonte externa |
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 |
|---|---|---|---|
| URL do ambiente de eSignatures conectivas | cadeia (de caracteres) | URL para o seu ambiente Connective eSignatures, por exemplo. esignatures.connective.eu | Verdade |
| Nome de usuário da API | securestring | Nome de usuário da API para acessar a API | Verdade |
| Senha da API | securestring | Senha da API para acessar a API | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar documento ao pacote |
Esta chamada adicionará um documento a um pacote existente. |
| Adicionar prova de fonte externa |
Essa chamada permite que os usuários da API adicionem provas extras de uma fonte externa a um local em um documento. |
| Carimbo de data/hora de expiração |
Um pacote pode ter o status Expirado quando um pacote passou um valor para o parâmetro ExpiryTimestamp na chamada Create Package. Esse pacote não pode mais ser assinado. |
| Comprovante de auditoria de pacote com ID de documento |
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote estiver totalmente assinado. O mesmo se aplica a um documento: só funciona quando o pacote que o contém está totalmente assinado. |
| Criar pacote |
Esta chamada cria um pacote vazio, permitindo que documentos sejam adicionados a ele |
| Criar Pacote Instantâneo |
Esta chamada cria um pacote com um único documento e o prepara instantaneamente para assinatura |
| Definir informações do processo |
Este método de webservice atualiza as pessoas envolvidas no processo (partes interessadas) e atribui-lhes as etapas que precisam ser tomadas. |
| Definir status do pacote |
Por meio da chamada set Package Status, você pode alterar o status de um pacote. |
| Download da Prova de Auditoria de Correlação de Documentos |
As ids de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures. |
| Download da Prova de Auditoria de Correlação de Pacotes |
As ids de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures. |
| Download do documento do pacote |
Os documentos assinados em um pacote podem ser baixados um a um por um sistema externo usando esta chamada. Cada documento será baixado como um PDF ou como um fluxo de arquivo XML, dependendo do valor do parâmetro DocumentType. |
| Download do Pacote |
O pacote que contém os documentos assinados pode ser descarregado por um sistema externo através desta chamada. |
| Enviar lembretes de pacote |
A política da empresa pode exigir que um documento seja tratado dentro de um determinado período de tempo. Acionar a chamada "enviar lembretes" procurará todas as pessoas que não assinaram e enviará uma notificação extra como lembrete. |
| Excluir pacote |
O eSignatures não exclui automaticamente os pacotes do banco de dados depois que eles atingem um estado final. Eles são armazenados indefinidamente. Para excluir pacotes do banco de dados, os usuários podem usar a chamada Excluir pacote. |
| Ignorar signatários |
Esta chamada ignora todos os signatários que ainda não assinaram e define seu status como "Ignorado", o que resulta na marcação do pacote completo como "Concluído". |
| Lista de Pacotes |
Obter uma lista de pacotes com seu status atual |
| Obter locais de assinatura |
Esta chamada fornece uma visão geral de todos os locais de assinatura dentro dos documentos dentro de um pacote. |
| Obter status do pacote |
Recupera o estado atual do pacote e seus documentos. |
| Prova de auditoria de pacote |
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote estiver totalmente assinado. O mesmo se aplica a um documento: só funciona quando o pacote que o contém está totalmente assinado. |
Adicionar documento ao pacote
Esta chamada adicionará um documento a um pacote existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador do pacote.
|
PackageId | True | string |
ID Único do Pacote |
|
Documento
|
Document | string |
Documento anexado em formato codificado base64. |
|
|
Linguagem do documento
|
DocumentLanguage | string |
Idioma a utilizar nos textos de assinatura. |
|
|
Nome do Documento
|
DocumentName | string |
Nome do documento a mostrar no Portal de Assinaturas Eletrónicas. |
|
|
Número da página
|
PageNumber | integer |
Número da página na qual adicionar um local de assinatura |
|
|
Largura
|
Width | string |
Largura |
|
|
Altura
|
Height | string |
Altura |
|
|
Esquerda
|
Left | string |
Posição à esquerda da página |
|
|
Início
|
Top | string |
Posição no topo da página |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Referência exclusiva a um campo de assinatura, marcador de texto ou campo de texto. |
|
|
CorrelationId
|
CorrelationId | string |
Id que indica quais documentos dentro deste pacote estão correlacionados com documentos que foram assinados no passado em outros pacotes. |
|
|
DocumentType
|
DocumentType | string |
Tipo de documento que será assinado. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Referência dada pelo aplicativo chamador. |
|
|
ErrorCode
|
ErrorCode | string |
Código de erro com informações variáveis. |
|
|
Message
|
Message | string |
Texto de detalhe da mensagem de erro, não localizado |
|
|
Representação
|
Representation | string |
Documento de representação anexado em formato base64. Estes devem ser dados PDF. |
|
|
Tipo de Representação
|
RepresentationType | string |
Tipo de documento de representação. |
|
|
Tipo de alvo
|
TargetType | string |
O TargetType define se uma conversão extra para PDF/A precisa ser feita antes da assinatura. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
DocumentId | string |
ID exclusivo para o documento |
|
CriaçãoTimestamp
|
CreationTimestamp | string |
Data e hora em que o fluxo foi criado. Formato: AAAA-MM-DDThh:mm:ss+zz:zz |
|
Localizações
|
Locations | array of object |
Representa um local possível para uma assinatura |
|
Id
|
Locations.Id | string |
ID exclusivo para este local |
|
Etiqueta
|
Locations.Label | string |
Rótulo detetado ou especificado |
|
Número da página
|
Locations.PageNumber | integer |
A página em que o local foi encontrado. |
Adicionar prova de fonte externa
Essa chamada permite que os usuários da API adicionem provas extras de uma fonte externa a um local em um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
A ID exclusiva do pacote
|
packageId | True | string |
A ID exclusiva do pacote |
|
Content
|
Content | string |
O próprio conteúdo da prova. |
|
|
LocalizaçãoId
|
LocationId | string |
Localização da assinatura para a qual o conteúdo da prova foi gerado. |
|
|
Nome
|
Name | string |
Nome da prova. |
|
|
Tipo
|
Type | string |
Uma chave "tipo" legível por máquina. Pode ser livremente escolhido. |
|
|
Description
|
Description | string |
Breve descrição da prova legível por humanos. |
|
|
Endereço IP
|
IpAddress | string |
Endereço IP do utilizador final da fonte externa à qual a prova foi adicionada. |
Carimbo de data/hora de expiração
Um pacote pode ter o status Expirado quando um pacote passou um valor para o parâmetro ExpiryTimestamp na chamada Create Package. Esse pacote não pode mais ser assinado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID Exclusivo do Pacote
|
id | True | string |
ID Exclusivo do Pacote |
|
Carimbo de data/hora de expiração
|
ExpiryTimestamp | date-time |
Comprovante de auditoria de pacote com ID de documento
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote estiver totalmente assinado. O mesmo se aplica a um documento: só funciona quando o pacote que o contém está totalmente assinado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID Exclusivo do Pacote
|
packageId | True | string |
ID Exclusivo do Pacote |
|
ID Exclusivo do Documento
|
documentId | True | string |
ID Exclusivo do Documento |
Devoluções
- Body
- Content
Criar pacote
Esta chamada cria um pacote vazio, permitindo que documentos sejam adicionados a ele
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de conteúdo
|
Content-Type | True | string |
Tipo de conteúdo |
|
Initiator
|
Initiator | string |
Endereço de e-mail de um utilizador registado. |
|
|
PackageName
|
PackageName | string |
Nome do pacote, visto no Portal de Assinaturas Eletrônicas e ao fazer o download como arquivo zip. |
|
|
CallBackUrl
|
CallBackUrl | string |
REST API URL que será chamada sempre que uma ação for concluída para este pacote. |
|
|
CorrelationId
|
CorrelationId | string |
Id que indica quais pacotes estão correlacionados. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
O «Código», que identifica um grupo de documentos no qual o pacote deve ser apresentado. |
|
|
Código do Tema
|
ThemeCode | string |
Tema que deve ser aplicado ao pacote |
|
|
BaixarArquivos não assinados
|
DownloadUnsignedFiles | boolean |
Este parâmetro determina se os pacotes podem ser baixados do WYSIWYS antes da assinatura. |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
Este parâmetro determina se os pacotes podem ser reatribuídos do WYSIWYS para outro aprovador/signatário. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Este parâmetro determina após quantos dias as URLs de ação devem expirar quando não são usadas. |
|
|
Carimbo de data/hora de expiração
|
ExpiryTimestamp | string |
A data e hora em que este pacote expira e não pode mais ser assinado. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Referência dada pelo aplicativo chamador. Este parâmetro não será utilizado pelo Portal de Assinaturas Eletrónicas. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Este campo está reservado para uso futuro. Ele pode ser usado para extensões específicas do cliente para integração com serviços de terceiros, como assinatura de cartão de débito. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL para o qual o utilizador final é redirecionado depois de todos os campos terem sido assinados com assinatura "face a face" ou quando todos os campos tiverem sido rejeitados. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST API URL que será chamada quando um usuário final solicitar ser notificado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificador exclusivo do pacote. |
|
CriaçãoTimestamp
|
CreationTimestamp | string |
Data e hora em que o pacote foi criado de acordo com o servidor. |
Criar Pacote Instantâneo
Esta chamada cria um pacote com um único documento e o prepara instantaneamente para assinatura
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Documento
|
Document | byte |
Documento anexado em formato codificado base64. Obrigatório, a menos que o formato Multipart seja usado. |
|
|
Linguagem do documento
|
DocumentLanguage | string |
Idioma a utilizar nos textos de assinatura. Atualmente suportado: en, nl, de, fr, es. |
|
|
Nome do Documento
|
DocumentName | string |
Nome do documento e do pacote a indicar no Portal de Assinaturas Eletrónicas. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
Endereço de e-mail de um utilizador registado |
|
|
Tipo
|
Type | string |
Signatário / Recetor |
|
|
OrderIndex
|
OrderIndex | integer |
Esse número especifica em que ordem os atores precisam executar sua ação. |
|
|
Número da página
|
PageNumber | integer |
Número da página na qual adicionar um local de assinatura |
|
|
Largura
|
Width | string |
Largura |
|
|
Altura
|
Height | string |
Altura |
|
|
Esquerda
|
Left | string |
Posição à esquerda da página |
|
|
Início
|
Top | string |
Posição no topo da página |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Referência exclusiva a um campo de assinatura, marcador de texto ou campo de texto. |
|
|
Tipo de assinatura
|
SigningType | string |
O tipo de assinatura usado na sessão deste ator. |
|
|
Tipos de Compromisso
|
CommitmentTypes | array of string |
Um ou mais OIDs de tipos de compromisso. Só pode ser passado quando a política de assinatura é usada. |
|
|
MandatodSignerValidation
|
MandatedSignerValidation | string |
Tipo de validação a ser executada durante o eID outro cartão inteligente, ou sessão de assinatura itsme. |
|
|
MandatodSignerIds
|
MandatedSignerIds | array of string |
Define qual eID ou outros cartões inteligentes podem assinar durante esta sessão. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Assinatura de detalhes da política para a assinatura. |
|
|
Número de telefone
|
Phonenumber | string |
Número de telefone para receber uma OTP SMS. |
|
|
RedirectUrl
|
RedirectUrl | string |
URL para o qual o usuário final é redirecionado após a assinatura. |
|
|
EnviarNotificações
|
SendNotifications | boolean |
As assinaturas eletrônicas podem enviar e-mails para todas as pessoas que estão autorizadas a assinar. |
|
|
Funções de usuário
|
UserRoles | array of string |
Função ou função do signatário. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Aviso Legal |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Texto de aviso legal personalizado no caso de nenhum dos três avisos legais predefinidos se aplicar. |
|
|
Endereço de Email
|
EmailAddress | string |
Endereço de Email |
|
|
Primeiro Nome
|
FirstName | string |
Primeiro Nome |
|
|
Apelido
|
LastName | string |
Apelido |
|
|
Data de Nascimento
|
BirthDate | string |
Data de Nascimento |
|
|
Linguagem
|
Language | string |
Linguagem |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
REST API URL que será chamada sempre que uma ação for concluída para este pacote |
|
|
CorrelationId
|
CorrelationId | string |
Id que indica quais pacotes ou documentos estão correlacionados |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
O «Código», que identifica um grupo de documentos no qual o documento deve figurar |
|
|
Código do Tema
|
ThemeCode | string |
Tema que deve ser aplicado ao pacote |
|
|
BaixarArquivos não assinados
|
DownloadUnsignedFiles | boolean |
Este parâmetro determina se os pacotes podem ser baixados do WYSIWYS antes da assinatura |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
Este parâmetro determina se os pacotes podem ser reatribuídos do WYSIWYS para outro aprovador/signatário. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Este parâmetro determina após quantos dias as URLs de ação devem expirar quando não são usadas. |
|
|
Carimbo de data/hora de expiração
|
ExpiryTimestamp | string |
Referência dada pelo aplicativo chamador. Este parâmetro não será utilizado pelo Portal de Assinaturas Eletrónicas |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Referência dada pelo aplicativo chamador, este parâmetro não será usado pelo Portal de Assinaturas Eletrônicas |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Referência dada pelo aplicativo chamador, este parâmetro não será usado pelo Portal de Assinaturas Eletrônicas |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL para o qual o utilizador final é redirecionado depois de todos os campos terem sido assinados com assinatura "face a face" ou quando todos os campos tiverem sido rejeitados. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST API URL que será chamada quando um usuário final solicitar ser notificado. Se nenhum URL for fornecido, nenhum retorno de chamada será executado |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Como lidar com PDFs contendo pequenas falhas |
|
|
Representação
|
Representation | string |
Documento de representação anexado em formato base64 |
|
|
Tipo de Representação
|
RepresentationType | string |
Tipo do documento de representação, deve estar presente quando a representação é preenchida. Apenas "application/pdf" é suportado. |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
O modelo configurado no portal fornecerá todas as informações necessárias |
|
|
Tipo de alvo
|
TargetType | string |
O TargetType define se uma conversão extra para PDF/A precisa ser feita antes de assinar |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificador exclusivo do pacote. |
|
CriaçãoTimestamp
|
CreationTimestamp | string |
Data e hora em que o pacote foi criado de acordo com o servidor. |
Definir informações do processo
Este método de webservice atualiza as pessoas envolvidas no processo (partes interessadas) e atribui-lhes as etapas que precisam ser tomadas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID Exclusivo do Pacote
|
id | True | string |
ID Exclusivo do Pacote |
|
Tipo
|
Type | string |
Tipo |
|
|
OrderIndex
|
OrderIndex | string |
Esse número especifica em que ordem os atores precisam executar sua ação. |
|
|
LocalizaçãoIds
|
LocationIds | array of string |
Os identificadores de localização onde uma assinatura deve ser colocada por essa pessoa. |
|
|
Tipo de assinatura
|
SigningType | string |
O tipo de assinatura usado na sessão deste ator. |
|
|
Tipos de Compromisso
|
CommitmentTypes | array of string |
Um ou mais OIDs de tipos de compromisso. Só pode ser passado quando a política de assinatura é usada. |
|
|
MandatodSignerValidation
|
MandatedSignerValidation | string |
Tipo de validação a ser executada durante o eID outro cartão inteligente, ou sessão de assinatura itsme. |
|
|
MandatodSignerIds
|
MandatedSignerIds | array of string |
Define qual eID ou outros cartões inteligentes podem assinar durante esta sessão. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Assinatura de detalhes da política para a assinatura. |
|
|
Número de telefone
|
Phonenumber | string |
Número de telefone para receber uma OTP SMS. |
|
|
URL de redirecionamento
|
RedirectURL | string |
Url para a qual o usuário final é redirecionado após assinar ou rejeitar. O redirecionamento ocorre imediatamente após a assinatura ou rejeição. |
|
|
EnviarNotificações
|
SendNotifications | boolean |
As assinaturas eletrônicas podem enviar e-mails para os atores cuja ação é necessária, como assinar |
|
|
Funções de usuário
|
UserRoles | array of string |
Os identificadores de localização onde uma assinatura deve ser colocada por essa pessoa. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Os 3 valores apontarão para os 3 avisos legais incorporados no aplicativo. Estes podem ser alterados no Índice de Configuração. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Texto do aviso legal personalizado no caso de nenhum dos três avisos legais predefinidos se aplicar |
|
|
Endereço de Email
|
EmailAddress | string |
Endereço de E-mail |
|
|
Primeiro Nome
|
FirstName | string |
Nome Próprio |
|
|
Linguagem
|
Language | string |
Idioma da interface do usuário desta parte interessada. Atualmente suportado: en, nl, de, fr, es. |
|
|
Apelido
|
LastName | string |
Apelido |
|
|
Data de Nascimento
|
BirthDate | string |
Data de nascimento no formato: AAAA-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Referência dada pelo aplicativo chamador. Este parâmetro não será utilizado pelo Portal de Assinaturas Eletrónicas. |
Definir status do pacote
Por meio da chamada set Package Status, você pode alterar o status de um pacote.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo para o pacote de assinatura
|
Id | True | string |
ID exclusivo para o pacote de assinatura |
|
Situação
|
Status | string |
Pendente / Revogado |
Devoluções
Descrição do pacote mostrado ao usuário do Portal de assinaturas eletrônicas como nome de arquivo.
- Body
- PackageStatus
Download da Prova de Auditoria de Correlação de Documentos
As ids de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de correlação.
|
correlationId | True | string |
O identificador de correlação. |
Devoluções
- Body
- Content
Download da Prova de Auditoria de Correlação de Pacotes
As ids de correlação são usadas para rastrear pacotes ou documentos em várias passagens pelo aplicativo eSignatures.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O identificador de correlação.
|
correlationId | True | string |
O identificador de correlação. |
Devoluções
- Body
- Content
Download do documento do pacote
Os documentos assinados em um pacote podem ser baixados um a um por um sistema externo usando esta chamada. Cada documento será baixado como um PDF ou como um fluxo de arquivo XML, dependendo do valor do parâmetro DocumentType.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo para o pacote de assinatura
|
id | True | string |
ID exclusivo para o pacote de assinatura |
|
ID exclusivo do documento contido no pacote
|
documentId | True | string |
ID exclusivo do documento contido no pacote |
Devoluções
- response
- binary
Download do Pacote
O pacote que contém os documentos assinados pode ser descarregado por um sistema externo através desta chamada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID Exclusivo do Pacote
|
id | True | string |
ID Exclusivo do Pacote |
Devoluções
- response
- binary
Enviar lembretes de pacote
A política da empresa pode exigir que um documento seja tratado dentro de um determinado período de tempo. Acionar a chamada "enviar lembretes" procurará todas as pessoas que não assinaram e enviará uma notificação extra como lembrete.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID Exclusivo do Pacote
|
PackageId | True | string |
ID Exclusivo do Pacote |
Excluir pacote
O eSignatures não exclui automaticamente os pacotes do banco de dados depois que eles atingem um estado final. Eles são armazenados indefinidamente. Para excluir pacotes do banco de dados, os usuários podem usar a chamada Excluir pacote.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID Exclusivo do Pacote
|
id | True | string |
ID Exclusivo do Pacote |
Ignorar signatários
Esta chamada ignora todos os signatários que ainda não assinaram e define seu status como "Ignorado", o que resulta na marcação do pacote completo como "Concluído".
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID único do pacote
|
PackageId | True | string |
ID único do pacote |
Lista de Pacotes
Obter uma lista de pacotes com seu status atual
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
O token de continuação / guid para saber qual página retornar.
|
ContinuationToken | string |
O token de continuação / guid para saber qual página retornar. DEVE ESTAR VAZIO ou o token retornado de uma chamada ANTERIOR. |
|
|
Obtém ou define a quantidade máxima.
|
MaxQuantity | integer |
Obtém ou define a quantidade máxima. |
|
|
Obtém ou define o campo de classificação.
|
SortField | string |
Obtém ou define o campo de classificação. |
|
|
Obtém ou define o campo de classificação.
|
SortOrder | string |
Obtém ou define o campo de classificação. |
|
|
Obtém ou define a data de criação anterior.
|
CreatedBeforeDate | string |
Obtém ou define a data de criação anterior. |
|
|
Obtém ou define o status.
|
Status | string |
Obtém ou define o status. |
|
|
Obtém ou define a data de criação após a data.
|
createdAfterDate | string |
Obtém ou define a data de criação após a data. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ContinuationToken
|
ContinuationToken | string |
ContinuationToken |
|
QuantidadeMáx.
|
MaxQuantity | integer |
QuantidadeMáx. |
|
Total
|
Total | integer |
Total |
|
Itens
|
Items | array of Package |
Obter locais de assinatura
Esta chamada fornece uma visão geral de todos os locais de assinatura dentro dos documentos dentro de um pacote.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do campo de assinatura
|
Id | True | string |
ID do campo de assinatura |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Documents
|
Documents | array of object | |
|
ID do documento
|
Documents.DocumentId | string |
ID exclusivo para o documento |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Referência externa para identificação. Certifique-se de usar um valor exclusivo. |
|
Localizações
|
Documents.Locations | array of object |
Representa um local possível para uma assinatura |
|
Id
|
Documents.Locations.Id | string |
ID único para este local. |
|
Etiqueta
|
Documents.Locations.Label | string |
Valor inserido como parâmetro Request. |
|
Número da página
|
Documents.Locations.PageNumber | integer |
Número da página em que a assinatura pode ser encontrada. |
Obter status do pacote
Recupera o estado atual do pacote e seus documentos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID exclusivo para o pacote de assinatura
|
Id | True | string |
ID exclusivo para o pacote de assinatura |
Devoluções
Descrição do pacote mostrado ao usuário do Portal de assinaturas eletrônicas como nome de arquivo.
- Body
- PackageStatus
Prova de auditoria de pacote
O xml de provas de auditoria de um pacote pode ser recuperado quando o pacote estiver totalmente assinado. O mesmo se aplica a um documento: só funciona quando o pacote que o contém está totalmente assinado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID Exclusivo do Pacote
|
packageId | True | string |
ID Exclusivo do Pacote |
Devoluções
- Body
- Content
Definições
Package
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
Id | string | |
|
Status do pacote
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Detalhes para cada um dos documentos do pacote
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
DocumentId | string |
ID único do documento |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Retorna a referência externa deste documento como ele foi passado através da chamada Adicionar documento ao pacote. |
|
Nome do Documento
|
DocumentName | string |
Nome do documento |
|
DocumentType
|
DocumentType | string |
Tipo de documento dentro do pacote. |
Status do pacote
Descrição do pacote mostrado ao usuário do Portal de assinaturas eletrônicas como nome de arquivo.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Descrição do pacote mostrado ao usuário do Portal de assinaturas eletrônicas como nome de arquivo. |
|
CriaçãoTimestamp
|
CreationTimestamp | string |
Data e hora em que o pacote foi criado de acordo com o servidor. |
|
Initiator
|
Initiator | string |
Campo iniciador do pacote tal como foi passado no momento da criação. |
|
Carimbo de data/hora de expiração
|
ExpiryTimestamp | string |
Hora formatada em UTC em que o documento expira. Pode ser null. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Retorna a ID de referência externa do pacote como ele foi passado no momento da criação. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Link para o pacote que permite escolher entre todas as sessões de assinatura de uma só vez. |
|
Status do pacote
|
PackageStatus | string |
Situação da embalagem como um todo: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Detalhes para cada um dos documentos do pacote. |
|
Intervenientes
|
Stakeholders | array of object |
Detalhes para cada uma das pessoas que irão interagir com o pacote. |
|
Tipo
|
Stakeholders.Type | string |
Tipo de interessado: Pessoa, PersonGroup ou ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Nome do grupo de pessoas. Somente retornado se Type foi definido como PersonGroup na solicitação. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Código do grupo de contactos. Somente retornado se Type foi definido como ContactGroup na solicitação. |
|
Endereço de Email
|
Stakeholders.EmailAddress | string |
Endereço de e-mail do signatário. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Referência externa identificando essa pessoa no sistema externo. |
|
StakeholderId
|
Stakeholders.StakeholderId | string |
ID único. |
|
Actors
|
Stakeholders.Actors | array of object |
Detalhes de todas as etapas a serem tomadas. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
ID único para esta combinação de ação, partes interessadas e documento. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
URL que essa pessoa pode abrir para interagir com o pacote. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Matriz de URLs que as diferentes pessoas do PersonGroup ou ContactGroup podem abrir para interagir com o pacote. |
|
Endereço de Email
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Endereço de e-mail da pessoa. |
|
Endereço URL
|
Stakeholders.Actors.ActionUrls.Url | string |
URL que essa pessoa pode abrir para interagir com o pacote. |
|
Status do Ator
|
Stakeholders.Actors.ActorStatus | string |
Rascunho (o pacote tem status Rascunho) |
|
Tipo
|
Stakeholders.Actors.Type | string |
Signatário / Recetor |
|
ConcluídoPor
|
Stakeholders.Actors.CompletedBy | string |
O nome do usuário final que concluiu a ação. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Carimbo de data/hora do momento em que esta ação foi concluída. |
|
Reason
|
Stakeholders.Actors.Reason | string |
Retorna o texto inserido pela pessoa que alterou o status de um pacote para um estado final (por exemplo, uma rejeição). |
|
Localizações
|
Stakeholders.Actors.Locations | array of object |
Representa um possível local para uma assinatura. |
|
Id
|
Stakeholders.Actors.Locations.Id | string |
ID exclusivo para este local |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Retorna o tipo de assinatura que foi usado para assinar o documento. |
Content
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Carregamentos
|
uploads | array of object | |
|
carregamento
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
fim
|
uploads.upload.end | date-time | |
|
Assinaturas
|
uploads.upload.signatures | array of object | |
|
Provas
|
uploads.upload.signatures.proofs | array of object | |
|
nome
|
uploads.upload.signatures.proofs.proof.name | string | |
|
tipo
|
uploads.upload.signatures.proofs.proof.type | string | |
|
indexar
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
índices
|
uploads.indexes | array of object | |
|
identificador
|
uploads.indexes.index.identifier | boolean | |
|
conteúdo
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
packageId
|
uploads.packageId | string |
binário
Este é o tipo de dados básico 'binário'.