Partilhar via

Sinal de Oodrive (Pré-visualização)

Conecte-se e consuma o serviço de assinatura do Oodrive através de seus fluxos de trabalho.

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 Sinal Oodrive
URL https://www.oodrive.com/products/oodrive-sign/
Email support-sign@oodrive.com
Metadados do conector
Editora Sinal Oodrive
Sítio Web https://www.oodrive.com/products/oodrive-sign/
Política de privacidade https://www.oodrive.com/privacy-policy/
Categorias Operações de TI; Produtividade

O conector do Oodrive Sign permite automatizar tarefas e gerenciar facilmente seus processos sobre o ecossistema de assinatura eletrônica. O fluxo de trabalho automatizado pode ser projetado para, por exemplo, criar um novo contrato por um modelo, adicionar destinatários automaticamente e enviar o contrato para assinatura. Você também pode gerenciar todos os seus pacotes, destinatários, parâmetros-chave e muito mais. Oferece aos clientes a possibilidade de reduzir o tempo utilizado para fazer ações manuais após todo o processo de assinatura. Toda a funcionalidade disponível na aplicação Web pode ser reproduzida no Power Automate utilizando o conector.

Pré-requisitos

Você precisa de uma conta com um plano pago no serviço do Oodrive Sign.

Como obter credenciais

Você também precisa obter seu token de API, que pode ser solicitado ao serviço de suporte ou pode ser recuperado em seu e-mail de boas-vindas que foi enviado para sua caixa de correio quando você se candidatou ao serviço do Sign.

Note: If you are a employee, you can get the token by contacting your IT service.

Introdução ao conector

Para começar a usar o conector, primeiro você precisa abrir o Power Automate com sua conta da Power Platform.

Note: you'll need to be premium on Power Automate in order to use the connector.

Siga estas etapas para criar um novo fluxo de trabalho e usar nosso conector:

  1. No seu ambiente Power Automatic, clique no separador "criar".
  2. Escolha "Automated cloud Flow" ou "Instant cloud flow", conforme necessário.
  3. Dê um nome ao seu novo fluxo de trabalho e selecione um gatilho que atenda às suas necessidades. Você pode usar um dos sinais do Oodrive.
  4. Comece a usar o conector adicionando uma ação dele, simplesmente procurando por "Oodrive Sign" no catálogo.
  5. Na primeira vez que você adicionar uma ação ou um gatilho do nosso conector, o Power Automate solicitará que você se conecte ao seu ambiente: é lá que você usará o token de API fornecido por nós.
  6. Em seguida, clique em conectar: tudo está feito, você pode usar quantas ações do conector quiser.

Problemas conhecidos e limitações

Para problemas com o Oodrive Sign, entre em contato com o serviço de suporte.

Erros e soluções comuns

ERRO HTTP 404

Geralmente, quando você recebe um erro 404 com o Oodrive Sign, ele diz que o ressource que você está tentando encontrar não existe em seu ambiente. Normalmente, pode ser um erro no ID fornecido para um contrato específico ou um destinatário específico, que não existe. Para resolver o problema, tente usar sua ação com uma ID conhecida do recurso que você está tentando obter.

ERRO HTTP 501

O erro HTTP 501 indica que o serviço do Oodrive Sign não reconheceu bem sua demanda ou que você passou um tipo errado de dados para o serviço. Tente investigar, lendo a documentação do Sign, sobre os dados que você passa para sua ação ou gatilho.

FAQ

1. Como posso carregar um documento para um contrato específico?

Usando a ação "Carregar um documento e anexá-lo a um contrato", você pode facilmente carregar um arquivo pdf que é salvo remotamente.

O primeiro passo requer obter o conteúdo do ficheiro que pretende carregar. Você pode obtê-lo usando muitos conectores. Por exemplo, o conteúdo do arquivo pode ser recuperado usando a ação "Obter conteúdo do arquivo" do conector do SharePoint.

  1. Obtenha o conteúdo do ficheiro que pretende carregar como documento para um contrato específico. Neste exemplo, usamos a ação "Obter conteúdo de arquivo" do conector do SharePoint Online.
  2. Em seguida, adicione uma nova ação "compor". Use o corpo de saída da ação "Obter conteúdo do arquivo" como entrada para a composição.
  3. Adicione a ação chamada "Carregar um documento e adicioná-lo a um contrato" a partir do conector de sinal do Oodrive.
    • Na entrada "ID do contrato", especifique o ID do contrato para o qual você deseja que seu documento seja anexado.
    • Na entrada "Arquivos", insira a saída da ação anterior "Compor"
    • Na entrada "Arquivos (nome do arquivo)", insira um nome para o documento que será carregado.
  4. Terminou de carregar o documento!

2. Posso ver todos os contratos dentro do meu ambiente?

Se o seu token for um token de "administrador", sim. Caso contrário, você só visualizará o contrato ao qual teve acesso normalmente.

3. Tenho uma sugestão para o conector. Onde posso enviá-lo?

Você pode enviar quaisquer sugestões sobre o conector entrando em contato com o serviço de suporte. Seremos muito gratos à sua contribuição!

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API securestring A chave de API para esta api Verdade

Limites de Limitação

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

Ações

Adicionar um contrato a um pacote

Adicione um contrato existente a um pacote existente.
Adicionar um destinatário a um contrato

Anexar um destinatário existente ao contrato.
Carregar um anexo e adicioná-lo a um contrato

Carregue um novo anexo para o ambiente e anexe-o a um contrato específico.
Carregar um documento e anexá-lo a um contrato

Carregue um documento no ambiente e anexe-o a um contrato específico.
Criar contrato e enviá-lo para assinatura

Tudo em uma única operação. Crie contratos, adicione destinatários, documentos e envie-os para assinatura aos destinatários.
Criar um contrato

Crie um novo contrato no ambiente.
Criar um pacote

Crie um novo pacote com pelo menos um contrato existente.
Descarregar o documento assinado de um contrato

Recupere um arquivo pdf do documento assinado do contrato.
Descarregar o ficheiro comprovativo de um contrato

Faça o download do comprovativo do contrato.
Descarregar os documentos do contrato

Recupere um arquivo PDF que contenha todos os documentos de um contrato.
Enviar um contrato para ser assinado

Enviar um contrato específico e todos os seus documentos para serem assinados pelos destinatários.
Enviar um pacote para assinatura

Envie um pacote para assinatura.
Excluir um destinatário do contrato

Excluir um destinatário de um contrato, por seu destinatário para ID do contrato. Mais informações na documentação.
Interromper a transação de um contrato

Pare a transação do contrato para poder modificar os documentos contratuais e/ou os signatários.
Listar documentos do contrato

Recuperar todos os documentos vinculados a um contrato.
Listar os contratos de um pacote

Recupere todos os contratos de um pacote específico.
Listar os destinatários de um contrato

Recuperar todos os destinatários de um contrato específico.
Listar todos os destinatários

Recupere todos os destinatários associados à licença atual.
Listar todos os perímetros

Recupere todos os perímetros associados ao ambiente conectado.
Obtenha uma lista de todos os contratos

Recupere todos os contratos da licença associada.
Obter assinaturas de um contrato

Listar todas as informações de assinaturas de um contrato específico.
Obter o status de um contrato

Verifique o status de um contrato específico.
Obter um contrato específico

Recuperar metadados de um contrato específico.
Obter um destinatário específico

Recupere um destinatário específico na lista salva de destinatários do ambiente atual.
Parar uma transação de pacote

Pare uma transação de pacote.
Reenviar e-mail de notificação para um destinatário

Envie um e-mail de notificação para um destinatário específico para o contrato.
Reenviar o e-mail de notificação para todos os destinatários

Envie um e-mail de notificação para todos os destinatários de um contrato específico.
Rescindir um contrato

Defina o status do contrato como ABANDONADO, mesmo que o contrato tenha sido enviado para assinatura.
Retirar um pacote

Retire todo o contrato em um pacote.
Validar contratos em um pacote

Contra-assinar (validar) todos os contratos em um pacote.
Validar um contrato

Validar (assinar) um contrato.

Adicionar um contrato a um pacote

ID da Operação:
AddContractToBundle

Adicione um contrato existente a um pacote existente.

Parâmetros

Name Chave Necessário Tipo Description
ID do pacote
 id True string

ID do pacote para adicionar contrato.
ID do contrato
 contract_id integer

ID do contrato a ser adicionado ao pacote.

Devoluções

Body
BundleResponse

Adicionar um destinatário a um contrato

ID da Operação:
AddRecipientToContract

Anexar um destinatário existente ao contrato.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato a anexar ao destinatário.
ID do destinatário
 recipient_id integer

ID do destinatário a anexar ao contrato.
Modo de assinatura
 signature_mode integer

Modo de assinatura. Consulte a documentação para obter mais informações.
Título da mensagem
 message_title string

Título da mensagem a enviar por e-mail, caso exista.
Conteúdo da mensagem
 message_body string

Corpo da mensagem a enviar por e-mail, caso exista.
Classificação
 rank integer

Local do destinatário no processo de assinatura. Rank e Smartrole são mutuamente exclusivos. Escolha apenas um deles ou não escolha de todo.
Nome da função inteligente
 smartrole string

Papel inteligente para dar ao destinatário. Consulte a documentação para obter mais informações.
Modo de transporte
 transport_mode integer

Modo de transporte da assinatura. Consulte a documentação para obter mais informações.

Devoluções

response
array of ContractRecipient

Carregar um anexo e adicioná-lo a um contrato

ID da Operação:
UploadAttachmentAndAddToContract

Carregue um novo anexo para o ambiente e anexe-o a um contrato específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para adicionar um anexo.
ID da definição do contrato
 contract_definition_id integer

ID de definição de contrato definido em seu ambiente. O padrão é pdfadhoc.
Nome da definição da opção
 option_definition_name string

Nome da definição.
Ficheiros
 file array

Ficheiros a adicionar como anexos

Devoluções

Body
AppendixAdded

Carregar um documento e anexá-lo a um contrato

ID da Operação:
UploadDocumentAndAttachToContract

Carregue um documento no ambiente e anexe-o a um contrato específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para anexar um novo documento.
Ficheiro
 file file

Arquivo binário para carregar.

Devoluções

response
array of DocumentAdded

Criar contrato e enviá-lo para assinatura

ID da Operação:
AllInOneCreateContract

Tudo em uma única operação. Crie contratos, adicione destinatários, documentos e envie-os para assinatura aos destinatários.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 contract_id integer

O ID do contrato.
Data de criação
 date integer

Data de criação do contrato.
Endereço de e-mail do fornecedor
 vendor_email string

Endereço de e-mail do proprietário da licença do Oodrive.
ID da definição do contrato
 contract_definition_id integer

ID da definição de contrato utilizada para este contrato.
Assunto da mensagem
 message_title string

Assunto do e-mail quando enviado para assinatura.
Corpo da Mensagem
 message_body string

Corpo do e-mail quando enviado para assinatura.
Nome do contrato
 name True string

Nome do documento principal do contrato.
Assinatura offline ativada
 keep_on_move boolean

Determine se a assinatura offline no dispositivo móvel está ativada.
Data de Encerramento do Contrato
 closed_date integer

Data de encerramento do contrato, se houver.
Motivo do Contrato Cancelado
 canceled_reason string

Motivo do cancelamento, se houver.
Fechamento automático ativado
 auto_close integer

Especificar se o contrato será assinado automaticamente ou se necessita de uma intervenção humana.
É suprimido
 deleted integer

Especifique se o contrato foi excluído ou não.
Chave de perímetro
 Perimeters string

Chave do perímetro.
ID da opção
 id integer

ID da opção do contrato.
ID do contrato
 contract_id integer

ID do contrato vinculado a esta opção.
ID de definição de elemento
 element_definition_id integer

ID da definição do elemento da opção.
Temporizador de sincronização
 sync_timer integer

Temporizador que é usado para problema de sincronização.
Valor da opção
 value string

Valor da opção.
Local da última modificação
 last_modification_place string

Indica onde ocorreu a última modificação.
Controlo de Opção
 control string

Campo de controlo.
ID da Propriedade
 id integer

ID da propriedade personalizada.
Chave do imóvel
 key string

Chave da propriedade personalizada.
Espaço reservado para propriedade
 placeholder string

Etiqueta mostrada ao destinatário quando convidado a preencher a propriedade.
Valor de Propriedade
 value string

Valor da propriedade personalizada.
ID do Contrato de Propriedade
 contract_id integer

ID do contrato associado a esta propriedade personalizada.
A propriedade é necessária
 to_fill_by_user boolean

Especifique se o usuário precisa preencher a propriedade ou não.
Tipo de Propriedade
 field_type string

Especifique o tipo da propriedade personalizada. Mais informações na documentação.
Opções de propriedade
 input_filter string

Lista de possíveis opções para o imóvel.
A propriedade é usada por contrato
 used_by_contract boolean

Defina como true se as informações tiverem de constar do documento do contrato.
A propriedade é necessária
 required boolean

Especifique se a propriedade é necessária ou não.
Modo de assinatura
 signature_mode integer
Nome próprio
 firstname string
Apelido
 lastname string
e-mail
 email string
cell_phone
 cell_phone string
peças pdf
 pdfparts string
apêndicepeças
 appendixparts string

Devoluções

Name Caminho Tipo Description
recipients
 recipients array of Recipient
destinatárioForcontract
 recipientForcontract array of ContractRecipient
contrato
 contract Contract
PDF
 pdfparts array of object

Matriz de PDF vinculado ao contrato.
PDF ID
 pdfparts.id integer

ID do PDF.
Classificação PDF
 pdfparts.rank integer

Classificação do PDF.
Tem SmartFields
 pdfparts.has_smart_field boolean

Especifique se há campos inteligentes no contrato.
Tamanho do PDF
 pdfparts.size integer

Tamanho do documento.
Nome do ficheiro
 pdfparts.filename string

Nome do pdf.
apêndicepeças
 appendixparts array of object
id
 appendixparts.id integer

Criar um contrato

ID da Operação:
CreateNewContract

Crie um novo contrato no ambiente.

Parâmetros

Name Chave Necessário Tipo Description
Nome do contrato
 name string

Nome do contrato recém-criado (Obrigatório).
ID da definição do contrato
 contract_definition_id integer

ID da definição do contrato. Consulte a variável API da sua licença. Padrão para o modelo PDF AdHoc.
E-mail do fornecedor
 vendor_email string

E-mail do titular da licença.
Data de criação
 date integer

Data do contrato. Padrão para Date.Now(). Deve ser em milissegundos.
Título da mensagem
 message_title string

Objeto do e-mail enviado. Deixe em branco para um título padrão.
Corpo da mensagem
 message_body string

Corpo do e-mail enviado. Deixe em branco para uma mensagem padrão.
Mantenha-se em movimento
 keep_on_move boolean

Ativar ou não assinatura off-line no dispositivo móvel
Fecho automático
 auto_close integer

Especifique se a contraassinatura é executada sem intervenção humana.
Sequencial
 sequential boolean

Especifique se sequencial ou não.
Número de cliente
 customer_number string

Apenas para compatibilidade de aplicações móveis herdadas.
Lista do perímetro
 perimeters array of string
ID de definição do elemento
 element_definition_id integer

ID de definição do elemento.
Valor
 value string

Valor da opção do elemento.
ID da Propriedade
 id integer

ID da propriedade personalizada.
Chave do imóvel
 key string

Chave da propriedade personalizada.
Espaço reservado para propriedade
 placeholder string

Etiqueta mostrada ao destinatário quando convidado a preencher a propriedade.
Valor de Propriedade
 value string

Valor da propriedade personalizada.
ID do Contrato de Propriedade
 contract_id integer

ID do contrato associado a esta propriedade personalizada.
A propriedade é necessária
 to_fill_by_user boolean

Especifique se o usuário precisa preencher a propriedade ou não.
Tipo de Propriedade
 field_type string

Especifique o tipo da propriedade personalizada. Mais informações na documentação.
Opções de propriedade
 input_filter string

Lista de possíveis opções para o imóvel.
A propriedade é usada por contrato
 used_by_contract boolean

Defina como true se as informações tiverem de constar do documento do contrato.
A propriedade é necessária
 required boolean

Especifique se a propriedade é necessária ou não.

Devoluções

Body
Contract

Criar um pacote

ID da Operação:
CreateNewBundle

Crie um novo pacote com pelo menos um contrato existente.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 contract_id integer

ID do primeiro contrato do pacote.
Os mesmos signatários
 same_signatories boolean

Defina como false se os contratos no pacote não tiverem o mesmo conjunto de signatários.

Devoluções

Body
BundleResponse

Descarregar o documento assinado de um contrato

ID da Operação:
DownloadContractSignedDocument

Recupere um arquivo pdf do documento assinado do contrato.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True integer

ID do contrato que contém documentos.
Nome do ficheiro
 filename string

O nome que você deseja dar ao documento baixado.

Devoluções

Conteúdo binário do ficheiro pdf.

Binário do documento
file

Descarregar o ficheiro comprovativo de um contrato

ID da Operação:
DownloadProofFileContract

Faça o download do comprovativo do contrato.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para descarregar o ficheiro comprovativo.
Nome do arquivo de saída
 filename string

Nome do ficheiro que será descarregado.

Devoluções

response
file

Descarregar os documentos do contrato

ID da Operação:
DownloadContractDocuments

Recupere um arquivo PDF que contenha todos os documentos de um contrato.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para recuperar o ficheiro pdf.
Nome do arquivo de saída
 filename string

Nome do ficheiro que será descarregado.

Devoluções

Documento PDF binário
file

Enviar um contrato para ser assinado

ID da Operação:
SendContractToBeSigned

Enviar um contrato específico e todos os seus documentos para serem assinados pelos destinatários.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato a enviar para assinatura.

Devoluções

Body
Transaction

Enviar um pacote para assinatura

ID da Operação:
SendBundleForSignature

Envie um pacote para assinatura.

Parâmetros

Name Chave Necessário Tipo Description
ID do pacote
 id True string

ID do pacote a ser enviado para assinatura.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Diz se a transação foi enviada ou não.

Excluir um destinatário do contrato

ID da Operação:
DeleteRecipientForContract

Excluir um destinatário de um contrato, por seu destinatário para ID do contrato. Mais informações na documentação.

Parâmetros

Name Chave Necessário Tipo Description
Destinatário para ID do contrato
 cfc_id True string

ID do destinatário do objeto de contrato a ser excluído.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Especifique se foi removido com êxito.

Interromper a transação de um contrato

ID da Operação:
StopContract

Pare a transação do contrato para poder modificar os documentos contratuais e/ou os signatários.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato de cessação.
Força
 force boolean

Forçar o fechamento da transação mesmo que os signatários já tenham assinado.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Especifique se o contrato foi cancelado.

Listar documentos do contrato

ID da Operação:
ListContractDocuments

Recuperar todos os documentos vinculados a um contrato.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para recuperar documentos.

Devoluções

response
array of DocumentAdded

Listar os contratos de um pacote

ID da Operação:
ListBundleContracts

Recupere todos os contratos de um pacote específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do pacote
 id True string

ID do pacote do qual recuperar contratos.

Devoluções

response
array of ContractInBundle

Listar os destinatários de um contrato

ID da Operação:
ListContractRecipients

Recuperar todos os destinatários de um contrato específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para recuperar todos os destinatários.

Devoluções

response
array of ContractRecipient

Listar todos os destinatários

ID da Operação:
ListAllRecipients

Recupere todos os destinatários associados à licença atual.

Parâmetros

Name Chave Necessário Tipo Description
Tamanho
 size integer

Tamanho máximo da matriz retornada.
Compensação
 offset integer

Número sequencial do primeiro destinatário listado.
Perímetro
 perimeter string

Pesquise apenas no perímetro dado.
Obtenha adereços personalizados
 get_custom_props boolean

Listar propriedades personalizadas de destinatários (aumenta o tempo de resposta).
Obter Perímetros
 get_perimeters boolean

Listar os perímetros do destinatário nas respostas (aumenta o tempo de resposta).
Sobrenome do filtro (contém)
 name string

Filtre o sobrenome.
Filtrar e-mail (contém)
 email string

Filtre no e-mail.

Devoluções

Destinatários
array of Recipient

Listar todos os perímetros

ID da Operação:
ListAllPerimeters

Recupere todos os perímetros associados ao ambiente conectado.

Devoluções

response
array of Perimeter

Obtenha uma lista de todos os contratos

ID da Operação:
ListAllContracts

Recupere todos os contratos da licença associada.

Parâmetros

Name Chave Necessário Tipo Description
Tamanho da matriz retornada
 size integer

O tamanho máximo da matriz de contrato retornada.
Pular primeiro n contratos
 offset integer

O número sequencial do contrato que será ignorado.
Mostrar propriedades do contrato
 get_properties boolean

Se verdadeiro, as propriedades do contrato serão listadas na resposta.
Mostrar perímetros do contrato
 get_perimeters boolean

Se verdadeiro, os perímetros do contrato serão listados na resposta.
Criado antes
 before integer

Irá listar o contrato criado antes da data dada.
Criado após
 after integer

Irá listar o contrato criado após a data dada.
Apenas com perímetro
 perimeter string

Listar contratos apenas em um determinado perímetro.
Apenas com status
 status array

Recupere o contrato somente com o status especificado.

Devoluções

Itens
ArrayOfContract

Obter assinaturas de um contrato

ID da Operação:
ListSignatureStatus

Listar todas as informações de assinaturas de um contrato específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para listar todas as assinaturas.

Devoluções

response
array of RecipientForContractWithRefusal

Obter o status de um contrato

ID da Operação:
GetContractStatus

Verifique o status de um contrato específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True integer

ID do contrato para recuperar o status.

Devoluções

Body
Transaction

Obter um contrato específico

ID da Operação:
GetSpecificContract

Recuperar metadados de um contrato específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

O ID do contrato a ser recuperado.

Devoluções

Body
Contract

Obter um destinatário específico

ID da Operação:
GetRecipient

Recupere um destinatário específico na lista salva de destinatários do ambiente atual.

Parâmetros

Name Chave Necessário Tipo Description
ID do destinatário
 id True string

ID do destinatário a ser recuperado.

Devoluções

Body
Recipient

Parar uma transação de pacote

ID da Operação:
StopBundleTransaction

Pare uma transação de pacote.

Parâmetros

Name Chave Necessário Tipo Description
ID do pacote
 id True string

ID do pacote para interromper a transação.
Forçar o fecho
 force boolean

Forçar o fechamento da transação, mesmo que os signatários já tenham assinado.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Diz que o pacote foi interrompido com sucesso.

Reenviar e-mail de notificação para um destinatário

ID da Operação:
ResendNotificationRecipient

Envie um e-mail de notificação para um destinatário específico para o contrato.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para reenviar a notificação.
Destinatário para ID do contrato
 cfc_id True string

ID do destinatário do objeto do contrato para enviar uma notificação.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Especifique se a notificação foi reenviada com êxito.

Reenviar o e-mail de notificação para todos os destinatários

ID da Operação:
ResendNotificationAllRecipients

Envie um e-mail de notificação para todos os destinatários de um contrato específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato para reenviar a notificação.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Especifique se a notificação foi reenviada com êxito.

Rescindir um contrato

ID da Operação:
WithdrawContract

Defina o status do contrato como ABANDONADO, mesmo que o contrato tenha sido enviado para assinatura.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato a rescindir.
Reason
 reason string

O motivo da retirada.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Especifique se o contrato foi cancelado.

Retirar um pacote

ID da Operação:
WithdrawBundle

Retire todo o contrato em um pacote.

Parâmetros

Name Chave Necessário Tipo Description
ID do pacote
 id True string

ID do pacote para retirar todo o contrato.

Devoluções

Name Caminho Tipo Description
ter sucesso
 succeed boolean

Diz se o pacote foi retirado.

Validar contratos em um pacote

ID da Operação:
ValidateContractsInBundle

Contra-assinar (validar) todos os contratos em um pacote.

Parâmetros

Name Chave Necessário Tipo Description
ID do pacote
 id True string

ID do pacote para validar todos os contratos.
Validação da força
 force boolean

Forçar a validação dos contratos se alguns signatários ainda não assinaram (ou se recusaram a assinar).

Devoluções

Name Caminho Tipo Description
array of object
date
 date string

Data do estado de encerramento.
ID do contrato
 id string

ID do contrato interrompido.

Validar um contrato

ID da Operação:
ValidateAContract

Validar (assinar) um contrato.

Parâmetros

Name Chave Necessário Tipo Description
ID do contrato
 id True string

ID do contrato a validar.
Força
 force boolean

Especifique se a validação do contrato deve ser forçada, mesmo que alguns signatários ainda não tenham assinado.

Devoluções

Name Caminho Tipo Description
Data de validação
 date string

Data de validação.
ID da transação
 id string

O ID da transação da autoridade de certificação.

Acionadores

Quando o status de um contrato muda

Esta operação é acionada sempre que o status de um contrato é alterado.

Quando o status de um contrato muda

ID da Operação:
WhenContractStatusChanged

Esta operação é acionada sempre que o status de um contrato é alterado.

Parâmetros

Name Chave Necessário Tipo Description
descrição
 description string

descrição
events
 events array of string

events
contractDefinição
 contractDefinition array of integer

contractDefinição
perímetro
 perimeter array of integer

perímetro
concernedUserEmail
 concernedUserEmail string

concernedUserEmail

Devoluções

Name Caminho Tipo Description
tipo
 type string

tipo
contractId
 contractId integer

contractId
carimbo de data/hora
 timestamp integer

carimbo de data/hora
status do contrato
 contractStatus string

status do contrato

Definições

ArrayOfContract

Name Caminho Tipo Description
Itens
 Contract

Contrato

Name Caminho Tipo Description
ID do contrato
 contract_id integer

O ID do contrato.
Data de criação
 date integer

Data de criação do contrato.
Token do documento
 document_token string

Símbolo do documento principal do contrato.
Endereço de e-mail do fornecedor
 vendor_email string

Endereço de e-mail do proprietário da licença do Oodrive.
Está fechado
 closed boolean

Especificar se o contrato está fechado ou não.
Estado do Contrato
 status string

Situação atual do contrato.
ID da definição do contrato
 contract_definition_id integer

ID da definição de contrato utilizada para este contrato.
Assunto da mensagem
 message_title string

Assunto do e-mail quando enviado para assinatura.
Corpo da Mensagem
 message_body string

Corpo do e-mail quando enviado para assinatura.
Nome do contrato
 name string

Nome do documento principal do contrato.
Assinatura offline ativada
 keep_on_move boolean

Determine se a assinatura offline no dispositivo móvel está ativada.
Data de Encerramento do Contrato
 closed_date integer

Data de encerramento do contrato, se houver.
Motivo do Contrato Cancelado
 canceled_reason string

Motivo do cancelamento, se houver.
Número da versão do contrato
 version_number integer

Número da versão do contrato.
Tamanho do Contrato
 size integer

Tamanho total do contrato.
Fechamento automático ativado
 auto_close integer

Especificar se o contrato será assinado automaticamente ou se necessita de uma intervenção humana.
É suprimido
 deleted integer

Especifique se o contrato foi excluído ou não.
Perímetros
 perimeters array of ContractPerimeterKey

Lista de todos os perímetros do contrato (se consultado).
Opções
 options array of ContractOption

Lista de todas as opções específicas do contrato (se consultado).
Propriedades personalizadas
 contract_properties array of ContractProperty

Lista de todas as propriedades do contrato opcional (se consultado).

OpçãoContrato

Name Caminho Tipo Description
ID da opção
 id integer

ID da opção do contrato.
ID do contrato
 contract_id integer

ID do contrato vinculado a esta opção.
ID de definição de elemento
 element_definition_id integer

ID da definição do elemento da opção.
Temporizador de sincronização
 sync_timer integer

Temporizador que é usado para problema de sincronização.
Valor da opção
 value string

Valor da opção.
Local da última modificação
 last_modification_place string

Indica onde ocorreu a última modificação.
Controlo de Opção
 control string

Campo de controlo.

ContractProperty

Name Caminho Tipo Description
ID da Propriedade
 id integer

ID da propriedade personalizada.
Chave do imóvel
 key string

Chave da propriedade personalizada.
Espaço reservado para propriedade
 placeholder string

Etiqueta mostrada ao destinatário quando convidado a preencher a propriedade.
Valor de Propriedade
 value string

Valor da propriedade personalizada.
ID do Contrato de Propriedade
 contract_id integer

ID do contrato associado a esta propriedade personalizada.
A propriedade é necessária
 to_fill_by_user boolean

Especifique se o usuário precisa preencher a propriedade ou não.
Tipo de Propriedade
 field_type string

Especifique o tipo da propriedade personalizada. Mais informações na documentação.
Opções de propriedade
 input_filter string

Lista de possíveis opções para o imóvel.
A propriedade é usada por contrato
 used_by_contract boolean

Defina como true se as informações tiverem de constar do documento do contrato.
A propriedade é necessária
 required boolean

Especifique se a propriedade é necessária ou não.

ContractPerimeterKey

Chave do perímetro.

Chave do perímetro.

Chave de perímetro
string

Destinatário do contrato

Name Caminho Tipo Description
Destinatário para ID do contrato
 recipient_for_contract_id integer

Identificador único do contrato de casal e do destinatário.
ID do destinatário
 recipient_id integer

ID do destinatário.
ID do contrato
 contract_id integer

ID do contrato.
Estado da assinatura
 signature_status string

Estatuto da marca de sinal.
Data de assinatura
 signature_date integer

Carimbo de data/hora da marca do sinal.
Modo de assinatura
 signature_mode integer

Modo de marca de sinal.
Título da mensagem
 message_title string

Título da mensagem.
Conteúdo da mensagem
 message_body string

Corpo da mensagem.
Classificação
 rank integer

Classificação no processo de sinalização.
Papel inteligente
 smartrole string

Função inteligente associada ao destinatário.
Modo de transporte
 transport_mode integer

Modo de transporte.
ID da assinatura
 signature_id string

ID da assinatura do destinatário.

DocumentoAdicionado

Name Caminho Tipo Description
ID do documento
 id integer

ID do documento.
Classificação
 rank integer

Coloque na lista de documentos.
Tem SmartField
 has_smart_field boolean

Especifique se o documento tem SmartFields.
Tamanho do documento
 size integer

Tamanho do documento em bytes.
Nome do documento
 filename string

Nome do documento.

Transação

Name Caminho Tipo Description
ID da transação do contrato
 transaction_id string

Especifique o ID da transação vinculado ao contrato.
Está fechado
 is_closed boolean

Especifique se o contrato está fechado.
Nome do contrato
 contract_name string

Nome do contrato.
Estado do Contrato
 status string

Especifique o estado do contrato.

Perímetro

Name Caminho Tipo Description
ID do perímetro
 id integer

ID do perímetro.
Chave de perímetro
 key string

Chave do perímetro (utilizada pelos contratos).
descrição
 description string

Descrição do perímetro.

RecipientForContractWithRefusal

Name Caminho Tipo Description
Destinatário para ID do contrato
 recipient_for_contract_id integer

ID do objeto que vinculou o contrato e o destinatário.
ID do destinatário
 recipient_id integer

ID do destinatário da assinatura.
Status da assinatura
 signature_status string

Estado da assinatura.
Data de assinatura
 signature_date integer

Data das últimas alterações da assinatura.
Modo de assinatura
 signature_mode integer

Modo da assinatura.
Título da mensagem
 message_title string

Título da mensagem vinculada à assinatura do contrato.
Conteúdo da mensagem
 message_body string

Corpo da mensagem vinculado à assinatura do contrato.
Classificação
 rank integer

Classificação do destinatário da assinatura no processo de contrato.
Nome da função inteligente
 smartrole string

Papel do destinatário da assinatura no contrato.
Modo de transporte
 transport_mode integer

Modo de transporte do contrato vinculado à assinatura.
ID da assinatura
 signature_id string

ID da assinatura.
Tem recusa
 has_refusal boolean

Especificar se o beneficiário recusou o contrato.
Data da última recusa
 last_refusal_date integer

Especificar a data da recusa.
Última mensagem de recusa
 last_refusal_message string

Especifique a mensagem de recusa.

ContractInBundle

Name Caminho Tipo Description
ID do contrato
 id integer

ID do contrato.
Nome do contrato
 name string

Nome do contrato.
Tipo de definição de contrato
 contract_definition_type string

Tipo de definição do contrato.
ID da definição do contrato
 contract_definition_id integer

ID da definição do contrato.
Nome da empresa
 company_name string

Nome da empresa vinculada ao contrato.

Recipient

Name Caminho Tipo Description
ID do destinatário
 id integer

ID do destinatário.
Civilidade
 civility string

Civilidade do destinatário
Nome Próprio
 firstname string

Nome próprio do destinatário.
Apelido
 lastname string

Apelido do destinatário.
Endereço principal
 address_1 string

Endereço postal principal do destinatário.
Código Postal
 postal_code string

Código postal do destinatário.
City
 city string

Cidade do destinatário.
Número de telemóvel
 cell_phone string

Número de telemóvel do destinatário.
Endereço de correio
 email string

Endereço de correio do destinatário.
Country
 country string

País do beneficiário.
Endereço secundário
 address_2 string

Endereço postal secundário do destinatário.
Nome da Empresa
 company_name string

Nome da empresa do destinatário.
Número de telefone
 phone string

Número de telefone do destinatário.
Cargo
 job_title string

Cargo do destinatário.
Data de Nascimento
 birthdate integer

Data de nascimento (carimbo de data/hora) do destinatário.
Local de nascimento
 birthplace string

Local de nascimento do beneficiário.
custom_properties
 custom_properties array of RecipientProperty
Perímetros
 perimeters array of string

RecipientProperty

Name Caminho Tipo Description
ID da Propriedade
 id integer

ID do imóvel.
Chave da propriedade
 key string

Chave do imóvel.
Valor do imóvel
 value string

Valor do imóvel.
ID do Contratante
 contractor_id integer

ID do contratante.
Temporizador de sincronização
 sync_timer integer

Temporizador da última sincronização.
Local da última modificação
 last_modification_place string

Localização da última modificação.

ApêndiceAdicionado

Name Caminho Tipo Description
ID do apêndice
 id integer

ID do apêndice.
Nome do apêndice
 filename string

Nome do apêndice.
ID da opção do apêndice
 option_id integer

ID da opção para o apêndice
Tipo de conteúdo do apêndice
 content_type string

Tipo de conteúdo do apêndice (imagem/jpeg, por exemplo).

BundleResponse

Name Caminho Tipo Description
ID do pacote
 id integer

ID do pacote.
ID do autor
 actor_id integer

ID do criador do Pacote.
ID do Primeiro Contrato
 contract_id integer

ID do primeiro contrato do Pacote criado.
Status do pacote
 status integer

Status do pacote.
Pacote Mestre
 master integer

Mestre do pacote.

ficheiro

Este é o tipo de dados básicos 'arquivo'.