DocuSign

Use o conector do DocuSign para realizar operações de leitura no DocuSign.

Antes de começar

Antes de usar o conector do DocuSign, conclua as seguintes tarefas:

  • No seu projeto do Google Cloud:
    • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
    • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
    • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (API Connectors)

      Para saber como ativar serviços, consulte o artigo Ativar serviços.

    Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

  1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

    Aceda à página Ligações

  2. Clique em + CRIAR NOVO para abrir a página Criar associação.
  3. Na secção Localização, escolha a localização para a ligação.
    1. Região: selecione uma localização na lista pendente.

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

    2. Clique em SEGUINTE.
  4. Na secção Detalhes da associação, conclua o seguinte:
    1. Conector: selecione DocuSign na lista pendente de conectores disponíveis.
    2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
    3. No campo Nome da ligação, introduza um nome para a instância de ligação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
    4. Opcionalmente, introduza uma Descrição para a instância de associação.
    5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
    7. Opcionalmente, selecione UseSandbox se usar uma conta de sandbox do DocuSign.
    8. Opcionalmente, configure as definições do nó de associação:

      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

    9. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
    10. Clique em SEGUINTE.
  5. Na secção Autenticação, introduza os detalhes de autenticação.
    1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela ligação do DocuSign:

      • OAUTH 2.0 – Código de autorização
      • OAuth 2.0 – JWT Bearer

      2. Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

    2. Clique em SEGUINTE.
  6. Rever: reveja os detalhes da ligação e da autenticação.
  7. Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

  • OAUTH 2.0 – Código de autorização
    • ID de cliente: o ID de cliente usado para pedir tokens de acesso.
    • Âmbitos: uma lista separada por vírgulas dos âmbitos pretendidos.
    • Segredo do cliente: segredo do Secret Manager que contém o segredo do cliente da app associada que criou.
  • OAuth 2.0 – JWT Bearer
    • Chave de consumidor da app associada:a chave de consumidor fornecida para a app associada que criou.
    • Nome de utilizador: o nome de utilizador associado à app ligada que criou.
    • Chave privada: segredo do Secret Manager que contém o conteúdo do ficheiro de chave privada. A chave privada deve corresponder à chave pública/certificado fornecido ao conector.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo para os vários campos que configura quando cria a associação.

OAUTH 2.0 – Tipo de ligação de código de autorização

Nome do campo Detalhes
Localização us-central1
Conetor DocuSign
Versão do conetor 1
Nome da ligação gcp-docusign-new-auth
Ative o Cloud Logging Não
UseSandbox Sim
Conta de serviço SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Autenticação OAuth 2.0 – Código de autorização
ID do cliente 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Âmbitos assinatura
Segredo do cliente CLIENT_SECRET
Versão do secret 1

OAuth 2.0 – Tipo de ligação de portador de JWT

Nome do campo Detalhes
Localização us-central1
Conetor DocuSign
Versão do conetor 1
Nome da ligação gcp-docusign-token
Ative o Cloud Logging Não
UseSandbox Sim
Conta de serviço SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Autenticação OAuth 2.0 – Portador de JWT
Chave do consumidor da app associada 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nome de utilizador USER_NAME
Chave privada PRIVATE_KEY
Versão do secret 1

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

  • Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não suporte ou não tenha entidades, caso em que a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Limitações do sistema

O conector do DocuSign pode processar 3 transações por segundo, por nó, e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Ações

Esta secção apresenta todas as ações suportadas pela ligação do DocuSign.

Ação CreateAndSendEnvelope

Cria e envia um envelope ou cria um rascunho de envelope.

Parâmetros de entrada da ação CreateAndSendEnvelope

Nome do parâmetro Tipo de dados Obrigatória Descrição
FileName String Sim O nome do documento.
DocumentId String Sim ID do documento.
EmailSubject String Sim A linha de assunto do email.
Conteúdo String Sim O conteúdo do ficheiro.
SignersEmail String Não Os IDs de email dos signatários do documento.
SignersRecipientId String Não Os IDs dos destinatários dos signatários.
CcRecipientId String Não Os IDs dos destinatários que estão em cópia no email.
CcEmail String Não Os IDs de email dos destinatários que estão em cópia no email.
Estado String Não O estado do envelope. Defina o estado como "enviado" para enviar o envelope aos destinatários.
CustomFieldAggregate String Não Pode usar as seguintes colunas: CustomFieldName, CustomFieldId, CustomFieldShow, CustomFieldRequired, CustomFieldValue, CustomFieldConfiguration e CustomFieldListItems.
SignersName String Não Nome dos signatários do documento.
CcName String Não Nome dos destinatários em cc.

Por exemplo, para saber como configurar a ação CreateAndSendEnvelope, consulte os exemplos.

Exemplos de ações

Esta secção descreve como realizar algumas das ações neste conector.

Exemplo: CreateAndSendEnvelope

Esta ação cria e envia uma envelope ou cria um rascunho de envelope.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateAndSendEnvelope e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value: 
    {
"EmailSubject": "Please Sign this Document",
"FileName": "test.txt\ntest.pdf",
"SignersEmail": "cloudysanfrancisco@gmail.com",
"SignersRecipientId": "53386460",
"CcRecipientId": "67173451",
"CcEmail": "baklavainthebalkans@gmail.com",
"DocumentId": "1",
"Status": "sent",
"CustomFieldAggregate": "CustomFieldName",
"ContentBytes": "abcd***",
"HasBytes": true,
"SignersName": "\"test\"",
"CcName": "\"test\"",
"Content": "test content in file"
}
    4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa do conector terá um valor semelhante ao seguinte:connectorOutputPayload

     [{
"Success":"true",
"envelopeid":"542a77ff-b533-4b39-9d82-e397ef5a70c9",
"uri":"/envelopes/542a77ff-b533-4b39-9d82-e397ef5a70c9",
"statusdatetime":"2025-04-09T12:33:47.1130000Z",
"status":"sent",
"customfieldaggregate": "CustomFieldName"
}]

Exemplos de operações de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

O valor de um ID da entidade deve ser transmitido diretamente, como 16ab549b-95d7-47cb-b557-c2476ef62d9d. O ID 16ab549b-95d7-47cb-b557-c2476ef62d9d é o valor da chave principal exclusivo que tem de ser transmitido.

Exemplo: operação LIST para a entidade "Accounts"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Contas na lista Entity.
  3. Selecione a operação LIST e, de seguida, clique em Concluído.
  4. Na secção Task Input da tarefa Connectors, pode definir a filterClause de acordo com o seu requisito.

Exemplo: operação LIST para a entidade "Documents"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Documentos na lista Entity.
  3. Selecione a operação LIST e, de seguida, clique em Concluído.
  4. Na secção Task Input da tarefa Connectors, pode definir a filterClause de acordo com o seu requisito.

Exemplo: operação LIST para a entidade "Envelopes"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Envelopes na lista Entity.
  3. Selecione a operação LIST e, de seguida, clique em Concluído.
  4. Na secção Task Input da tarefa Connectors, pode definir a filterClause de acordo com o seu requisito.

Exemplo: operação LIST para a entidade "Folders"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Pastas na lista Entity.
  3. Selecione a operação LIST e, de seguida, clique em Concluído.
  4. Na secção Task Input da tarefa Connectors, pode definir a filterClause de acordo com o seu requisito.

Exemplo: operação LIST para a entidade "Groups"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Grupos na lista Entity.
  3. Selecione a operação LIST e, de seguida, clique em Concluído.
  4. Na secção Task Input da tarefa Connectors, pode definir a filterClause de acordo com o seu requisito.

Exemplo: operação LIST para a entidade "Users"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Utilizadores na lista Entity.
  3. Selecione a operação LIST e, de seguida, clique em Concluído.
  4. Na secção Task Input da tarefa Connectors, pode definir a filterClause de acordo com o seu requisito.

Também pode executar operações LIST nas seguintes entidades:

  • UserInfo
  • UserSignatures
  • Espaços de trabalho
  • Destinatários
  • AccountBrands
  • AccountCustomFields
  • EnvelopeTemplates
  • EnvelopeAttachments
  • EnvelopeConsumerDisclosures
  • CloudStorageProviders
  • CustomTabs
  • Fechaduras
  • GroupBrands
  • GroupUsers
  • PowerForms
  • RecipientTabs
  • SigningGroups
  • SigningGroupUsers
  • Modelos

Exemplo: GET de um único registo para a entidade "Accounts"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Contas na lista Entity.
  3. Selecione a operação GET e, de seguida, clique em Concluído.
  4. Para definir o ID da entidade, na secção Mapeamento de dados do Mapeador de dados, clique em Abrir editor de mapeamento de dados e, em seguida, introduza 2.4578824E7 no campo Valor de entrada e escolha EntityId como variável local.

Exemplo: GET de um único registo para a entidade "Documents"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Documentos na lista Entity.
  3. Selecione a operação LIST e, de seguida, clique em Concluído.
  4. Para definir a cláusula de filtro, na secção Mapeamento de dados do Mapeador de dados, clique em Abrir editor de mapeamento de dados e, de seguida, introduza Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' no campo Valor de entrada e escolha a cláusula de filtro como variável local.

Exemplo: GET de um único registo para a entidade "Envelopes"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Envelopes na lista Entity.
  3. Selecione a operação GET e, de seguida, clique em Concluído.
  4. Para definir o ID da entidade, na secção Mapeamento de dados do Mapeador de dados, clique em Abrir editor de mapeamento de dados e, em seguida, introduza 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 no campo Valor de entrada e escolha EntityId como variável local.

Exemplo: GET de um único registo para a entidade "Pastas"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Pastas na lista Entity.
  3. Selecione a operação GET e, de seguida, clique em Concluído.
  4. Para definir o ID da entidade, na secção Mapeamento de dados do Mapeador de dados, clique em Abrir editor de mapeamento de dados e, em seguida, introduza 05f76d13-a513-492b-8c58-176702768db0 no campo Valor de entrada e escolha EntityId como variável local.

Exemplo: GET de um único registo para a entidade "Groups"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Grupos na lista Entity.
  3. Selecione a operação GET e, de seguida, clique em Concluído.
  4. Para definir o ID da entidade, na secção Mapeamento de dados do Mapeador de dados, clique em Abrir editor de mapeamento de dados e, em seguida, introduza 1.4167231E7 no campo Valor de entrada e escolha EntityId como variável local.

Exemplo: GET de um único registo para a entidade "Users"

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Utilizadores na lista Entity.
  3. Selecione a operação GET e, de seguida, clique em Concluído.
  4. Para definir o ID da entidade, na secção Mapeamento de dados do Mapeador de dados, clique em Abrir editor de mapeamento de dados e, em seguida, introduza 16ab549b-95d7-47cb-b557-c2476ef62d9d no campo Valor de entrada e escolha EntityId como variável local.

Também pode realizar operações GET nas seguintes entidades:

  • UserInfo
  • UserSignatures
  • Espaços de trabalho
  • Destinatários
  • AccountBrands
  • AccountCustomFields
  • EnvelopeTemplates
  • EnvelopeAttachments
  • EnvelopeConsumerDisclosures
  • CloudStorageProviders
  • CustomTabs
  • Fechaduras
  • GroupBrands
  • GroupUsers
  • RecipientTabs
  • SigningGroups
  • SigningGroupUsers
  • Modelos

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os comandos básicos do Terraform.

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatória Descrição
proxy_enabled BOOLEAN Falso Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme ENUM Falso O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma palavra-passe a usar para autenticar no proxy ProxyServer.

Use a associação do DocuSign numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

  • Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
  • Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?