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, realize as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

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

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione DocuSign na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Se você usa uma conta sandbox da DocuSign, selecione UseSandbox.
    8. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    9. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    10. Clique em PRÓXIMA.
  5. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão do DocuSign:

      • OAUTH 2.0: código de autorização
      • OAuth 2.0 - portador do JWT

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em PRÓXIMA.
  6. Revisão: revise os detalhes de conexão e autenticação.
  7. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • OAUTH 2.0: código de autorização
    • ID do cliente: o ID usado para solicitar tokens de acesso.
    • Escopos: uma lista separada por vírgulas dos escopos desejados.
    • Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.
  • OAuth 2.0: portador JWT
    • Chave do cliente do aplicativo conectado:a chave do cliente fornecida para o aplicativo conectado que você criou.
    • Nome de usuário: o nome de usuário associado ao app conectado que você criou.
    • Chave privada: o Secret do Secret Manager que contém o conteúdo do arquivo da chave privada. A chave privada deve corresponder à chave pública/certificado fornecido ao conector.

Exemplos de configuração de conexão

Esta seção lista os valores de exemplo para os vários campos que você configura ao criar a conexão.

OAUTH 2.0 - Tipo de conexão do código de autorização

Nome do campo Detalhes
Local us-central1
Conector DocuSign
Versão do conector 1
Nome da conexão gcp-docusign-new-auth
Ativar Cloud Logging Não
UseSandbox Sim
Conta de serviço SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Autenticação Código de autorização OAuth 2.0
ID do cliente 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Escopos signature
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1

OAuth 2.0: tipo de conexão JWT Bearer

Nome do campo Detalhes
Local us-central1
Conector DocuSign
Versão do conector 1
Nome da conexão gcp-docusign-token
Ativar Cloud Logging Não
UseSandbox Sim
Conta de serviço SERVICE_ACCOUNT_NAME@developer.gserviceaccount.com
Autenticação OAuth 2.0: portador JWT
Chave do cliente do app conectado 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nome de usuário USER_NAME
Chave privada PRIVATE_KEY
Versão do secret 1

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

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

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

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

Limitações do sistema

O conector DocuSign pode processar três transações por segundo, por nó, e throttles as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

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

Exemplos de operações de entidade

Esta seção mostra como executar algumas das operações de entidade neste conector.

O valor de um ID de entidade precisa ser transmitido diretamente, como 16ab549b-95d7-47cb-b557-c2476ef62d9d. O ID 16ab549b-95d7-47cb-b557-c2476ef62d9d é o valor exclusivo da chave primária que precisa ser transmitido.

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

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Accounts" na lista Entity.
  3. Selecione a operação LIST e clique em Concluído.
  4. Entrada de tarefa da tarefa Conectores, você pode definir o filterClause de acordo com sua exigência.

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

  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 clique em Concluído.
  4. Entrada de tarefa da tarefa Conectores, você pode definir o filterClause de acordo com sua exigência.

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 clique em Concluído.
  4. Na seção Entrada de tarefas da tarefa Conectores, é possível definir a filterClause de acordo com seu requisito.

Exemplo: operação LIST 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 LIST e clique em Concluído.
  4. Na seção Entrada de tarefas da tarefa Conectores, você pode definir a filterClause de acordo com seu requisito.

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

  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 clique em Concluído.
  4. Entrada de tarefa da tarefa Conectores, você pode definir o filterClause de acordo com sua exigência.

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

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Usuários" na lista Entity.
  3. Selecione a operação LIST e clique em Concluído.
  4. Entrada de tarefa da tarefa Conectores, você pode definir o filterClause de acordo com sua exigência.

Você 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 registro para a entidade "Contas"

  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 clique em Concluído.
  4. Para definir o ID da entidade, na seção Data Mapper do Data Mapping, clique em Open Data Mapping Editor e insira 2.4578824E7 no campo Input Value e escolha EntityId como variável local.

Exemplo: registro único GET 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 clique em Concluído.
  4. Para definir a cláusula de filtro, na seção Data Mapper do Mapeamento de dados, clique em Abrir o editor de mapeamento de dados e insira 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 registro 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 clique em Concluído.
  4. Para definir o ID da entidade, em Na seção Mapeador de dados de Mapeamento de dados, clique em Abrir editor de mapeamento de dados e Em seguida, insira 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 no campo Valor de entrada e escolha "EntityId" como a variável local.

Exemplo: GET de um único registro 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 clique em Concluído.
  4. Para definir o ID da entidade, em Na seção Mapeador de dados de Mapeamento de dados, clique em Abrir editor de mapeamento de dados e Em seguida, insira 05f76d13-a513-492b-8c58-176702768db0 no campo Valor de entrada e escolha "EntityId" como a variável local.

Exemplo: GET de um único registro para a entidade "Grupos"

  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 clique em Concluído.
  4. Para definir o ID da entidade, em Na seção Mapeador de dados de Mapeamento de dados, clique em Abrir editor de mapeamento de dados e Em seguida, insira 1.4167231E7 no campo Valor de entrada e escolha "EntityId" como a variável local.

Exemplo: registro único GET para a entidade "Users"

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

Também é possível 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

Usar o Terraform para criar conexões

É possível usar o Terraform recurso para criar uma nova conexão.

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

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, defina as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
proxy_enabled BOOLEAN Falso Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticação no proxy ProxyServer.

Usar a conexão da DocuSign em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
  • Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir