Esta página foi traduzida pela API Cloud Translation.

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, siga estas etapas:

No seu projeto do Google Cloud, faça o seguinte:
- Conceda o papel do IAM roles/connectors.admin ao usuário que estiver 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:

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"
Clique em + CRIAR NOVO para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Para acessar a lista de todas as regiões com suporte, consulte Locais.
2. Clique em PRÓXIMA.
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 exceder 63 caracteres.
4. Como opção, insira uma Descrição para a instância de conexão.
5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
6. 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.
7. Personificar o modo de usuário: especifique o tipo de personificação de usuário. Precisa ser o modo "Usuário" ou "Administrador".
8. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
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.
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:
  - Credenciais do cliente OAuth 2.0
  - Código de autorização OAuth 2.0
2. Clique em PRÓXIMA.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

Configurar a autenticação

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

OAuth 2.0: credenciais de cliente
- ID do cliente: o ID do cliente fornecido pelo conector 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 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.
- Senha da chave privada: o secret do Secret Manager que contém a senha (parafraseada) do arquivo da chave privada.
- Nível de acesso do aplicativo Box: nível de acesso de aplicativos para o 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 do conector do Box.
- Inicializar OAuth: inicializar o parâmetro OAuth do conector do Box.
- Tipo de certificado JWT OAuth: tipo de certificado JWT OAuth para o conector do Box.
Código de autorização OAuth 2.0

ID do cliente: ID do cliente conforme fornecido pelo aplicativo externo.
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. É necessário criar a chave secreta do Secret Manager antes de configurar esta autorização.
Versão do secret: a versão do secret do cliente no Secret Manager.

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

Observação: se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de cofiguração no aplicativo Box, será necessário autorizar novamente a conexão do Box. Para entender como fazer isso, consulte Reautorização do código de autorização.

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

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas outras etapas depois de criar a conexão:

Na página Conexões, localize a conexão recém-criada.
O Status do novo conector será Autorização necessária.
Clique em Autorização necessária.
O painel Editar autorização será exibido.
Copie o valor de Redirect URI no seu aplicativo externo.
Verifique os detalhes da autorização.
Clique em Autorizar.
Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

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 app Box, será necessário autorizar a conexão do Box novamente. Para autorizar uma conexão novamente, siga estas etapas:

Clique na conexão necessária na página Conexões.
A página de detalhes da conexão será aberta.
Clique em Editar para editar os detalhes da conexão.
Verifique os detalhes de OAuth 2.0 - Código de autorização na seção Autenticação.
Se necessário, faça as alterações necessárias.
Clique em Salvar. Isso leva você à página de detalhes da conexão.
Clique em Editar autorização na seção Autenticação. Isso mostra o painel Autorizar.
Clique em Autorizar.
Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na 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:
- List
- Receber
- Criação
- Atualizar
- Excluir
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 for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de 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 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.

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á transferido por download.
HasBytes	Booleano	Sim	Especifica se é necessário fazer o download do arquivo 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
Concluído	String	Especifica se o download do arquivo foi concluído.
ContentBytes	String	O conteúdo do arquivo como uma string codificada em Base64.

Para ver como configurar a ação DownloadFile, consulte os 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 em que você quer fazer o upload do arquivo. Se esse parâmetro não for especificado, o arquivo será enviado 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
Concluído	String	Especifica se o upload do arquivo foi bem-sucedido.
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 ver como configurar a ação UploadFile, consulte os 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	No	ID da pasta de destino para onde você quer copiar o arquivo. Se você não especificar um valor, a versão mais recente do arquivo será copiada.
NewName	String	Sim	Novo nome para o 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
Concluído	String	Especifica se a cópia do arquivo foi bem-sucedida.
ID	String	ID do arquivo copiado.

Para ver como configurar a ação CopyFile, consulte os 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	No	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
Concluído	String	Especifica se a cópia da pasta foi bem-sucedida.
ID	String	ID da pasta copiada.

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

Exemplos de ação

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

Exemplo: fazer o download de um arquivo

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DownloadFile e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"FileID": "1283194869422", 
"HasBytes": true
}
```

Este exemplo faz o download de um arquivo como uma string codificada em Base64. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

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

Observação : se você quiser fazer o download de um arquivo não binário, defina o valor HasBytes como false.

Exemplo: fazer upload de um arquivo

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação UploadFile e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"ParentId": "0",
"Content": "12345"
}
```

Este exemplo envia conteúdo de string como um arquivo. Se a ação for bem-sucedida, o parâmetro de 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

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação CopyFile e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"FileID": "1288751886061",
"DestinationFolderId": "219105724517", 
"NewName": "NewCopiedFile"
}
```

Este exemplo copia o arquivo com ID 1288751886061 para a pasta com ID 219105724517. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

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

Exemplo: copiar uma pasta

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação CopyFolder e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"FolderID": "218475301279",
"DestinationFolderId": "0", 
"NewName": "NewCopiedFolder"
}
```

Este exemplo copia a pasta com o ID 218475301279 para a pasta com o ID 219105724517. Se a ação for bem-sucedida, o parâmetro de 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

Este exemplo lista os arquivos na entidade Files.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Files na lista Entity.
Selecione a operação LIST e clique em Concluído.
Opcionalmente, você pode inserir valores em filterClause para filtrar o conjunto de resultados.

Exemplo: comprar um ingresso

Este exemplo recebe um tíquete específico da entidade Tickets.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Tickets na lista Entity.
Selecione a operação GET e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em IdEntidade e insira 35 no campo Valor padrão.
Aqui, 35 é o valor da chave primária da entidade Tickets.

Exemplo: criar um tíquete

Este exemplo cria um tíquete na entidade Tickets.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Tickets na lista Entity.
Selecione a operação Create e clique em Concluído.

Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

{
"Subject": "Create_Ticket_01",
"Description": "Test",
"Type": "incident",
"Priority": "urgent",
"Status": "open",
"Recipient": null,
"HasIncidents": false,
"DueAt": null,
"RequesterId": 3.84625885158E11,
"SubmitterId": 3.84625883418E11,
"AssigneeId": 3.84625883418E11,
"OrganizationId": "16665992392721",
"GroupId": 3.60008282358E11,
"TicketFormId": 3.60001719218E11,
"BrandId": 3.60003285058E11
}

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

{
"Id": 38.0
}

Exemplo: atualizar um tíquete

Este exemplo atualiza o tíquete especificado na entidade Tickets.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Tíquetes" na lista de Entity.
Selecione a operação Update e clique em Concluído.

Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

{
        "Subject": "Update_Ticket_02",
        "Description": "Updating the ticket",
        "RequesterId": 1.6854335860497E13
      }

Clique em entityId e insira 35 no campo Valor padrão.
Como alternativa, em vez de especificar o entityId, você também pode definir filterOverride como 35.

Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:
```
{
Id": 35.0
}
      
```

Exemplo: excluir um tíquete

Este exemplo exclui o tíquete especificado da entidade Tickets.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione "Tíquetes" na lista de Entity.
Selecione a operação Delete e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e digite 35 no campo Valor padrão.

Observação : a operação Delete faz apenas uma exclusão reversível do registro. Se necessário, você pode recuperar mais tarde o registro excluído.

Usar o Terraform para criar conexões

É possível usar o recurso do Terraform 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 a criação de conexões, 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 o proxy do 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 na conexão com o 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 na Apigee Integration e no Application Integration. É possível usar a conexão em uma integração por meio da tarefa "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

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Saiba como acessar os registros do conector.