RSign (Pré-visualização)

A RSign® é uma plataforma segura e legalmente vinculativa de assinatura eletrónica que simplifica os fluxos de trabalho dos documentos. Este conector permite aos utilizadores automatizar o envio de pedidos de assinatura, acompanhar o estado do envelope em tempo real e recuperar documentos assinados e certificados de assinatura concluídos. Aumenta a eficiência do negócio ao digitalizar a execução de documentos e garantir transações digitais seguras e rastreáveis.

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)
Power Apps	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)
Power Automate	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 RSign
URL	https://rsign.com/contact/questions
Email	support@rpost.com

Metadados do conector
Editora	RPost US Inc
Editora	RPost US Inc
Sítio Web	https://rpost.com/
Política de privacidade	https://rpost.com/legal-notices/privacy-notice
Categorias	Conteúdos e Ficheiros; Produtividade

Visão Geral do Conector Personalizado RSign

Nome do Conector: Descrição do RSign : O RSign® é uma plataforma de gestão de assinaturas eletrónicas e transações digitais para fluxos de trabalho documentais seguros, legalmente vinculativos e simplificados. Editora: RPost

1. Capacidades do Conector

O conector RSign® proporciona acesso a funções de assinatura eletrónica e gestão de documentos, permitindo aos utilizadores integrar fluxos de trabalho RSign diretamente nas suas soluções Power Platform (Power Automate, Power Apps e Logic Apps).

Ações Principais

Atualmente, o conector suporta as seguintes operações primárias:

• Obtenha AuthToken: Autentica o utilizador com base nas credenciais RSign® e recupera um token necessário (AuthToken) necessário para todas as chamadas API subsequentes.
• Envie o envelope usando um modelo: Envia um documento para assinatura eletrónica usando um modelo RSign® pré-configurado, mapeando os papéis do modelo para destinatários específicos.
• Envie o envelope usando uma regra: Envia um documento para assinatura eletrónica usando uma regra RSign® pré-configurada, permitindo que documentos sejam fornecidos como dados Base64 no corpo do pedido.
• Recuperar Informação do Modelo: Obtém detalhes sobre um modelo ou regra RSign® específica, incluindo documentos definidos e papéis do destinatário (RoleID).
• Recuperar o Estado do Envelope: Recupera o estado de um pedido de assinatura eletrónica usando o Código do Envelope.
• Recuperar Documentos do Envelope: Descarrega os documentos associados a um Código de Envelope (documentos originais e/ou finais assinados).

2. Configuração da Autenticação

O conector RSign® utiliza um esquema de autenticação personalizado que requer uma chamada bem-sucedida à Get AuthToken ação antes de executar qualquer outra ação.

Ação de Autenticação (Get AuthToken)

Esta ação requer as seguintes credenciais, que devem ser obtidas na plataforma RSign®:

Nome do parâmetro	Tipo	Description	Visibilidade
ReferenceKey	cadeia (de caracteres)	A Chave de Referência associada à tua conta RPost®.	Importante
EmailId	cadeia (de caracteres)	O endereço de email da sua conta RSign®.	Importante
Password	palavra-passe	A palavra-passe da tua conta RSign®.	Importante

Utilizando o AuthToken

A Get AuthToken ação devolve um AuthToken no corpo de resposta. Este token deve então ser passado em chamadas de API subsequentes para todas as outras ações suportadas.

Nota: Tem AuthToken um tempo de expiração (AuthTokenExpires) e deve ser gerido dentro da lógica de fluxo ou aplicação para garantir que um token novo é usado quando o existente expira.

3. Pré-requisitos

Para usar com sucesso este conector personalizado RSign®, os utilizadores devem cumprir os seguintes requisitos:

• Licença RSign® Válida: Os utilizadores devem ter uma licença RSign® ativa e válida.
• Acesso API: A conta RSign® associada às credenciais fornecidas deve ter a funcionalidade de Acesso à API ativada e paga. Esta funcionalidade é necessária para gerar e ReferenceKey utilizar com sucesso o conector RSign®.

Se não cumpre atualmente estes requisitos ou não tem a certeza da configuração atual da sua conta RSign®, por favor contacte o seu representante da RPost®.

4. Notas Importantes para a Integração

Utilização de Modelos e Regras

• Código Modelo / Código de Regras: Ambas Send Envelope as ações requerem um TemplateCode (ou Código de Regras) que identifique os campos pré-configurados de documento e assinatura no RSign®.
• Mapeamento de Papéis: Ao enviar um envelope, o TemplateRoleRecipientMapping array deve ser preenchido. O RoleID de cada destinatário deve ser recuperado primeiro usando a Retrieve Template Information ação. Isto garante que os destinatários são corretamente mapeados para os campos de assinatura definidos no modelo.

Manuseamento de Documentos

• Envie o envelope usando uma regra: Esta ação exige que o conteúdo do documento seja passado como uma cadeia codificada em Base64 (DocumentBase64Data).
• Recuperar Documentos do Envelope: Os documentos são devolvidos dentro do corpo de resposta como strings Base64 (ByteArray). O fluxo consumidor tem de decodificar esta cadeia para guardar o ficheiro.

Tratamento de erros

Todas as ações retornam informações de estado no corpo da resposta, incluindo:

• StatusCode (inteiro)
• StatusMessage (cadeia de caracteres)
• Message (cadeia de caracteres)

Os utilizadores devem implementar verificação de erros com base no StatusCode para garantir a execução bem-sucedida da operação.

Limites de Limitação

Nome	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Enviar envelope usando um modelo	Envia um pedido eSign a destinatários selecionados usando o modelo RSign indicado.
Enviar Envelope usando uma Regra	Envia um pedido de eSign a destinatários selecionados usando a regra RSign indicada.
Obtenha o AuthToken	Devolve um AuthToken para ser usado em todas as outras ações suportadas pelo RSign.
Recuperar Documentos do Envelope	Recupera a parte dos documentos de um envelope com base no seu Código de Envelope. Irá recuperar os documentos originais e/ou os Documentos Finais Assinados, dependendo do estado do envelope.
Recuperar Informação do Modelo	Recupera a informação sobre um Modelo ou Regra com base no seu Código. Entre as informações devolvidas encontra-se o nome do Modelo, documentos e funções definidas.
Recuperar o Estado do Envelope	Recupera o estado de um Envelope com base no seu Código de Envelope. Pode escolher um relatório detalhado ou resumido.

Enviar envelope usando um modelo

ID da Operação:

SendEnvelopeFromTemplate

Envia um pedido eSign a destinatários selecionados usando o modelo RSign indicado.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Token de autenticação	AuthToken	True	string	AuthToken recuperado da ação "Obter AuthToken".
Código do modelo	TemplateCode	True	string	ID do modelo a utilizar.
Chave do aplicativo	AppKey		string	Identificador único de um sistema que utiliza o conector. Por favor, solicite-a ao Suporte da RPost®.
ID da Função	RoleID	True	string	ID de função para o destinatário. Retirado da ação "Recuperar Informação do Modelo".
DestinatárioE-mail	RecipientEmail	True	string	Endereço de e-mail do destinatário.
Nome do destinatário	RecipientName	True	string	Nome do destinatário.
Telemóvel	Mobile		string	Número de telemóvel do destinatário. Se o seu modelo não o exigir, deixe em branco.

Regressos

Nome	Percurso	Tipo	Descrição
Código do envelope	EnvelopeCode	string	Identificação do envelope.
Transparência Mudou a Mensagem	TransparencyChangedMessage	string	Transparência Mudança de Mensagem.
Mensagem API baseada em linguagem	LanguageBasedApiMessge	string	Mensagem API baseada na linguagem.
ID do Destinatário Prepreenchido	PrefillRecipientId	string	ID do destinatário preenchido.
Página de Navegação de Envio de Publicações	PostSendingNavigationPage	string	Site para onde o destinatário será redirecionado assim que terminar de assinar o envelope.
A Nova Interface de Signer Está Ativada	IsNewSignerUIEnabled	boolean	A interface do novo signante está ativada?
Código de estado	StatusCode	integer	Código de estado de resposta.
Mensagem de status	StatusMessage	string	Mensagem de status da resposta.
Message	Message	string	Descrição do estado da resposta.
Envelope Id	EnvelopeId	string	ID interno do envelope gerado.
URL do Documento de Assinatura	SignDoumentUrl	string	URL global para a assinatura do envelope.
Lista de Recipientes	RecipientList	array of object	Detalhes dos Recipientes
Nome do destinatário	RecipientList.RecipientName	string	Nome do destinatário parte do presente envelope.
E-mail do destinatário	RecipientList.RecipientEmail	string	O endereço de email do destinatário faz parte do envelope presente.
Encomenda	RecipientList.Order	integer	Ordem em que o destinatário precisa de aceder para preencher o envelope.
Tipo	RecipientList.Type	string	Tipo de destinatário parte do envelope presente. Os valores possíveis são: Signer e Prefill.
Modo de Entrega	RecipientList.DeliveryMode	integer	Indica o canal através do qual o pedido de assinatura e o código de acesso foram enviados ao destinatário.
Código de marcação	RecipientList.DialCode	string	O código de discagem do país onde o pedido de assinatura e o código de acesso foram enviados.
Código do país	RecipientList.CountryCode	string	Código do país onde foram enviados o pedido de assinatura e o código de acesso.
Número de telemóvel	RecipientList.Mobile	string	Número de telemóvel do destinatário.
Modo Móvel	RecipientList.MobileMode	integer	Indica o canal móvel através do qual o pedido de assinatura e o código de acesso foram enviados ao destinatário.
URL de assinatura	RecipientList.SigningUrl	string	URL para ser usado pelo destinatário para aceder e assinar o envelope.
Lista Suspensa de Códigos de Discagem	DialCodeDropdownList	string	Lista de códigos de discagem.
Ativar Mensagem para Mobile	EnableMessageToMobile	string	Ativar a Mensagem para o Telemóvel.

Enviar Envelope usando uma Regra

ID da Operação:

SendEnvelopeFromRule

Envia um pedido de eSign a destinatários selecionados usando a regra RSign indicada.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Token de autenticação	AuthToken	True	string	AuthToken recuperado da ação "Obter AuthToken".
Código do modelo	TemplateCode	True	string	ID da Regra a ser utilizada.
Nome	Name	True	string	Nome do Documento. Inclua a extensão (exemplo: Agreement.docx).
DocumentBase64Data	DocumentBase64Data	True	string	Documento a enviar em formato Base64.
Chave do aplicativo	AppKey		string	Identificador único de um sistema que utiliza o conector. Por favor, solicite-a ao Suporte da RPost®.
ID da Função	RoleID	True	string	ID de função para o destinatário. Retirado da ação "Recuperar Informação do Modelo".
DestinatárioE-mail	RecipientEmail	True	string	Endereço de e-mail do destinatário.
Nome do destinatário	RecipientName	True	string	Nome do destinatário.
Telemóvel	Mobile		string	Número de telemóvel do destinatário. Se a tua regra não exigir, deixa em branco.

Regressos

Nome	Percurso	Tipo	Descrição
Código do envelope	EnvelopeCode	string	Identificação do envelope.
Transparência Mudou a Mensagem	TransparencyChangedMessage	string	Transparência Mudança de Mensagem.
Mensagem API baseada em linguagem	LanguageBasedApiMessge	string	Mensagem API baseada na linguagem.
ID do Destinatário Prepreenchido	PrefillRecipientId	string	ID do destinatário preenchido.
Página de Navegação de Envio de Publicações	PostSendingNavigationPage	string	Site para onde o destinatário será redirecionado assim que terminar de assinar o envelope.
A Nova Interface de Signer Está Ativada	IsNewSignerUIEnabled	boolean	A interface do novo signante está ativada?
Código de estado	StatusCode	integer	Código de estado de resposta.
Mensagem de status	StatusMessage	string	Mensagem de status da resposta.
Message	Message	string	Descrição do estado da resposta.
Envelope Id	EnvelopeId	string	ID interno do envelope gerado.
URL do Documento de Assinatura	SignDoumentUrl	string	URL global para a assinatura do envelope.
Lista de Recipientes	RecipientList	array of object	Detalhes dos Recipientes
Nome do destinatário	RecipientList.RecipientName	string	Nome do destinatário.
E-mail do destinatário	RecipientList.RecipientEmail	string	Endereço de e-mail do destinatário.
Encomenda	RecipientList.Order	integer	Ordem em que o destinatário precisa de aceder para preencher o envelope.
Tipo	RecipientList.Type	string	Tipo de destinatário parte do envelope presente. Os valores possíveis são: Signer e Prefill.
Modo de Entrega	RecipientList.DeliveryMode	integer	Indica o canal através do qual o pedido de assinatura e o código de acesso foram enviados ao destinatário.
Código de marcação	RecipientList.DialCode	string	O código de discagem do país onde o pedido de assinatura e o código de acesso foram enviados.
Código do país	RecipientList.CountryCode	string	Código do país onde foram enviados o pedido de assinatura e o código de acesso.
Número de telemóvel	RecipientList.Mobile	string	Número de telemóvel do destinatário.
Modo Móvel	RecipientList.MobileMode	integer	Indica o canal móvel através do qual o pedido de assinatura e o código de acesso foram enviados ao destinatário.
URL de assinatura	RecipientList.SigningUrl	string	URL para ser usado pelo destinatário para aceder e assinar o envelope.
Lista Suspensa de Códigos de Discagem	DialCodeDropdownList	string	Lista de códigos de discagem.
Ativar Mensagem para Mobile	EnableMessageToMobile	string	Ativar a Mensagem para o Telemóvel.

Obtenha o AuthToken

ID da Operação:

GetAuthToken

Devolve um AuthToken para ser usado em todas as outras ações suportadas pelo RSign.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
ReferenceKey	ReferenceKey	True	string	Identificador único da sua conta da empresa.
EmailId	EmailId	True	string	Endereço de email da sua conta RSign.
Palavra-passe	Password	True	password	Palavra-passe da sua conta RSign.

Regressos

Nome	Percurso	Tipo	Descrição
Mensagem de Autenticação	AuthMessage	string	Mensagem de status da resposta.
Token de autenticação	AuthToken	string	Token de autenticação a ser usado noutras ações RSign.
Token de atualização	RefreshToken	string	Atualizar o Token.
Token de Atualização Expira	RefreshTokenExpires	string	Data em que o atual Token de Atualização expirará.
Ficha de Autenticação Expira	AuthTokenExpires	string	Data em que o Token de Autenticação atual expirará.
ID de e-mail	EmailId	string	Email do utilizador autenticado.
API Id	ApiId	string	API Id.

Recuperar Documentos do Envelope

ID da Operação:

DownloadEnvelopeDocuments

Recupera a parte dos documentos de um envelope com base no seu Código de Envelope. Irá recuperar os documentos originais e/ou os Documentos Finais Assinados, dependendo do estado do envelope.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Código do envelope	EnvelopeCode	True	string	Código do envelope a recuperar.
Token de autenticação	AuthToken	True	string	AuthToken recuperado da ação "Obter AuthToken".

Regressos

Nome	Percurso	Tipo	Descrição
Situação	Status	boolean	Flag de sucesso de estado.
Código de estado	StatusCode	integer	Código de estado de resposta.
Message	Message	string	Descrição do estado da resposta.
Mensagem de status	StatusMessage	string	Mensagem de status da resposta.
Código do envelope	Data.EnvelopeCode	string	Código do envelope passado como parâmetro.
Lista de Documentos	Data.DocumentList	array of object	Lista de documentos.
Tipo de Documento	Data.DocumentList.DocumentType	string	Tipo de anexo.
Nome do arquivo	Data.DocumentList.FileName	string	Nome do ficheiro.
Description	Data.DocumentList.Description	string	Descrição do documento.
Array de Bytes	Data.DocumentList.ByteArray	string	Arquivo em formato Base64.
Informação adicional	Data.DocumentList.AdditionalInfo	string	Informação adicional.
Descrição do Anexo	Data.DocumentList.AttachmentDescription	string	Descrição informativa do conteúdo do ficheiro.
Lê-me	Data.ReadMe	string	Ficheiro de texto em formato Base64 que indica o nome do documento assinado e do ficheiro original.
Código Postal Combinado	Data.CombinedZip	string	Ficheiro zip contendo todos os documentos do envelope.
Contagem Total	TotalCount	integer	Contagem total.
Existem Uploads de Anexos	IsAttachmentUploadsExist	string	Existem carregamentos de anexos.

Recuperar Informação do Modelo

ID da Operação:

GetTemplateInfo

Recupera a informação sobre um Modelo ou Regra com base no seu Código. Entre as informações devolvidas encontra-se o nome do Modelo, documentos e funções definidas.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Código Modelo	TemplateCode	True	string	Código do modelo para recuperar.
Token de autenticação	AuthToken	True	string	AuthToken recuperado da ação "Obter AuthToken".

Regressos

Nome	Percurso	Tipo	Descrição
Código de estado	StatusCode	integer	Código de estado de resposta.
Mensagem de status	StatusMessage	string	Mensagem de status da resposta.
Message	Message	string	Descrição do estado da resposta.
ID do modelo	TemplateId	string	ID do modelo.
ID do modelo	TemplateBasicInfo.TemplateId	string	ID do modelo.
Código Modelo	TemplateBasicInfo.TemplateCode	integer	Código modelo para ser usado noutras ações.
E-mail do usuário	TemplateBasicInfo.UserEmail	string	Email do utilizador proprietário do modelo.
Nome do modelo	TemplateBasicInfo.TemplateName	string	Nome do modelo.
Descrição do modelo	TemplateBasicInfo.TemplateDescription	string	Descrição do modelo.
É estático	TemplateBasicInfo.IsStatic	string	Indica se o modelo pode ser modificado ou não.
Data de Expiração	TemplateBasicInfo.ExpiryDate	string	Data em que o modelo expira.
Data de criação	TemplateBasicInfo.CreatedDate	string	Data em que o modelo foi criado.
Data da última modificação	TemplateBasicInfo.LastModifiedDate	string	Data em que o modelo foi modificado pela última vez.
Assunto	TemplateBasicInfo.Subject	string	Assunto do modelo de email.
Body	TemplateBasicInfo.Body	string	Modelo de email Corpo. Codificado em HTML.
Nome do tipo	TemplateBasicInfo.TypeName	string	Tipo de Modelo (valores possíveis: Modelo, Regra).
Lista de Documentos	TemplateBasicInfo.DocumentList	array of object	Lista de documentos.
ID do documento	TemplateBasicInfo.DocumentList.DocumentId	string	ID da parte do documento do modelo.
Nome do documento	TemplateBasicInfo.DocumentList.DocumentName	string	Nome da parte do documento do modelo.
Encomenda	TemplateBasicInfo.DocumentList.Order	integer	Ordem do documento parte do modelo na sua lista de documentos.
Detalhes do Conteúdo do Documento	TemplateBasicInfo.DocumentList.documentContentDetails	array of object	Detalhes do Conteúdo do Documento.
ID de controlo	TemplateBasicInfo.DocumentList.documentContentDetails.ControlID	string	ID interno do controlo usado no documento.
Nome do controle	TemplateBasicInfo.DocumentList.documentContentDetails.ControlName	string	Nome do controlo usado no documento.
ID HTML de controlo	TemplateBasicInfo.DocumentList.documentContentDetails.ControlHtmlID	string	ID HTML do controlo usado no documento.
Nome do Grupo	TemplateBasicInfo.DocumentList.documentContentDetails.GroupName	string	Nome do grupo que contém o controlo.
Etiqueta	TemplateBasicInfo.DocumentList.documentContentDetails.Label	string	Nome do controlo a ser exibido no documento.
N.º da página	TemplateBasicInfo.DocumentList.documentContentDetails.PageNo	integer	Página no documento onde o controlo está localizado.
Obrigatório	TemplateBasicInfo.DocumentList.documentContentDetails.Required	boolean	Quer o controlo seja necessário ou não.
Valor de Controlo	TemplateBasicInfo.DocumentList.documentContentDetails.ControlValue	string	Valor pré-preenchido do controlo.
ID da função	TemplateBasicInfo.DocumentList.documentContentDetails.RoleId	string	Identificação do papel que precisa de preencher o controlo.
Nome da Função	TemplateBasicInfo.DocumentList.documentContentDetails.RoleName	string	Nome do papel que precisa de preencher o controlo.
Selecionar Opções de Controlo	TemplateBasicInfo.DocumentList.documentContentDetails.SelectControlOptions	array of string	Selecione Opções de Controlo.
Lista de Papéis Modelo	TemplateBasicInfo.TemplateRoleList	array of object	Lista de recipientes.
ID da função	TemplateBasicInfo.TemplateRoleList.RoleID	string	ID do papel parte deste modelo.
Nome da Função	TemplateBasicInfo.TemplateRoleList.RoleName	string	Parte do nome do papel deste modelo.
Encomenda	TemplateBasicInfo.TemplateRoleList.Order	integer	Ordem em que o papel (destinatário) precisa de completar o modelo.
E-mail do destinatário	TemplateBasicInfo.TemplateRoleList.RecipientEmail	string	Parte do email pré-preenchido do destinatário deste modelo.
Nome do destinatário	TemplateBasicInfo.TemplateRoleList.RecipientName	string	Parte pré-preenchida do nome do destinatário deste modelo.
ID do Tipo de Destinatário	TemplateBasicInfo.TemplateRoleList.RecipientTypeID	string	ID interno do tipo de destinatário.
ID do destinatário	TemplateBasicInfo.TemplateRoleList.RecipientID	string	ID do destinatário faz parte deste modelo.
Tipo de destinatário	TemplateBasicInfo.TemplateRoleList.RecipientType	string	Tipo de destinatário.
Tipo de Signatário de Cc	TemplateBasicInfo.TemplateRoleList.CcSignerType	string	Tipo de receptor de cartão de crédito.
Informação sobre Cultura	TemplateBasicInfo.TemplateRoleList.CultureInfo	string	É a linguagem de serviço do utilizador no momento da criação do Modelo/Regra.
Modo de Entrega	TemplateBasicInfo.TemplateRoleList.DeliveryMode	integer	Indica o canal através do qual o pedido de assinatura e o código de acesso foram enviados ao destinatário.
Código de marcação	TemplateBasicInfo.TemplateRoleList.DialCode	string	O código de discagem do país onde o pedido de assinatura e o código de acesso foram enviados.
Código do país	TemplateBasicInfo.TemplateRoleList.CountryCode	string	Código do país onde foram enviados o pedido de assinatura e o código de acesso.
Número de telemóvel	TemplateBasicInfo.TemplateRoleList.Mobile	string	Número de telemóvel do destinatário.
Modo Móvel	TemplateBasicInfo.TemplateRoleList.MobileMode	integer	Indica o canal móvel através do qual o pedido de assinatura e o código de acesso foram enviados ao destinatário.
Endereço de E-mail	TemplateBasicInfo.TemplateRoleList.EmailAddress	string	Endereço de e-mail do destinatário.
Ativar Mensagem para Mobile	TemplateBasicInfo.EnableMessageToMobile	boolean	Ativar a Mensagem para o Telemóvel.
Data de Validade do Link Estático	TemplateBasicInfo.StaticLinkExpiryDate	string	Data de validade do link estático.
Lista de Modelos	TemplateList	string	Lista de Modelos.

Recuperar o Estado do Envelope

ID da Operação:

GetEnvelopeStatusInfo

Recupera o estado de um Envelope com base no seu Código de Envelope. Pode escolher um relatório detalhado ou resumido.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Token de autenticação	AuthToken	True	string	AuthToken recuperado da ação "Obter AuthToken".
EnvelopeCode	EnvelopeCode	True	string	Código do envelope.
DetalhadorResumo	DetailOrSummary	True	string	Selecione o tipo de relatório que pretende.

Regressos

Nome	Percurso	Tipo	Descrição
Situação	Status	boolean	Estado do pedido.
Código de estado	StatusCode	integer	Código de estado de resposta.
Message	Message	string	Descrição do estado da resposta.
Mensagem de status	StatusMessage	string	Mensagem de status da resposta.
Lista de Dados do Envelope	Data	array of object
Código do envelope	Data.EnvelopeCode	string	Identificação do envelope.
Envelope ID	Data.EnvelopeID	string	Identificação interna do envelope.
Assunto	Data.Subject	string	Assunto do email do envelope.
Estado do envelope	Data.Status	string	Estado do envelope solicitado.
IsEnvelopeComplete	Data.IsEnvelopeComplete	boolean	Indica se o envelope está concluído.
Data de envio	Data.SentDate	string	Data em que o envelope foi enviado.
Data da Última Modificação	Data.LastModifiedDate	string	Data da Última Modificação.
Nome do remetente	Data.SenderName	string	Nome do remetente.
RemetenteE-mail	Data.SenderEmail	string	Email do remetente.
Detalhes do Destinatário	Data.RecipientDetails	array of object
ID do destinatário	Data.RecipientDetails.RecipientID	string	ID do destinatário parte do envelope presente.
ID do Tipo de Destinatário	Data.RecipientDetails.RecipientTypeID	string	O ID do destinatário é parte do envelope presente.
Tipo de destinatário	Data.RecipientDetails.RecipientType	string	Tipo de destinatário parte do envelope presente. Os valores possíveis são: Signer e Prefill.
Nome do destinatário	Data.RecipientDetails.RecipientName	string	Nome do destinatário.
Email	Data.RecipientDetails.Email	string	Endereço de e-mail do destinatário.
Encomenda	Data.RecipientDetails.Order	integer	Ordem em que o destinatário precisa de aceder para preencher o envelope.
StatusID	Data.RecipientDetails.StatusId	string	ID de Estado.
Status de assinatura	Data.RecipientDetails.SigningStatus	string	Estado da assinatura do destinatário do envelope.
Data da última modificação	Data.RecipientDetails.LastModifiedDate	string	Data da Última Modificação.
Código de Referência	Data.ReferenceCode	string	Código de referência parte do envelope atual.
Email de Referência	Data.ReferenceEmail	string	Parte do envelope presente para o email de referência.
TotalCount	TotalCount	integer	Quantidade total de envelopes que correspondem aos critérios solicitados.
IsAttachmentUploadsExist	IsAttachmentUploadsExist	string	Existem carregamentos de anexos.