Box

Com o conector do Box, você se conecta a um back-end do Box e usa o SQL para recuperar e atualizar os dados do Box.

Versões compatíveis

Esse conector é compatível com a API Box Content versão 2.0.

Antes de começar

Antes de usar o conector do Box, faça o seguinte:

  • 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 Box 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. Se quiser, 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. 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.

    8. Personificar o modo de usuário: especifique o tipo de personificação de usuário. Precisa ser o modo "Usuário" ou "Administrador".
    9. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
      • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Básico: autenticação HTTP básica.
        • Resumo: autenticação HTTP de resumo.
      • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
      • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
      • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
        • Sempre: a conexão será sempre com SSL ativado.
        • Nunca: a conexão não está com SSL ativado.
        • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
      • Na seção Servidor proxy, insira os detalhes do servidor proxy.
        1. Clique em + Adicionar destino.
        2. Selecione um Tipo de destino.
          • Endereço do host: especifique o nome do host ou o endereço IP do destino.

            Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

    10. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    11. 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.

      A conexão do Box aceita os seguintes tipos de autenticação:

      • Autenticação JWT
      • Código de autorização OAuth 2.0
      • JSON do Box
      • Credenciais do cliente OAuth 2.0
    2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    3. 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.

  • Autenticação JWT
    • ID do cliente: o ID do cliente fornecido pelo Box para o app que você criou.
    • Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app criado.
    • Versão do secret: a versão do secret do cliente.
    • 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.
    • Versão do secret: a versão do secret da chave privada.
    • Senha da chave privada: o secret do Secret Manager que contém a senha (parafrase) do arquivo da chave privada.
    • Versão do secret: a versão da senha da chave privada.
    • Box Application Level: o nível de acesso do app Box.
    • ID da empresa/ID do usuário: ID da empresa, se o nível do aplicativo for corporativo, e ID do usuário, se o nível do aplicativo for de usuário.
    • ID da chave pública OAuth JWT: o ID da chave pública do JWT.
    • Esquema de autenticação: esquema de autenticação para o conector do Box.
    • Iniciar OAuth: inicie o parâmetro OAuth para o conector do Box.
    • Tipo de certificado JWT OAuth: o tipo de certificado JWT OAuth para o conector do Box.
  • Código de autorização OAuth 2.0
    • ID do cliente: o ID do cliente fornecido pelo Box para o app que você criou.
    • Escopos:escopos de permissão. Por exemplo, root_readonly. Para entender como os escopos funcionam e ver todos os disponíveis para o Box, consulte Escopos.
    • Chave secreta do cliente: selecione a chave Gerenciador de secrets. Antes de configurar essa autorização, é necessário criar a chave secreta do Secret Manager.
    • Versão do secret: a versão do secret do cliente no Secret Manager.
  • Box JSON
    • Box JSON para JWT Auth: o secret que contém o conteúdo do arquivo JSON fornecido pelo Box.
    • Versão do secret: a versão do secret do arquivo JSON.
  • OAuth 2.0: credenciais do cliente
    • ID do cliente OAuth: o ID do cliente fornecido pelo Box para o app que você criou.
    • Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app criado.
    • Versão da chave secreta do cliente: a versão da chave secreta do cliente.
    • ID do assunto: o usuário para quem o aplicativo está solicitando acesso delegado.
    • Nível de acesso do aplicativo Box: o nível de acesso do aplicativo Box.

Para o tipo de autenticação Authorization code, depois de criar a conexão, você precisa realizar mais algumas etapas para configurar a autenticação. Para mais informações, consulte Etapas adicionais após a criação da conexão.

Exemplos de configuração de conexão

Esta seção lista os exemplos de valores para as diversas campos que você configura ao criar a conexão.

Tipo de conexão do método de token JWT do OAuth

Nome do campo Detalhes
Local us-central1
Conector Box
Versão do conector 1
Nome da conexão box-conn
Ativar Cloud Logging sim
Conta de serviço XXXX@serviceaccount
Impersonificar o modo de usuário Usuário
Número mínimo de nós 2
Número máximo de nós 2
Autenticação Autenticação JWT
ID do cliente XXXX
Chave secreta do cliente XXXX
Versão do secret 1
Chave privada XXXX
Versão do secret 1
Senha da chave privada XXXX
Versão do secret 1
Nível de acesso do aplicativo Box Enterprise
ID corporativo/ID do usuário XXXX
ID da chave pública JWT do OAuth XXXX
Esquema de autenticação OAuthJWT
Iniciar o OAuth GETANDREFRESH
Tipo de certificado JWT OAuth PEMKEY_BLOB

Você pode acessar o ID do cliente, a chave secreta do cliente, o nível de acesso do aplicativo Box e o ID empresarial/do usuário na conta do Box.

Você pode acessar a Chave privada e a senha da chave privada no arquivo Private keypair.json que você baixou. Para mais informações, consulte Informações sobre pares de chaves públicas e privadas. Além disso, antes de transmitir a senha da chave privada, substitua o \n no arquivo json por uma nova linha.

Tipo de conexão do código de autorização OAuth

Nome do campo Detalhes
Local us-central1
Conector Box
Versão do conector 1
Nome da conexão box-conn
Ativar Cloud Logging sim
Conta de serviço XXXX@serviceaccount
Impersonificar o modo de usuário Usuário
Autorização Código de autorização OAuth 2.0
Número mínimo de nós 2
Número máximo de nós 2
ID do cliente XXXX
Escopos root_readwrite
Chave secreta do cliente XXXX
Versão do secret 1

Para informações sobre a configuração do OAuth do Box, consulte Criar seu aplicativo OAuth.

Box Json para tipo de conexão do método JWT Auth

Nome do campo Detalhes
Local us-central1
Conector Box
Versão do conector 1
Nome da conexão gcp-box-conn-new
Ativar Cloud Logging sim
Conta de serviço XXXX@serviceaccount
Impersonificar o modo de usuário Usuário
Como ID do usuário XXXX
Número mínimo de nós 2
Número máximo de nós 2
Autenticação JSON da caixa
JSON da caixa para autenticação JWT XXXX
Versão do secret 1

É possível usar a conta do Box para configurar o Box JSON para a autenticação JWT. Para informações sobre como configurar o Box Json para JWT, consulte Etapas de criação de tokens JWT

Acesse o valor da autenticação do Box Json para JWT no arquivo Private keypair.json transferido por download. . Para saber mais, consulte Informações sobre pares de chaves públicas e privadas. Transmita todo o conteúdo do arquivo .json no campo Box Json para JWT Auth.

Tipo de conexão das credenciais do cliente OAuth

Nome do campo Detalhes
Local us-central1
Conector Box
Versão do conector 1
Nome da conexão oauth-clientcred-conn
Ativar Cloud Logging sim
Conta de serviço XXXX@serviceaccount
Impersonificar o modo de usuário Usuário
Como ID do usuário XXXX
Número mínimo de nós 2
Número máximo de nós 2
Autenticação Credenciais do cliente OAuth
ID do cliente OAuth XXXX
Chave secreta do cliente OAuth XXXX
Versão do secret 1
ID do assunto XXXX
Nível de acesso do aplicativo Box empresa

Na conta do Box, você pode acessar o ID do cliente, a chave secreta do cliente, o nível de acesso ao aplicativo do Box e o ID corporativo/ID do usuário.

Reautorização do código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito mudanças de configuração no aplicativo Box, faça o seguinte: reautorize a conexão com o Box. Para autorizar uma conexão novamente, siga estas etapas:

  1. Clique na conexão necessária na página "Conexões".

    Isso abre a página de detalhes da conexão.

  2. Clique em Editar para editar os detalhes da conexão.
  3. Verifique os detalhes de OAuth 2.0 - Código de autorização na seção Autenticação.

    Se necessário, faça as mudanças necessárias.

  4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
  5. Clique em Edit authorization na seção Authentication. Isso mostra o painel Autorizar.
  6. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas etapas adicionais após criar a conexão:

  1. Na página "Conexões", localize a conexão recém-criada.

    O Status do novo conector será Autorização necessária.

  2. Clique em Autorização necessária.

    O painel Editar autorização será exibido.

  3. Copie o valor do URI de redirecionamento para seu aplicativo externo.
  4. Verifique os detalhes da autorização.
  5. Clique em Autorizar.

    Se a autorização for bem-sucedida, o status da conexão será definido como Ativo no Página "Conexões".

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 da entidade, como as operações não estã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, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Nesta seção, listamos todas as ações compatíveis com a conexão do Box.

Ação DownloadFile

Essa ação permite fazer o download de um arquivo da instância do Box.

Parâmetros de entrada da ação DownloadFile

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileID String Sim O ID do arquivo que será baixado.
HasBytes Booleano Sim Especifica se o download do arquivo será feito como uma string ou como uma string codificada em Base64.

Parâmetros de saída da ação DownloadFile

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando os resultados.

Nome do parâmetro Tipo de dados Descrição
Sucesso String Especifica se o download do arquivo foi concluído.
ContentBytes String O conteúdo do arquivo como uma string codificada em Base64.

Por exemplo, sobre como configurar a ação DownloadFile, consulte Exemplos de ação.

Ação UploadFile

Essa ação permite fazer upload de um arquivo para sua instância do Box.

Parâmetros de entrada da ação UploadFile

Nome do parâmetro Tipo de dados Obrigatório Descrição
ParentID String Sim ID da pasta para onde você quer fazer o upload do arquivo. Se esse parâmetro não for especificado, O arquivo será enviado por upload para a raiz da conta do Box. O valor padrão é 0.
Conteúdo String Sim O conteúdo do arquivo a ser enviado.

Parâmetros de saída da ação UploadFile

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando os resultados.

Nome do parâmetro Tipo de dados Descrição
Sucesso String Especifica se o upload do arquivo foi concluído.
ID String ID do arquivo recém-criado.
VersionID String ID de uma versão específica do arquivo.
Hash String O hash SHA1 do arquivo.
ETag String Valor de Etag do arquivo ou da pasta. O valor padrão é 0.

Para saber como configurar a ação UploadFile, consulte Exemplos de ação.

Ação CopyFile

Essa ação permite copiar um arquivo da instância do Box.

Parâmetros de entrada da ação CopyFile

Nome do parâmetro Tipo de dados Obrigatório Descrição
FileID String Sim ID do arquivo que você quer copiar.
DestinationFolderId String Não ID da pasta de destino para onde você quer copiar o arquivo. Se você não especificar qualquer valor, a versão mais recente do arquivo será copiada.
NewName String Sim Novo nome do arquivo copiado.

Parâmetros de saída da ação CopyFile

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando os resultados.

Nome do parâmetro Tipo de dados Descrição
Sucesso String Especifica se a cópia do arquivo foi bem-sucedida.
ID String ID do arquivo copiado.

Para saber como configurar a ação CopyFile, consulte Exemplos de ação.

Ação CopyFolder

Essa ação permite copiar uma pasta inteira da instância do Box.

Parâmetros de entrada da ação CopyFolder

Nome do parâmetro Tipo de dados Obrigatório Descrição
FolderID String Sim ID da pasta que você quer copiar.
DestinationFolderId String Sim ID da pasta de destino para onde você quer copiar a pasta.
NewName String Não Novo nome do arquivo para a pasta copiada.

Parâmetros de saída da ação CopyFolder

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando os resultados.

Nome do parâmetro Tipo de dados Descrição
Sucesso String Especifica se a cópia da pasta foi concluída.
ID String ID da pasta copiada.

Para saber como configurar a ação CopyFolder, consulte Exemplos de ação.

Exemplos de ação

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

Exemplo: fazer o download de um arquivo

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DownloadFile e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "FileID": "1283194869422", 
    "HasBytes": true
    }
  4. Este exemplo faz o download de um arquivo como uma string codificada em Base64. Se a ação for bem-sucedida, seu Resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

    [
    { "Success": "True"},
    {"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
    ]

Exemplo: fazer upload de um arquivo

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UploadFile e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "ParentId": "0",
    "Content": "12345"
    }
  4. Este exemplo envia conteúdo de string como um arquivo. Se a ação for bem-sucedida, seu Resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

    [{
    "Success": "true",
    "ID": "1283902965389",
    "VersionID": "1403546001389",
    "Hash": "8cb2237d0679ca88db6464eac60da96345513964",
    "Etag": "0"
    }]

Exemplo: copiar um arquivo

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CopyFile e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "FileID": "1288751886061",
    "DestinationFolderId": "219105724517", 
    "NewName": "NewCopiedFile"
    }
  4. Este exemplo copia o arquivo com o ID 1288751886061. à pasta com o ID 219105724517. Se a ação for bem-sucedida, seu Resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

    [{
    "Success": "true",
    "ID": "1308006018536"
    }]

Exemplo: copiar uma pasta

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CopyFolder e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "FolderID": "218475301279",
    "DestinationFolderId": "0", 
    "NewName": "NewCopiedFolder"
    }
  4. Este exemplo copia a pasta com o ID 218475301279 para a pasta com o ID 219105724517. Se a ação for bem-sucedida, seu Resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

    [{
    "Success": "true",
    "ID": "226312444517"
    }]

Exemplos de operações de entidade

Exemplo: listar todos os arquivos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação LIST e clique em Concluído.

É possível realizar a operação LIST nas seguintes entidades: pastas, itens na lixeira, itens compartilhados, colaborações, atribuições de tarefas e tarefas.

Exemplo: acessar os arquivos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Arquivos" na lista Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Defina o ID da entidade como 1262397830475, que é a chave a ser transmitida. Para definir o ID da entidade, na seção Task Input da tarefa Connectors, clique em EntityId e insira 1262397830475 no campo Default Value.

O valor do ID da entidade precisa ser passado diretamente, como 1262397830475. Em que 1262397830475 é o valor exclusivo da chave primária.

Você pode executar a operação GET nas seguintes entidades: pastas, SharedItems, Collaborations, TaskAssignments e Tasks

Exemplo: excluir arquivos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação DELETE e clique em Concluído.
  4. Defina o ID da entidade como 1258725940971, que é a chave a ser transmitida. Para definir o ID da entidade, em Na seção Task Input da tarefa Connectors, clique em EntityId e e insira 1258725940971 no campo Valor padrão.

    Como alternativa, se a entidade tiver duas chaves principais ou comercial compostas em vez de especificar o entityId, você também poderá definir o filterClause como Id='1258725940971'.

É possível executar a operação DELETE nas seguintes entidades: pastas, tarefas, colaborações, SharedItems e TaskAssignments

Exemplo: criar pastas

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Pastas" na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "Name": "Google Cloud Platforms_created_folders",
    "ParentId": "0"
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Folder terá um valor semelhante a este:

     
    {
    "Id": "222269371053"
    } 

Exemplo: criar colaborações

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Colaborações" na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:
    {
    "ItemId": "216592737829",
    "ItemType": "folder",
    "AccessibleById": "27370766275",
    "AccessibleByType": "user",
    "AccessibleByLogin": "sunita.venkata@bristlecone.com",
    "Role": "editor"
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Folder terá um valor semelhante a este:

     
    {
    "Success": false
    } 

Exemplo: criar tarefas

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Tarefas na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "ItemId": "1253997361112",
    "ItemType": "file",
    "Action": "review",
    "Message": "Creating a task from Google Cloud Platform",
    "DueAt": "2023-12-12 09:01:15.0",
    "CompletionRule": "all_assignees"
    }

    Se a integração for bem-sucedida, o Folder resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

     
    {
    "Id": "1253997361112"
    }

Exemplo: criar atribuições de tarefas

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione TaskAssignments na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "TaskId": "21507516872",
    "AssignedToId": "27370766275"
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Folder terá um valor semelhante a este:

     
    {
    "Id": "50804351753"
    }

Exemplo: atualizar arquivos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Files na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:
    {
    "Name": "Get Started with Box Files.pdf"
    }
  5. Defina o ID da entidade como 1253997361112. Para definir o ID da entidade, Clique em entityId e digite 1253997361112 no campo Valor padrão. .

    Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 1253997361112.

    A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

    {
    "Id": "1253997361112"
    }

É possível realizar a operação UPDATE nas seguintes entidades: pastas, tarefas, colaborações, itens compartilhados e atribuições de tarefas.

Exemplo: atualizar pastas

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Pastas na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:
    {
    "Name": "Demo Update"
    }
  5. Defina o ID da entidade como 216457668125. Para definir o ID da entidade, Clique em entityId e digite 216457668125 no campo Valor padrão. .

    Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 216457668125.

    A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

    {
    "Id": "216457668125"
    } 

Exemplo: atualizar colaborações

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Colaborações" na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "Role": "Viewer"
    }
  5. Defina o ID da entidade como 46685648757. Para definir o ID da entidade, clique em entityId e insira 46685648757 no campo Valor padrão.

    Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 46685648757.

    A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

    {
    
    }

Exemplo: tarefas de atualização

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Tarefas na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:
    {
    "Message": "This is a new task is updated and assigned to you by me"
    }
  5. Defina o ID da entidade como 21507516872. Para definir o ID da entidade, clique em entityId e insira 21507516872 no campo Valor padrão.

    Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 21507516872.

    A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

    {
    "Id": "21507516872"
    }

Exemplo: atualizar atribuições de tarefas

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione TaskAssignments na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:
    {
    "Message": "Looks good to me",
    "ResolutionState": "completed"
    }
  5. Defina o ID da entidade como 49542929469. Para definir o ID da entidade, Clique em entityId e digite 49542929469 no campo Valor padrão. .

    Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 49542929469.

    A execução desse exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

    {
    "Id": "49542929469"
    } 

Exemplo: Transferfolders

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Pastas na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:
    {
    "Name": "Demo Update"
    "ParentId": "216596059374"
    }
  5. Defina o ID da entidade como 216457668125. Para definir o ID da entidade, Clique em entityId e digite 216457668125 no campo Valor padrão. .

    A execução desse exemplo retorna uma resposta semelhante à seguinte no campo Conector variável de saída connectorOutputPayload da tarefa:

    {
    "Id": "216457668125"
    }

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, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
impersonate_user_mode ENUM Verdadeiro Especifique o tipo da representação do usuário. Precisa ser o modo "Usuário" ou "Administrador". Os valores aceitos são: "Usuário", "Administrador"
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.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado ao se conectar ao proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do Box 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" na integração de aplicativos, 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