Dropbox

Descubra mais sobre o componente Dropbox e saiba como utilizá-lo na Digibee Integration Platform.

O componente Dropbox permite que uma conexão com o serviço Dropbox seja estabelecida, além de possibilitar as seguintes operações com arquivos: Download, Upload e Delete.

Parâmetros

Dê uma olhada nos parâmetros de configuração do componente. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Parâmetro	Descrição	Valor padrão	Tipo de dado
Account	Conta para que o componente possa fazer a autenticação ao serviço. É necessário utilizar uma conta do tipo Oauth-Bearer. Veja a documentação oficial para saber mais sobre as credenciais do Dropbox.	N/A	String
Operation	Operação a ser executada, que pode ser Download, Upload ou Delete.	Upload	String
File Name	Nome do arquivo ou caminho completo (full file path, por exemplo tmp/processed/file.txt) para o arquivo local. Aplicável apenas nas operações Download e Upload.	N/A	String
Remote File Name	Nome do arquivo ou caminho completo do arquivo remoto (ex.: tmp/file.txt).	N/A	String
Remote Directory	Diretório remoto do Dropbox no qual será realizada a operação selecionada.	N/A	String
Fail On Error	Se a opção estiver habilitada, a execução do pipeline com erro será interrompida; do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".	False	Booleano

Fluxo de Mensagens

Entrada

O componente espera o preenchimento dos seguintes campos obrigatórios:

• Account

• File Name

• Remote File Name

• Remote Directory

Além disso, é possível fazer a passagem de parâmetros (com exceção de Account e Operation) relacionados ao arquivo dentro do fluxo de integração. Nesse caso, o componente espera uma mensagem no seguinte formato:

{
    "filename": "data.csv",
    "remoteFileName": "data.csv,
    "remoteDirectory": "/"
}

Saída

Ao executar o componente, a seguinte estrutura de JSON será gerada quando a operação for realizada com sucesso:

{
  "fileName": "data.csv",
  "remoteDirectory": "/",
  "remoteFileName": "data.csv",
  "success": true
}

Caso algum erro ocorra durante a execução da operação, a seguinte estrutura de JSON será gerada:

{
  "error": {
    "exception": "<DETALHES DO ERRO>",
    "message": "<MENSAGEM DE ERRO>",
    "success": false
  },
  "success": false
}

Importante: a manipulação de arquivos dentro de um pipeline ocorre de forma protegida. Todos os arquivos podem ser acessados apenas por um diretório temporário, no qual cada pipeline key dá acesso ao seu próprio conjunto de arquivos.

Dropbox em Ação

Upload de um arquivo

Entrada

• Arquivo local: data.csv

Parâmetros

• Account: dropbox-test

• Operation: Upload

• File Name: data.csv

• Remote File Name: data.csv

• Remote Directory: /Public

ou

• Account: dropbox-test (via tela de configuração do componente)

• Operation: Upload (via tela de configuração do componente)

• Payload:

{
    "fileName": "data.csv",
    "remoteFileName": "data.csv",
    "remoteDirectory": "/Public"
}

Saída

{
  "fileName": "data.csv",
  "remoteDirectory": "/Public",
  "remoteFileName": "data.csv",
  "success": true
}

Download de um arquivo

Entrada

Parâmetros

• Account: dropbox-test

• Operation: Download

• File Name: data.csv

• Remote File Name: data.csv

• Remote Directory: /Public

ou

• Account: dropbox-test (via tela de configuração do componente)

• Operation: Download (via tela de configuração do componente)

• Payload:

{
    "fileName": "data.csv",
    "remoteFileName": "data.csv",
    "remoteDirectory": "/Public"
}

Saída

{
  "fileName": "data.csv",
  "remoteDirectory": "/Public",
  "remoteFileName": "data.csv",
  "success": true
}

Será realizado o download do arquivo no diretório local do pipeline.

Delete - Apagar um arquivo

Entrada

Parâmetros

• Account: dropbox-test

• Operation: Delete

• File Name: data.csv

• Remote File Name: data.csv

• Remote Directory: /Public

ou

• Account: dropbox-test (via tela de configuração do componente)

• Operation: Delete (via tela de configuração do componente)

Payload:

{
    "fileName": "data.csv",
    "remoteFileName": "data.csv",
    "remoteDirectory": "/Public"
}

Saída

{
  "fileName": "data.csv",
  "remoteDirectory": "/Public",
  "remoteFileName": "data.csv",
  "success": true
}