IMPORTANTE: esta documentação foi descontinuada. Leia a documentação Dropbox atualizada no nosso novo portal de documentação.
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.
Dê uma olhada nos parâmetros de configuração do componente:
Account: conta para que o componente possa fazer a autenticação ao serviço. É necessário utilizar uma conta do tipo OAUTH-BEARER. Para saber mais sobre as credenciais do Dropbox, clique aqui.
Operation: operação a ser executada, que pode ser Download, Upload ou Delete.
File Name: nome do arquivo ou caminho completo (full file path) para o arquivo local, aplicável apenas nas operações Download e Upload.
Remote File Name: nome do arquivo remoto ou caminho relativo (ex.: tmp/file.txt) para o arquivo remoto.
Remote Directory: diretório remoto do Dropbox no qual será realizada a operação selecionada.
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".
Fluxo de Mensagens
Entrada
O componente espera o preenchimento dos seguintes campos obrigatórios:
Account, File Name, Remote File Name e Remote Directory
Além disso, é possível fazer a passagem de parâmetros (com exceção do 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 de 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
}