Partilhar via

Nitro Sign Enterprise Verificado (Pré-visualização)

O Nitro Sign Enterprise Verified é 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 NSEV 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.

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 Nitro
URL https://www.gonitro.com/support
Email service@gonitro.com
Metadados do conector
Editora Nitro Software Bélgica NV
Sítio Web https://www.gonitro.com
Política de privacidade https://www.gonitro.com/legal/privacy-policy
Categorias Operações de TI; Produtividade

Conector Verificado Nitro Sign Enterprise

A Nitro Software, especialista em Soluções de Documentos Inteligentes, disponibilizou o Conector Verificado Empresarial Nitro Sign para 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. Nitro Sign Enterprise Verified - anteriormente conhecido como Nitro Sign Premium e Connective eSignatures.

Pré-requisitos

Para começar a usar o conector, é necessária uma assinatura existente do Nitro Sign Enterprise Verified . Entre em contato com seu contato na Nitro Software ou acesse nossa página de ajuda e suporte em nosso site para receber as credenciais.

Documentation

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 de nossa página de ajuda e suporte ou caixa de correio de suporte: mailto:service@gonitro.com. A documentação da API também está disponível no formato Postman.

Está disponível um glossário para explicar os diferentes termos utilizados nesta documentação

Operações suportadas

O conector Nitro Sign Enterprise Verified é baseado na API v4 do Nitro Sign Enterprise Verified. A API é 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
Packages Obter todos os pacotes
Obter pacote por ID
Obter status do pacote
Criar um novo pacote (padrão ou instantâneo)
Excluir um pacote por ID
Atualizar o status de um pacote
Obter a data de validade de um pacote
Atualizar a data de validade de um pacote
Ignorar signatários
Enviar lembretes
Download de um pacote
Baixe a trilha de auditoria de um pacote
Documents Adicionar um documento a um pacote
Baixar um documento assinado de um pacote
Intervenientes Excluir uma parte interessada por ID
Obter todas as partes interessadas de um pacote
Adicionar uma parte interessada a um pacote
Processo Obter todas as etapas do processo de um pacote
Processo Adicionar uma etapa no processo do pacote
Processo Substituir etapas do processo de um pacote
Processo Obter todas as ações de uma etapa do processo
Processo Excluir uma etapa do processo e todos os seus atores
Processo Adicionar um ator a uma etapa do processo
Processo Obter todas as ações na etapa do processo atual
Other Obter todos os idiomas ativados no aplicativo
Obter todos os temas que podem ser atribuídos a um pacote
Obter todos os grupos de documentos aos quais um pacote pode ser atribuído
Obter todos os métodos de assinatura configurados

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
Nitro Sign anfitrião cadeia (de caracteres) host e caminho para o seu ambiente Nitro Sign, por exemplo, contoso.sign.gonitro.com/esig 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 um ator a uma etapa do processo

Adiciona um ator a uma etapa do processo.
Adicionar um documento a um pacote

Adiciona um documento a um pacote existente.
Adicionar uma etapa no processo do pacote

Adiciona um conjunto de ações ao processo do pacote.
Adicionar uma parte interessada a um pacote

Adiciona uma parte interessada ao pacote
Atualizar a data de validade de um pacote

Atualizar a data de validade de um pacote
Criar um novo pacote (padrão ou instantâneo)

Cria um novo pacote. Por padrão, o pacote é criado como um rascunho. Para criar um pacote instantâneo que esteja imediatamente pronto para assinatura, defina a status propriedade como Pending.

Observação: O POST /packages endpoint permite que você crie pacotes padrão e instantâneos.
Download do documento do pacote

Baixe um documento assinado de um pacote. Cada documento será descarregado sob a forma de ficheiro PDF ou XML.
Download do Pacote

Usado para baixar todos os documentos em um determinado pacote como um arquivo Zip.
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 por ID

Exclui um pacote por sua ID.
Excluir parte interessada por ID

Exclui uma parte interessada por sua ID.
Excluir uma etapa do processo e todos os seus atores

Exclui uma etapa do processo e todos os seus atores.
Faça o download da trilha de auditoria do pacote

Faça o download de uma trilha de auditoria assinada sobre o tempo de vida de um pacote.
Ignorar signatários

Esta chamada ignora todos os signatários que ainda não terminaram e define seu status como 'Ignorado', resultando no pacote completo sendo marcado como 'Concluído'.
Obtenha todas as etapas do processo

Obtém todas as ações que terão que ser executadas no pacote.
Obter a data de validade de uma embalagem

Recuperar a data de validade de um pacote
Obter pacote por ID

Recupera um pacote por sua ID.
Obter status do pacote

Recupera o estado atual do pacote.
Obter todas as ações de uma etapa do processo

Obtém um conjunto específico de ações que podem ser concluídas em paralelo a partir do processo.
Obter todas as ações na etapa do processo atual

Obtém o conjunto atual de ações que podem ser concluídas em paralelo.
Obter todas as partes interessadas de um pacote

Recupera as partes interessadas do pacote
Obter todos os pacotes

Obtém todos os pacotes, eles são classificados por creationDate
Recuperar todos os grupos de documentos aos quais os pacotes podem ser atribuídos

Recupera todos os grupos de documentos aos quais os pacotes podem ser atribuídos
Recuperar todos os idiomas habilitados no aplicativo

Recupera todos os idiomas habilitados no aplicativo
Recuperar todos os temas que podem ser atribuídos a um pacote

Recupera todos os temas que podem ser atribuídos a um pacote. Possível paginar o resultado fornecendo um MaxQuantity e um continuationToken
Retornar todos os métodos de assinatura atualmente configurados

Retorna todos os métodos de assinatura atualmente configurados
Status do pacote de atualização

Atualiza o status de um pacote.
Substituir etapas do processo de um pacote

Substitui todos os atores em um pacote usando uma matriz 2D onde cada conjunto de atores são ações que podem ser executadas em paralelo.

Adicionar um ator a uma etapa do processo

ID da Operação:
Process_StepPost

Adiciona um ator a uma etapa do processo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
O índice da etapa do processo
 stepIndex True integer

O índice da etapa do processo
Tipo
 Type True string

Tipo de ação que terá de ser executada num pacote
StakeholderId
 StakeholderId True string

Identificador de uma parte interessada no pacote
SuprimirNotificações
 SuppressNotifications boolean

Suprimir notificações para o ator
RedirectUrl
 RedirectUrl url

URL de redirecionamento após a conclusão da ação do ator
Id
 Id string

Identificador de um elemento existente. Se usado, todos os outros campos devem estar vazios.
Tipo
 Type string

O tipo de elemento
Referência Externa
 ExternalReference string

Referência externa para o pacote
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento
ID do documento
 DocumentId string

Identificador do documento no pacote
SigningMethods
 SigningMethods array of string
Nome
 Name string

O nome do aviso legal a ser adicionado ao campo de assinatura.
Content
 Content string

Conteúdo do aviso legal personalizado.
Linguagem
 Language string

Código ISO de 2 letras de um país (ISO 639-1)

Devoluções

Body
Response.Actor

Adicionar um documento a um pacote

ID da Operação:
Documents_AddToPackage

Adiciona um documento a um pacote existente.

Parâmetros

Name Chave Necessário Tipo Description
Identificador exclusivo do pacote
 packageId True string

Identificador exclusivo do pacote
Nome
 Name True string

Nome do documento
IsOptional
 IsOptional boolean

Indica se o documento deve ser opcional para assinatura
Linguagem
 Language True string

Código ISO de 2 letras de um país (ISO 639-1)
Referência Externa
 ExternalReference string

Referência externa para o pacote
ProofCorrelationId
 ProofCorrelationId string

Um identificador global único
Tipo de alvo
 TargetType string

Só funcionará quando o servidor estiver configurado para conversões de documentos.
TargetFormat
 TargetFormat string

O formato de destino define se uma conversão extra precisa ser feita.
PdfErrorHandling
 PdfErrorHandling string

Como lidar com PDFs contendo pequenas falhas
Tipo de conteúdo
 ContentType True string

Tipo MIME do documento
Base64Data
 Base64Data True byte

Conteúdo do documento codificado em Base64
Tipo
 Type True string

O tipo de elemento
Referência Externa
 ExternalReference string

Referência externa para o pacote
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento
SigningMethods
 SigningMethods array of string
Nome
 Name string

O nome do aviso legal a ser adicionado ao campo de assinatura.
Content
 Content string

Conteúdo do aviso legal personalizado.
Linguagem
 Language string

Código ISO de 2 letras de um país (ISO 639-1)

Devoluções

Body
Response.Document

Adicionar uma etapa no processo do pacote

ID da Operação:
Process_PostStep

Adiciona um conjunto de ações ao processo do pacote.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
Tipo
 Type True string

Tipo de ação que terá de ser executada num pacote
StakeholderId
 StakeholderId True string

Identificador de uma parte interessada no pacote
SuprimirNotificações
 SuppressNotifications boolean

Suprimir notificações para o ator
RedirectUrl
 RedirectUrl url

URL de redirecionamento após a conclusão da ação do ator
Id
 Id string

Identificador de um elemento existente. Se usado, todos os outros campos devem estar vazios.
Tipo
 Type string

O tipo de elemento
Referência Externa
 ExternalReference string

Referência externa para o pacote
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento
ID do documento
 DocumentId string

Identificador do documento no pacote
SigningMethods
 SigningMethods array of string
Nome
 Name string

O nome do aviso legal a ser adicionado ao campo de assinatura.
Content
 Content string

Conteúdo do aviso legal personalizado.
Linguagem
 Language string

Código ISO de 2 letras de um país (ISO 639-1)

Devoluções

Um conjunto de atores em uma etapa do processo.

response
array of Response.Actor

Adicionar uma parte interessada a um pacote

ID da Operação:
Packages_AddStakeholder

Adiciona uma parte interessada ao pacote

Parâmetros

Name Chave Necessário Tipo Description
Identificador exclusivo do pacote
 packageId True string

Identificador exclusivo do pacote
Tipo
 Type True string

O tipo de detentor de interesse
Referência Externa
 ExternalReference string

Referência externa para o pacote
Linguagem
 Language True string

Código ISO de 2 letras de um país (ISO 639-1)
Primeiro Nome
 FirstName string

Nome próprio da parte interessada
Apelido
 LastName True string

Apelido da parte interessada
Endereço de Email
 EmailAddress True email

Um endereço de e-mail
Data de Nascimento
 BirthDate date
Número de telefone
 PhoneNumber string

Um número de telefone
AdditionalProperties
 AdditionalProperties object

As propriedades adicionais configuráveis da parte interessada
Tipo
 Type True string

Tipo de ação que terá de ser executada num pacote
SuprimirNotificações
 SuppressNotifications boolean

Suprimir notificações para o ator
RedirectUrl
 RedirectUrl url

URL de redirecionamento após a conclusão da ação do ator
Tipo de redirecionamento
 RedirectType string
BackButtonUrl
 BackButtonUrl url

URL para o qual o usuário é enviado após fechar a sessão
Id
 Id string

Identificador de um elemento existente. Se usado, todos os outros campos devem estar vazios.
Tipo
 Type string

O tipo de elemento
Referência Externa
 ExternalReference string

Referência externa para o pacote
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento
ID do documento
 DocumentId string

Identificador do documento no pacote
SigningMethods
 SigningMethods array of string
Nome
 Name string

O nome do aviso legal a ser adicionado ao campo de assinatura.
Content
 Content string

Conteúdo do aviso legal personalizado.
Linguagem
 Language string

Código ISO de 2 letras de um país (ISO 639-1)

Devoluções

Body
Response.Stakeholder

Atualizar a data de validade de um pacote

ID da Operação:
Packages_PutExpiryDate

Atualizar a data de validade de um pacote

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
Carimbo de data/hora de expiração
 ExpiryTimestamp date-time

Um valor de data-hora no formato ISO 8601

Criar um novo pacote (padrão ou instantâneo)

ID da Operação:
Packages_CreatePackage

Cria um novo pacote. Por padrão, o pacote é criado como um rascunho. Para criar um pacote instantâneo que esteja imediatamente pronto para assinatura, defina a status propriedade como Pending.

Observação: O POST /packages endpoint permite que você crie pacotes padrão e instantâneos.

Parâmetros

Name Chave Necessário Tipo Description
Nome
 Name True string

Nome do pacote
Initiator
 Initiator True email

Um endereço de e-mail
Referência Externa
 ExternalReference string

Referência externa para o pacote
Situação
 Status string

O status do pacote criado.

  • Use "Draft" para criar um pacote padrão que pode ser modificado antes do envio.
  • Use "Pending" para criar um pacote instantâneo que esteja imediatamente pronto para assinatura.
DocumentGroupCode
 DocumentGroupCode string

Código do grupo de documentos para o pacote
Data de validade
 ExpiryDate date-time

Um valor de data-hora no formato ISO 8601
Nome
 Name True string

Nome do documento
IsOptional
 IsOptional boolean

Indica se o documento deve ser opcional para assinatura
Linguagem
 Language True string

Código ISO de 2 letras de um país (ISO 639-1)
Referência Externa
 ExternalReference string

Referência externa para o pacote
ProofCorrelationId
 ProofCorrelationId string

Um identificador global único
Tipo de alvo
 TargetType string

Só funcionará quando o servidor estiver configurado para conversões de documentos.
TargetFormat
 TargetFormat string

O formato de destino define se uma conversão extra precisa ser feita.
PdfErrorHandling
 PdfErrorHandling string

Como lidar com PDFs contendo pequenas falhas
Tipo de conteúdo
 ContentType True string

Tipo MIME do documento
Base64Data
 Base64Data True byte

Conteúdo do documento codificado em Base64
Tipo
 Type True string

O tipo de elemento
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento
SigningMethods
 SigningMethods array of string
Nome
 Name string

O nome do aviso legal a ser adicionado ao campo de assinatura.
Content
 Content string

Conteúdo do aviso legal personalizado.
Tipo
 Type True string

O tipo de detentor de interesse
Referência Externa
 ExternalReference string

Referência externa para o pacote
Linguagem
 Language True string

Código ISO de 2 letras de um país (ISO 639-1)
Primeiro Nome
 FirstName string

Nome próprio da parte interessada
Apelido
 LastName True string

Apelido da parte interessada
Endereço de Email
 EmailAddress True email

Um endereço de e-mail
Data de Nascimento
 BirthDate date
Número de telefone
 PhoneNumber string

Um número de telefone
AdditionalProperties
 AdditionalProperties object

As propriedades adicionais configuráveis da parte interessada
Tipo
 Type True string

Tipo de ação que terá de ser executada num pacote
SuprimirNotificações
 SuppressNotifications boolean

Suprimir notificações para o ator
RedirectUrl
 RedirectUrl url

URL de redirecionamento após a conclusão da ação do ator
Tipo de redirecionamento
 RedirectType string
BackButtonUrl
 BackButtonUrl url

URL para o qual o usuário é enviado após fechar a sessão
ProcessStep
 ProcessStep integer

O número da etapa do processo
DocumentIndex
 DocumentIndex True integer

Índice do documento no pacote (a partir de 0) - disponível apenas no ponto de extremidade Criar pacote
Tipo
 Type True string

O tipo de elemento
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento
SigningMethods
 SigningMethods True array of string
Nome
 Name string

O nome do aviso legal a ser adicionado ao campo de assinatura.
Content
 Content string

Conteúdo do aviso legal personalizado.
Código do Tema
 ThemeCode string

Identificador do tema para o pacote
CallBackUrl
 CallBackUrl url

URL para retorno de chamada após a execução de ações
NotificationCallBackUrl
 NotificationCallBackUrl url

URL para retorno de chamada quando um signatário solicita uma nova URL de assinatura
DefaultRedirectUrl
 DefaultRedirectUrl url

URL de redirecionamento após a conclusão da ação
F2fRedirectUrl
 F2fRedirectUrl url

URL de redirecionamento após assinatura presencial
IsUnsignedContentDownloadable
 IsUnsignedContentDownloadable boolean

Se o conteúdo não assinado pode ser baixado
IsReassignEnabled
 IsReassignEnabled boolean

Se a reatribuição está habilitada

Devoluções

Body
Response.Package.Get

Download do documento do pacote

ID da Operação:
Documents_DownloadDocumentFromPackage

Baixe um documento assinado de um pacote. Cada documento será descarregado sob a forma de ficheiro PDF ou XML.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
Identificador único do documento contido na embalagem
 documentId True string

Identificador único do documento contido na embalagem

Devoluções

response
binary

Download do Pacote

ID da Operação:
Packages_DownloadPackage

Usado para baixar todos os documentos em um determinado pacote como um arquivo Zip.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote

Devoluções

response
binary

Enviar lembretes de pacote

ID da Operação:
Packages_SendReminders

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
Identificador único do pacote
 packageId True string

Identificador único do pacote

Excluir pacote por ID

ID da Operação:
Packages_DeleteById

Exclui um pacote por sua ID.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote

Excluir parte interessada por ID

ID da Operação:
Stakeholder_DeleteById

Exclui uma parte interessada por sua ID.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
Identificador único da parte interessada
 stakeholderId True string

Identificador único da parte interessada

Excluir uma etapa do processo e todos os seus atores

ID da Operação:
Process_DeleteStep

Exclui uma etapa do processo e todos os seus atores.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
O índice da etapa do processo
 stepIndex True integer

O índice da etapa do processo

Faça o download da trilha de auditoria do pacote

ID da Operação:
Packages_DownloadAuditTrail

Faça o download de uma trilha de auditoria assinada sobre o tempo de vida de um pacote.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
Um código ISO de 2 letras (ISO 639-1)
 culture True string

Um código ISO de 2 letras (ISO 639-1)

Devoluções

response
binary

Ignorar signatários

ID da Operação:
Packages_SkipSigners

Esta chamada ignora todos os signatários que ainda não terminaram e define seu status como 'Ignorado', resultando no pacote completo sendo marcado como 'Concluído'.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote

Obtenha todas as etapas do processo

ID da Operação:
Process_Get

Obtém todas as ações que terão que ser executadas no pacote.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote

Devoluções

Name Caminho Tipo Description
array of array
items
 array of Response.Actor

Um conjunto de atores em uma etapa do processo.

Obter a data de validade de uma embalagem

ID da Operação:
Packages_GetExpiryDate

Recuperar a data de validade de um pacote

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote

Devoluções

Um valor de data-hora no formato ISO 8601

response
Common.DateTime

Obter pacote por ID

ID da Operação:
Packages_GetPackage

Recupera um pacote por sua ID.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote

Devoluções

Body
Response.Package.Get

Obter status do pacote

ID da Operação:
Packages_GetStatus

Recupera o estado atual do pacote.

Parâmetros

Name Chave Necessário Tipo Description
Identificador exclusivo do pacote
 packageId True string

Identificador exclusivo do pacote

Devoluções

Body
Response.Package.Status

Obter todas as ações de uma etapa do processo

ID da Operação:
Process_GetStep

Obtém um conjunto específico de ações que podem ser concluídas em paralelo a partir do processo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
O índice da etapa do processo
 stepIndex True integer

O índice da etapa do processo

Devoluções

Name Caminho Tipo Description
Itens
 Items array of Response.Actor

Obter todas as ações na etapa do processo atual

ID da Operação:
Process_GetCurrentStep

Obtém o conjunto atual de ações que podem ser concluídas em paralelo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote

Devoluções

Name Caminho Tipo Description
Itens
 Items array of Response.Actor

Obter todas as partes interessadas de um pacote

ID da Operação:
Packages_GetStakeholders

Recupera as partes interessadas do pacote

Parâmetros

Name Chave Necessário Tipo Description
Identificador exclusivo do pacote
 packageId True string

Identificador exclusivo do pacote

Devoluções

response
array of Response.Stakeholder

Obter todos os pacotes

ID da Operação:
Packages_Get

Obtém todos os pacotes, eles são classificados por creationDate

Parâmetros

Name Chave Necessário Tipo Description
O número da página a ser recuperado
 pageNumber integer

O número da página a ser recuperado
Número de itens por página
 pageSize integer

Número de itens por página
Pacotes de devolução criados antes desta data
 createdBefore date-time

Pacotes de devolução criados antes desta data
Devolver pacotes criados após esta data
 createdAfter date-time

Devolver pacotes criados após esta data
Status dos pacotes a serem filtrados
 status string

Status dos pacotes a serem filtrados
Código do grupo de documentos para filtrar pacotes
 documentGroupCode string

Código do grupo de documentos para filtrar pacotes
E-mail do iniciador do pacote para filtrar
 initiator email

E-mail do iniciador do pacote para filtrar
Nome do pacote a filtrar
 packageName string

Nome do pacote a filtrar
Referência externa a pacotes de filtros
 externalReference string

Referência externa a pacotes de filtros
Especificar como o resultado é classificado, o padrão é decrescente
 sort string

Especificar como o resultado é classificado, o padrão é decrescente

Devoluções

Name Caminho Tipo Description
Número da página
 PageNumber integer

Número de página atual
PageSize
 PageSize integer

Número de itens por página
TotalPages
 TotalPages integer

Número total de páginas
TotalItems
 TotalItems integer

Número total de itens
Itens
 Items array of Response.Package.Get

Recuperar todos os grupos de documentos aos quais os pacotes podem ser atribuídos

ID da Operação:
GetDocumentGroups

Recupera todos os grupos de documentos aos quais os pacotes podem ser atribuídos

Parâmetros

Name Chave Necessário Tipo Description
O nome (ou parte) do grupo de documentos a ser pesquisado
 name string

O nome (ou parte) do grupo de documentos a ser pesquisado

Devoluções

Name Caminho Tipo Description
Grupos de Documentos
 DocumentGroups array of object

A lista de grupos de documentos
Código
 DocumentGroups.Code string

O código do grupo de documentos
Nome
 DocumentGroups.Name string

O nome do grupo de documentos

Recuperar todos os idiomas habilitados no aplicativo

ID da Operação:
GetAllEnabledLanguages

Recupera todos os idiomas habilitados no aplicativo

Devoluções

Name Caminho Tipo Description
EnabledLanguages
 EnabledLanguages array of object

A lista de idiomas habilitados
Nome de Exibição
 EnabledLanguages.DisplayName string

O nome para exibição do idioma
NativeName
 EnabledLanguages.NativeName string

O nome nativo da língua
IsoCultureCode
 EnabledLanguages.IsoCultureCode string

O código ISO de 2 letras (ISO 639-1) da língua

Recuperar todos os temas que podem ser atribuídos a um pacote

ID da Operação:
GetAllThemes

Recupera todos os temas que podem ser atribuídos a um pacote. Possível paginar o resultado fornecendo um MaxQuantity e um continuationToken

Parâmetros

Name Chave Necessário Tipo Description
Token para obter o próximo conjunto de resultados
 continuationToken string

Token para obter o próximo conjunto de resultados
Quantidade máxima de resultados a devolver
 maxQuantity integer

Quantidade máxima de resultados a devolver
A ordem pela qual os resultados devem ser ordenados
 sortOrder string

A ordem pela qual os resultados devem ser ordenados
especificar em que campo ordenar
 sortField string

especificar em que campo ordenar

Devoluções

Name Caminho Tipo Description
ContinuationToken
 ContinuationToken string

Token para recuperar a próxima página de resultados
Itens
 Items array of object

A lista que contém os Temas
Código
 Items.Code string

O código do Tema
Nome
 Items.Name string

O nome do tema
QuantidadeMáx.
 MaxQuantity integer

O número máximo de resultados que serão devolvidos por pedido
Total
 Total integer

O número total de resultados.

Retornar todos os métodos de assinatura atualmente configurados

ID da Operação:
GetAllSigningMethods

Retorna todos os métodos de assinatura atualmente configurados

Parâmetros

Name Chave Necessário Tipo Description
Retornar apenas métodos de assinatura ativos/inativos
 isActive boolean

Retornar apenas métodos de assinatura ativos/inativos

Devoluções

response
array of ConfiguredSigningMethod

Status do pacote de atualização

ID da Operação:
Packages_UpdateStatus

Atualiza o status de um pacote.

Parâmetros

Name Chave Necessário Tipo Description
Identificador exclusivo do pacote
 packageId True string

Identificador exclusivo do pacote
body
 body True string

Substituir etapas do processo de um pacote

ID da Operação:
Process_Put

Substitui todos os atores em um pacote usando uma matriz 2D onde cada conjunto de atores são ações que podem ser executadas em paralelo.

Parâmetros

Name Chave Necessário Tipo Description
Identificador único do pacote
 packageId True string

Identificador único do pacote
Tipo
 Type True string

Tipo de ação que terá de ser executada num pacote
StakeholderId
 StakeholderId True string

Identificador de uma parte interessada no pacote
SuprimirNotificações
 SuppressNotifications boolean

Suprimir notificações para o ator
RedirectUrl
 RedirectUrl url

URL de redirecionamento após a conclusão da ação do ator
Id
 Id string

Identificador de um elemento existente. Se usado, todos os outros campos devem estar vazios.
Tipo
 Type string

O tipo de elemento
Referência Externa
 ExternalReference string

Referência externa para o pacote
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento
ID do documento
 DocumentId string

Identificador do documento no pacote
SigningMethods
 SigningMethods array of string
Nome
 Name string

O nome do aviso legal a ser adicionado ao campo de assinatura.
Content
 Content string

Conteúdo do aviso legal personalizado.
Linguagem
 Language string

Código ISO de 2 letras de um país (ISO 639-1)

Definições

ConfiguredSigningMethod

Um método de assinatura configurado em assinaturas eletrônicas

Name Caminho Tipo Description
IsActive
 IsActive boolean

Se o signingMethod pode ser usado para criar novos campos de assinatura
Nome
 Name string

O nome configurado do método de assinatura
DisplayNames
 DisplayNames object

O nome por idioma que será mostrado a um signatário
DisplayNamesInitiator
 DisplayNamesInitiator object

O nome por idioma que deve ser mostrado ao iniciador ao criar o pacote.
Descrições
 Descriptions object

Descrição do método de assinatura por idioma para fornecer mais informações sobre o método de assinatura durante a criação do pacote.
Propriedades necessárias
 RequiredProperties array of string

As propriedades necessárias para assinatura obrigatória
Pares de Teclas
 KeyPairs array of KeyPair

KeyPairs disponíveis que podem ser usados para assinar com este método

Par de chaves

representação de um par de chaves de assinatura

Name Caminho Tipo Description
Nome
 Name string

Nome do par de chaves
DisplayNames
 DisplayNames object

O nome por idioma que será mostrado a um iniciador

Common.Guid

Um identificador global único

Um identificador global único

string

Common.EmailAddress

Um endereço de e-mail

Um endereço de e-mail

email

Common.Language

Código ISO de 2 letras de um país (ISO 639-1)

Código ISO de 2 letras de um país (ISO 639-1)

string

Common.PhoneNumber

Um número de telefone

Um número de telefone

string

Common.ExternalReference

Referência externa para o pacote

Referência externa para o pacote

string

Common.AdditionalProperties

As propriedades adicionais configuráveis da parte interessada

Name Caminho Tipo Description
object

As propriedades adicionais configuráveis da parte interessada

Common.DateTime

Um valor de data-hora no formato ISO 8601

Um valor de data-hora no formato ISO 8601

date-time

Package.Status

O status do pacote

O status do pacote

string

Package.Name

Nome do pacote

Nome do pacote

string

Document.Name

Nome do documento

Nome do documento

string

Document.Status

O estatuto de um documento

O estatuto de um documento

string

Document.DocumentOptions

Define parâmetros opcionais do documento

Name Caminho Tipo Description
Tipo de alvo
 TargetType string

Só funcionará quando o servidor estiver configurado para conversões de documentos.
TargetFormat
 PdfOptions.TargetFormat string

O formato de destino define se uma conversão extra precisa ser feita.
PdfErrorHandling
 PdfOptions.PdfErrorHandling string

Como lidar com PDFs contendo pequenas falhas

Stakeholder.FirstName

Nome próprio da parte interessada

Nome próprio da parte interessada

string

Stakeholder.Sobrenome

Apelido da parte interessada

Apelido da parte interessada

string

Ator.Type

Tipo de ação que terá de ser executada num pacote

Tipo de ação que terá de ser executada num pacote

string

Ator.Status

O estatuto de um interveniente

O estatuto de um interveniente

string

Element.Type

O tipo de elemento

O tipo de elemento

string

Element.Status

O status de um elemento

O status de um elemento

string

Elemento.Localização

Name Caminho Tipo Description
Página
 Page integer

Número da página do documento
Início
 Top number

Posição superior em pixels
Esquerda
 Left number

Posição esquerda em pixels

Elemento.Dimensões

Name Caminho Tipo Description
Largura
 Width number

Largura do elemento
Altura
 Height number

Altura do elemento

Response.Package.Get

Name Caminho Tipo Description
Id
 Id Common.Guid

Um identificador global único
Nome
 Name Package.Name

Nome do pacote
Initiator
 Initiator Common.EmailAddress

Um endereço de e-mail
Referência Externa
 ExternalReference Common.ExternalReference

Referência externa para o pacote
Data de Criação
 CreationDate Common.DateTime

Um valor de data-hora no formato ISO 8601
Situação
 Status Package.Status

O status do pacote
Data de validade
 ExpiryDate Common.DateTime

Um valor de data-hora no formato ISO 8601
Documents
 Documents array of Response.Document
Intervenientes
 Stakeholders array of Response.Stakeholder

Resposta.Documento

Name Caminho Tipo Description
Id
 Id Common.Guid

Um identificador global único
Situação
 Status Document.Status

O estatuto de um documento
Opções de Documentos
 DocumentOptions Document.DocumentOptions

Define parâmetros opcionais do documento
Nome
 Name Document.Name

Nome do documento
Linguagem
 Language Common.Language

Código ISO de 2 letras de um país (ISO 639-1)
Referência Externa
 ExternalReference Common.ExternalReference

Referência externa para o pacote
ProofCorrelationId
 ProofCorrelationId Common.Guid

Um identificador global único

Resposta.Partes interessadas

Name Caminho Tipo Description
Tipo
 Type string

O tipo de detentor de interesse
Referência Externa
 ExternalReference Common.ExternalReference

Referência externa para o pacote
Id
 Id Common.Guid

Um identificador global único
Linguagem
 Language Common.Language

Código ISO de 2 letras de um país (ISO 639-1)
Primeiro Nome
 FirstName Stakeholder.FirstName

Nome próprio da parte interessada
Apelido
 LastName Stakeholder.LastName

Apelido da parte interessada
Endereço de Email
 EmailAddress Common.EmailAddress

Um endereço de e-mail
Data de Nascimento
 BirthDate date
Número de telefone
 PhoneNumber Common.PhoneNumber

Um número de telefone
AdditionalProperties
 AdditionalProperties Common.AdditionalProperties

As propriedades adicionais configuráveis da parte interessada
Actors
 Actors array of Response.Actor

Resposta.Ator

Name Caminho Tipo Description
Tipo
 Type Actor.Type

Tipo de ação que terá de ser executada num pacote
Id
 Id Common.Guid

Um identificador global único
StakeholderId
 StakeholderId Common.Guid

Um identificador global único
Situação
 Status Actor.Status

O estatuto de um interveniente
SuprimirNotificações
 SuppressNotifications boolean

Suprimir notificações para o ator
RedirectUrl
 RedirectUrl url

URL de redirecionamento após a conclusão da ação do ator
Elements
 Elements array of Response.Element

Response.Element

Name Caminho Tipo Description
Tipo
 Type Element.Type

O tipo de elemento
Id
 Id Common.Guid

Um identificador global único
ActorId
 ActorId Common.Guid

Um identificador global único
ID do documento
 DocumentId integer

Identificador do documento no pacote
Situação
 Status Element.Status

O status de um elemento
Referência Externa
 ExternalReference Common.ExternalReference

Referência externa para o pacote
Localização
 Location Element.Location
Dimensões
 Dimensions Element.Dimensions
SigningMethods
 SigningMethods array of string
UsedSigningMethod
 UsedSigningMethod string

O método de assinatura usado

Response.Package.Status

Name Caminho Tipo Description
Situação
 Status Package.Status

O status do pacote

binário

Este é o tipo de dados básico 'binário'.