Sinal do Oodrive (versão prévia)
Conecte-se e consuma o serviço de sinal do Oodrive por meio de seus fluxos de trabalho.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Sinal do Oodrive |
| URL | https://www.oodrive.com/products/oodrive-sign/ |
| support-sign@oodrive.com |
| Metadados do conector | |
|---|---|
| Publicador | Sinal do Oodrive |
| Site | 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 a tarefa e gerenciar facilmente seus processos sobre o ecossistema de assinatura eletrônica. O fluxo de trabalho automatizado pode ser criado 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 de chave e muito mais. Ele oferece aos clientes a possibilidade de reduzir o tempo usado para realizar ações manuais após todo o processo de assinatura. Todo o recurso disponível no aplicativo Web pode ser reproduzido no Power Automate usando 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 email de boas-vindas que foi enviado para sua caixa de correio quando você se inscreveu no 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 do 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:
- No ambiente do Power Automate, clique na guia "criar".
- Escolha "Fluxo de nuvem automatizado" ou "Fluxo de nuvem instantânea", conforme necessário.
- Dê um nome ao novo fluxo de trabalho e selecione um gatilho que se ajuste às suas necessidades. Você pode usar um dos Sinais do Oodrive.
- Comece a usar o conector adicionando uma ação dele, simplesmente pesquisando "Oodrive Sign" no catálogo.
- 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.
- Em seguida, clique em conectar: tudo é feito, você pode usar quantas ações do conector desejar.
Problemas e limitações conhecidos
Para problemas com o Sinal do Oodrive, 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's, ele diz que a fonte que você está tentando encontrar não existe em seu ambiente. Normalmente, pode ser um erro na ID fornecida 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 da fonte 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.
perguntas frequentes
1. Como posso carregar um documento em um contrato específico?
Usando a ação "Carregar um documento e anexá-lo a um contrato", você pode carregar facilmente um arquivo pdf que é salvo remotamente.
A primeira etapa requer obter o conteúdo do arquivo que você deseja 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.
- Obtenha o conteúdo do arquivo que você deseja carregar como documento para um contrato específico. Neste exemplo, usamos a ação "Obter conteúdo do arquivo" do conector do SharePoint Online.
- Em seguida, adicione uma nova ação "redigir". Use o corpo de saída da ação "Obter conteúdo do arquivo" como entrada para o redigir um.
- Adicione a ação chamada "Carregar um documento e adicioná-lo a um contrato" do conector de Sinal do Oodrive.
- Na entrada "ID do contrato", especifique a ID do contrato para o qual você deseja que seu documento seja anexado.
- Na entrada "Arquivos", insira a saída da ação "Redigir" anterior
- Na entrada "Arquivos (nome do arquivo)", insira um nome para o documento que será carregado.
- Você terminou de carregar o documento!
2. Posso ver todos os contratos dentro do meu ambiente?
Se o token for um token de "administrador", sim. Caso contrário, você exibirá apenas o contrato que você acessou normalmente.
3. Eu tenho uma sugestão para o conector. Onde posso enviá-lo?
Você pode enviar sugestões sobre o conector entrando em contato com o serviço de suporte. Seremos muito gratos à sua contribuição!
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar um contrato a um pacote |
Adicione um contrato existente a um Pacote existente. |
| Adicionar um destinatário a um contrato |
Anexe um destinatário existente ao contrato. |
| Baixar o arquivo de prova de um contrato |
Baixe o arquivo de prova do contrato. |
| Baixar o documento assinado de um contrato |
Recupere um arquivo pdf do documento assinado do contrato. |
| Baixar os documentos do contrato |
Recupere um arquivo PDF que contenha todos os documentos de um contrato. |
| Carregar um anexo e adicioná-lo a um contrato |
Carregue um novo anexo no 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 operação. Crie um contrato, adicione destinatários, documentos e envie-o 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. |
| Enviar um contrato a ser assinado |
Envie um contrato específico e todos os documentos a serem assinados pelos destinatários. |
| Enviar um pacote para assinatura |
Enviar um pacote para assinatura. |
| Excluir um destinatário do contrato |
Exclua 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 |
Interrompa a transação do contrato para que você possa modificar documentos de contrato e/ou signatários. |
| Interromper uma transação de pacote |
Interrompa uma transação de pacote. |
| Listar destinatários de um contrato |
Recupere todos os destinatários de um contrato específico. |
| Listar documentos do contrato |
Recupere todos os documentos associados a um contrato. |
| Listar os contratos de um pacote |
Recupere todos os contratos de um pacote 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. |
| Obter assinaturas de um contrato |
Liste 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. |
| Obter uma lista de todos os contratos |
Recupere todos os contratos da licença associada. |
| Reenviar email de notificação para um destinatário |
Envie um email de notificação para um destinatário específico para contrato. |
| Reenviar o email de notificação para todos os destinatários |
Envie um email de notificação para todos os destinatários de um contrato específico. |
| Retirar 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 |
Contraassinar (validar) todo o contrato em um pacote. |
| Validar um contrato |
Valide (contratribuir) um contrato. |
Adicionar um contrato a um pacote
Adicione um contrato existente a um Pacote existente.
Parâmetros
| Nome | Chave | Obrigató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. |
Retornos
- Corpo
- BundleResponse
Adicionar um destinatário a um contrato
Anexe um destinatário existente ao contrato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para anexar o destinatário. |
|
ID do destinatário
|
recipient_id | integer |
ID do destinatário a ser anexado 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 ser enviada por email se houver um. |
|
|
Conteúdo da mensagem
|
message_body | string |
Corpo da mensagem a ser enviada por email se houver um. |
|
|
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. |
|
|
Nome da função inteligente
|
smartrole | string |
Função inteligente a ser fornecida 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. |
Retornos
- response
- array of ContractRecipient
Baixar o arquivo de prova de um contrato
Baixe o arquivo de prova do contrato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para baixar o arquivo de prova. |
|
Nome do arquivo de saída
|
filename | string |
Nome do arquivo que será baixado. |
Retornos
- response
- file
Baixar o documento assinado de um contrato
Recupere um arquivo pdf do documento assinado do contrato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | integer |
ID do contrato que contém documentos. |
|
Nome do arquivo
|
filename | string |
O nome que você deseja dar ao documento baixado. |
Retornos
Conteúdo binário do arquivo pdf.
- Binário do Documento
- file
Baixar os documentos do contrato
Recupere um arquivo PDF que contenha todos os documentos de um contrato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para recuperar o arquivo pdf. |
|
Nome do arquivo de saída
|
filename | string |
Nome do arquivo que será baixado. |
Retornos
- PDF Document Binary
- file
Carregar um anexo e adicioná-lo a um contrato
Carregue um novo anexo no ambiente e anexe-o a um contrato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para adicionar um anexo. |
|
ID de definição de contrato
|
contract_definition_id | integer |
ID de definição de contrato definida em seu ambiente. O padrão é pdfadhoc. |
|
|
Nome da definição da opção
|
option_definition_name | string |
Nome da definição. |
|
|
Arquivos
|
file | array |
Arquivos a serem adicionados como anexos |
Retornos
- Corpo
- AppendixAdded
Carregar um documento e anexá-lo a um contrato
Carregue um documento no ambiente e anexe-o a um contrato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato ao qual anexar um novo documento. |
|
File
|
file | file |
Binário de arquivo a ser carregado. |
Retornos
- response
- array of DocumentAdded
Criar contrato e enviá-lo para assinatura
Tudo em uma operação. Crie um contrato, adicione destinatários, documentos e envie-o para assinatura aos destinatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
contract_id | integer |
A ID do contrato. |
|
|
Data de Criação
|
date | integer |
Data em que o contrato foi criado. |
|
|
Endereço de email do fornecedor
|
vendor_email | string |
Endereço de email do proprietário da licença do Oodrive. |
|
|
ID de definição de contrato
|
contract_definition_id | integer |
ID da definição de contrato usada para este contrato. |
|
|
Assunto da mensagem
|
message_title | string |
Assunto de email quando enviado para assinatura. |
|
|
Corpo da Mensagem
|
message_body | string |
Corpo do email quando enviado para assinatura. |
|
|
Nome do contrato
|
name | True | string |
O nome principal do documento do contrato. |
|
Assinatura offline ativada
|
keep_on_move | boolean |
Determine se a assinatura offline no dispositivo móvel está ativada. |
|
|
Data de fechamento do contrato
|
closed_date | integer |
Data de encerramento do contrato, se houver algum. |
|
|
Motivo cancelado do contrato
|
canceled_reason | string |
Motivo do cancelamento, se houver algum. |
|
|
Fechamento automático habilitado
|
auto_close | integer |
Especifique se o contrato será contra-assinado automaticamente ou se precisará de uma intervenção humana. |
|
|
Está Excluído
|
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 associado a essa opção. |
|
|
ID de definição de elemento
|
element_definition_id | integer |
ID da definição de elemento da opção. |
|
|
Temporizador de Sincronização
|
sync_timer | integer |
Temporizador usado para problema de sincronização. |
|
|
Valor de Opção
|
value | string |
Valor da opção. |
|
|
Último local de modificação
|
last_modification_place | string |
Indica onde ocorreu a última modificação. |
|
|
Controle de opção
|
control | string |
Campo de controle. |
|
|
ID da Propriedade
|
id | integer |
ID da propriedade personalizada. |
|
|
Chave de propriedade
|
key | string |
Chave da propriedade personalizada. |
|
|
Espaço Reservado para Propriedades
|
placeholder | string |
Rótulo mostrado ao destinatário quando convidado para preencher a propriedade. |
|
|
Valor da propriedade
|
value | string |
Valor da propriedade personalizada. |
|
|
ID do contrato de propriedade
|
contract_id | integer |
ID do contrato associado a essa 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 opções possíveis para a propriedade. |
|
|
A propriedade é usada pelo contrato
|
used_by_contract | boolean |
Defina como true se as informações precisarem aparecer no documento do contrato. |
|
|
A propriedade é necessária
|
required | boolean |
Especifique se a propriedade é necessária ou não. |
|
|
Modo de Assinatura
|
signature_mode | integer | ||
|
primeiro nome
|
firstname | string | ||
|
sobrenome
|
lastname | string | ||
|
email
|
string | |||
|
cell_phone
|
cell_phone | string | ||
|
pdfparts
|
pdfparts | string | ||
|
apêndice
|
appendixparts | string |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
destinatários
|
recipients | array of Recipient | |
|
recipientForcontract
|
recipientForcontract | array of ContractRecipient | |
|
contrato
|
contract | Contract | |
|
PDF
|
pdfparts | array of object |
Matriz de PDF associada ao contrato. |
|
PDF ID
|
pdfparts.id | integer |
ID do PDF. |
|
Classificação de 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 arquivo
|
pdfparts.filename | string |
Nome do pdf. |
|
apêndice
|
appendixparts | array of object | |
|
id
|
appendixparts.id | integer |
Criar um contrato
Crie um novo contrato no ambiente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do contrato
|
name | string |
Nome do contrato recém-criado (Obrigatório). |
|
|
ID de definição de contrato
|
contract_definition_id | integer |
ID da definição do contrato. Consulte a variável de API da licença. Padrão para o modelo do AdHoc em PDF. |
|
|
Email do fornecedor
|
vendor_email | string |
Email do proprietário da licença. |
|
|
Data de criação
|
date | integer |
Data do contrato. Padrão para Date.Now(). Deve estar em milissegundos. |
|
|
Título da mensagem
|
message_title | string |
Objeto do email enviado. Deixe vazio para um título padrão. |
|
|
Corpo da mensagem
|
message_body | string |
Corpo do email enviado. Deixe vazio para uma mensagem padrão. |
|
|
Mantenha-se em movimento
|
keep_on_move | boolean |
Ativar ou não assinatura off-line em dispositivo móvel |
|
|
Fechamento automático
|
auto_close | integer |
Especifique se a contra-atribuição é executada sem intervenção humana. |
|
|
Sequencial
|
sequential | boolean |
Especifique se é sequencial ou não. |
|
|
Número do cliente
|
customer_number | string |
Somente para compatibilidade de aplicativos móveis herdados. |
|
|
Lista de perímetro
|
perimeters | array of string | ||
|
ID de definição de elemento
|
element_definition_id | integer |
ID de definição do elemento. |
|
|
Value
|
value | string |
Valor da opção de elemento. |
|
|
ID da Propriedade
|
id | integer |
ID da propriedade personalizada. |
|
|
Chave de propriedade
|
key | string |
Chave da propriedade personalizada. |
|
|
Espaço Reservado para Propriedades
|
placeholder | string |
Rótulo mostrado ao destinatário quando convidado para preencher a propriedade. |
|
|
Valor da propriedade
|
value | string |
Valor da propriedade personalizada. |
|
|
ID do contrato de propriedade
|
contract_id | integer |
ID do contrato associado a essa 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 opções possíveis para a propriedade. |
|
|
A propriedade é usada pelo contrato
|
used_by_contract | boolean |
Defina como true se as informações precisarem aparecer no documento do contrato. |
|
|
A propriedade é necessária
|
required | boolean |
Especifique se a propriedade é necessária ou não. |
Retornos
- Corpo
- Contract
Criar um pacote
Crie um novo Pacote com pelo menos um contrato existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
contract_id | integer |
A ID do primeiro contrato do pacote. |
|
|
Mesmos signatários
|
same_signatories | boolean |
Defina como false se os contratos no pacote não tiverem o mesmo conjunto de signatários. |
Retornos
- Corpo
- BundleResponse
Enviar um contrato a ser assinado
Envie um contrato específico e todos os documentos a serem assinados pelos destinatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato a ser enviado para assinatura. |
Retornos
- Corpo
- Transaction
Enviar um pacote para assinatura
Enviar um pacote para assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Pacote
|
id | True | string |
ID do pacote a ser enviado para assinatura. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Diz se a transação foi enviada ou não. |
Excluir um destinatário do contrato
Exclua um destinatário de um contrato, por seu destinatário para ID do contrato. Mais informações na documentação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Destinatário da ID do contrato
|
cfc_id | True | string |
ID do destinatário do objeto de contrato a ser excluído. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Especifique se ele foi removido com êxito. |
Interromper a transação de um contrato
Interrompa a transação do contrato para que você possa modificar documentos de contrato e/ou signatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato a ser interrompido. |
|
Força
|
force | boolean |
Force o fechamento da transação mesmo que os signatários já tenham assinado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Especifique se o contrato foi cancelado. |
Interromper uma transação de pacote
Interrompa uma transação de pacote.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Pacote
|
id | True | string |
ID do Pacote para interromper a transação. |
|
Forçar o fechamento
|
force | boolean |
Forçar o fechamento da transação, mesmo que os signatários já tenham assinado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Diz que o pacote foi interrompido com êxito. |
Listar destinatários de um contrato
Recupere todos os destinatários de um contrato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para recuperar todos os destinatários. |
Retornos
- response
- array of ContractRecipient
Listar documentos do contrato
Recupere todos os documentos associados a um contrato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para recuperar documentos. |
Retornos
- response
- array of DocumentAdded
Listar os contratos de um pacote
Recupere todos os contratos de um pacote específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Pacote
|
id | True | string |
ID do pacote do qual recuperar contratos. |
Retornos
- response
- array of ContractInBundle
Listar todos os destinatários
Recupere todos os destinatários associados à licença atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tamanho
|
size | integer |
Tamanho máximo da matriz retornada. |
|
|
Offset
|
offset | integer |
Número de sequência do primeiro destinatário listado. |
|
|
Perímetro
|
perimeter | string |
Pesquise somente no perímetro especificado. |
|
|
Obter 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 perímetros do destinatário nas respostas (aumenta o tempo de resposta). |
|
|
Filtrar sobrenome (contém)
|
name | string |
Filtre o último nome. |
|
|
Filtrar email (contém)
|
string |
Filtre no email. |
Retornos
- Destinatários
- array of Recipient
Listar todos os perímetros
Obter assinaturas de um contrato
Liste todas as informações de assinaturas de um contrato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para listar todas as assinaturas. |
Retornos
Obter o status de um contrato
Verifique o status de um contrato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | integer |
ID do contrato para recuperar o status. |
Retornos
- Corpo
- Transaction
Obter um contrato específico
Recuperar metadados de um contrato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
A ID do contrato a ser recuperada. |
Retornos
- Corpo
- Contract
Obter um destinatário específico
Recupere um destinatário específico na lista salva de destinatários do ambiente atual.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do destinatário
|
id | True | string |
ID do destinatário a ser recuperado. |
Retornos
- Corpo
- Recipient
Obter uma lista de todos os contratos
Recupere todos os contratos da licença associada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tamanho da matriz retornada
|
size | integer |
O tamanho máximo da matriz retornada do contrato. |
|
|
Ignorar os primeiros n contratos
|
offset | integer |
O número de sequência de contrato que será ignorado. |
|
|
Mostrar propriedades do contrato
|
get_properties | boolean |
Se for true, as propriedades do contrato serão listadas na resposta. |
|
|
Mostrar perímetros de contrato
|
get_perimeters | boolean |
Se for true, os perímetros do contrato serão listados na resposta. |
|
|
Criado antes
|
before | integer |
Listará o contrato criado antes da data determinada. |
|
|
Criado após
|
after | integer |
Listará o contrato criado após a data determinada. |
|
|
Somente com perímetro
|
perimeter | string |
Listar contratos apenas em um determinado perímetro. |
|
|
Somente com status
|
status | array |
Recupere o contrato somente com o status especificado. |
Retornos
- Itens
- ArrayOfContract
Reenviar email de notificação para um destinatário
Envie um email de notificação para um destinatário específico para contrato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para reenviar a notificação. |
|
Destinatário da ID do contrato
|
cfc_id | True | string |
ID do destinatário do objeto de contrato para enviar uma notificação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Especifique se a notificação foi reenviada com êxito. |
Reenviar o email de notificação para todos os destinatários
Envie um email de notificação para todos os destinatários de um contrato específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato para reenviar a notificação. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Especifique se a notificação foi reenviada com êxito. |
Retirar um contrato
Defina o status do contrato como ABANDONADO, mesmo que o contrato tenha sido enviado para assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato a ser retirado. |
|
Reason
|
reason | string |
O motivo da retirada. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Especifique se o contrato foi cancelado. |
Retirar um pacote
Retire todo o contrato em um pacote.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Pacote
|
id | True | string |
ID do pacote para retirar todo o contrato. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
suceder
|
succeed | boolean |
Diz se o pacote foi retirado. |
Validar contratos em um pacote
Contraassinar (validar) todo o contrato em um pacote.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Pacote
|
id | True | string |
ID do pacote para validar todo o contrato. |
|
Forçar validação
|
force | boolean |
Force a validação dos contratos se alguns signatários ainda não assinaram (ou se recusaram a assinar). |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
date
|
date | string |
Data do estado de fechamento. |
|
ID do contrato
|
id | string |
A ID do contrato foi interrompida. |
Validar um contrato
Valide (contratribuir) um contrato.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do contrato
|
id | True | string |
ID do contrato a ser validado. |
|
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. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Data de validação
|
date | string |
Data da validação. |
|
ID da transação
|
id | string |
A ID da transação da autoridade de certificação. |
Gatilhos
| Quando o status de um contrato é alterado |
Essa operação é disparada sempre que o status de um contrato é alterado. |
Quando o status de um contrato é alterado
Essa operação é disparada sempre que o status de um contrato é alterado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
descrição
|
description | string |
descrição |
|
|
events
|
events | array of string |
events |
|
|
contractDefinition
|
contractDefinition | array of integer |
contractDefinition |
|
|
perímetro
|
perimeter | array of integer |
perímetro |
|
|
concernedUserEmail
|
concernedUserEmail | string |
concernedUserEmail |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tipo
|
type | string |
tipo |
|
contractId
|
contractId | integer |
contractId |
|
carimbo de data/hora
|
timestamp | integer |
carimbo de data/hora |
|
contractStatus
|
contractStatus | string |
contractStatus |
Definições
ArrayOfContract
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
Contract |
Contrato
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do contrato
|
contract_id | integer |
A ID do contrato. |
|
Data de Criação
|
date | integer |
Data em que o contrato foi criado. |
|
Token de documento
|
document_token | string |
Token do documento principal do contrato. |
|
Endereço de email do fornecedor
|
vendor_email | string |
Endereço de email do proprietário da licença do Oodrive. |
|
Está Fechado
|
closed | boolean |
Especifique se o contrato está fechado ou não. |
|
Status do contrato
|
status | string |
Status atual do contrato. |
|
ID de definição de contrato
|
contract_definition_id | integer |
ID da definição de contrato usada para este contrato. |
|
Assunto da mensagem
|
message_title | string |
Assunto de email quando enviado para assinatura. |
|
Corpo da Mensagem
|
message_body | string |
Corpo do email quando enviado para assinatura. |
|
Nome do contrato
|
name | string |
O nome principal do documento do contrato. |
|
Assinatura offline ativada
|
keep_on_move | boolean |
Determine se a assinatura offline no dispositivo móvel está ativada. |
|
Data de fechamento do contrato
|
closed_date | integer |
Data de encerramento do contrato, se houver algum. |
|
Motivo cancelado do contrato
|
canceled_reason | string |
Motivo do cancelamento, se houver algum. |
|
Número de versão do contrato
|
version_number | integer |
Número de versão do contrato. |
|
Tamanho do contrato
|
size | integer |
Tamanho total do contrato. |
|
Fechamento automático habilitado
|
auto_close | integer |
Especifique se o contrato será contra-assinado automaticamente ou se precisará de uma intervenção humana. |
|
Está Excluído
|
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 de contrato opcionais (se consultadas). |
ContractOption
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da opção
|
id | integer |
ID da opção do contrato. |
|
ID do contrato
|
contract_id | integer |
ID do contrato associado a essa opção. |
|
ID de definição de elemento
|
element_definition_id | integer |
ID da definição de elemento da opção. |
|
Temporizador de Sincronização
|
sync_timer | integer |
Temporizador usado para problema de sincronização. |
|
Valor de Opção
|
value | string |
Valor da opção. |
|
Último local de modificação
|
last_modification_place | string |
Indica onde ocorreu a última modificação. |
|
Controle de opção
|
control | string |
Campo de controle. |
ContractProperty
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Propriedade
|
id | integer |
ID da propriedade personalizada. |
|
Chave de propriedade
|
key | string |
Chave da propriedade personalizada. |
|
Espaço Reservado para Propriedades
|
placeholder | string |
Rótulo mostrado ao destinatário quando convidado para preencher a propriedade. |
|
Valor da propriedade
|
value | string |
Valor da propriedade personalizada. |
|
ID do contrato de propriedade
|
contract_id | integer |
ID do contrato associado a essa 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 opções possíveis para a propriedade. |
|
A propriedade é usada pelo contrato
|
used_by_contract | boolean |
Defina como true se as informações precisarem aparecer no documento do contrato. |
|
A propriedade é necessária
|
required | boolean |
Especifique se a propriedade é necessária ou não. |
ContractPerimeterKey
ContractRecipient
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Destinatário da ID do contrato
|
recipient_for_contract_id | integer |
Identificador exclusivo do contrato do 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. |
|
Status da assinatura
|
signature_status | string |
Status da marca de sinal. |
|
Data da assinatura
|
signature_date | integer |
Carimbo de data/hora da data da marca de 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 |
Classificar no processo de sinal. |
|
Função 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. |
Documento Adicionado
| Nome | 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da transação do contrato
|
transaction_id | string |
Especifique a ID da transação associada ao contrato. |
|
Está Fechado
|
is_closed | boolean |
Especifique se o contrato está fechado. |
|
Nome do contrato
|
contract_name | string |
Nome do contrato. |
|
Status do contrato
|
status | string |
Especifique o status do contrato. |
Perímetro
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do perímetro
|
id | integer |
ID do perímetro. |
|
Chave de perímetro
|
key | string |
Chave do perímetro (usada por contratos). |
|
descrição
|
description | string |
Descrição do perímetro. |
RecipientForContractWithRefusal
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Destinatário da 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 |
Status da assinatura. |
|
Data da 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 associada à assinatura do contrato. |
|
Conteúdo da mensagem
|
message_body | string |
Corpo da mensagem associada à 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 |
Função do destinatário da assinatura no contrato. |
|
Modo de transporte
|
transport_mode | integer |
Modo de transporte do contrato associado à assinatura. |
|
ID da Assinatura
|
signature_id | string |
ID da assinatura. |
|
Tem recusa
|
has_refusal | boolean |
Especifique se o destinatário recusou o contrato. |
|
Data da última recusa
|
last_refusal_date | integer |
Especifique a data da recusa. |
|
Última mensagem de recusa
|
last_refusal_message | string |
Especifique a mensagem de recusa. |
ContractInBundle
| Nome | 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 de definição de contrato
|
contract_definition_id | integer |
ID da definição do contrato. |
|
Nome da empresa
|
company_name | string |
Nome da empresa associada ao contrato. |
Recipient
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do destinatário
|
id | integer |
ID do destinatário. |
|
Civilidade
|
civility | string |
Civilidade do destinatário |
|
Primeiro Nome
|
firstname | string |
Nome do destinatário. |
|
Apelido
|
lastname | string |
Sobrenome 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 telefone celular
|
cell_phone | string |
Número de telefone celular do destinatário. |
|
Endereço de email
|
string |
Endereço de email do destinatário. |
|
|
País
|
country | string |
País do destinatá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 destinatário. |
|
custom_properties
|
custom_properties | array of RecipientProperty | |
|
Perímetros
|
perimeters | array of string |
RecipientProperty
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Propriedade
|
id | integer |
ID da propriedade. |
|
Chave da propriedade
|
key | string |
Chave da propriedade. |
|
Valor da propriedade
|
value | string |
Valor da propriedade. |
|
ID do contratante
|
contractor_id | integer |
ID do empreiteiro. |
|
Temporizador de sincronização
|
sync_timer | integer |
Temporizador da última sincronização. |
|
Último local de modificação
|
last_modification_place | string |
Local da última modificação. |
Apêndice Adicionado
| Nome | 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 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 (image/jpeg, por exemplo). |
BundleResponse
| Nome | 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. |
|
Mestre do Pacote
|
master | integer |
Mestre do pacote. |
arquivo
Esse é o tipo de dados básico 'file'.