HTTP File Trigger - Downloads
Descubra mais sobre o componente HTTP File Trigger e saiba como utilizá-lo na Digibee Integration Platform.
Atualizado
Descubra mais sobre o componente HTTP File Trigger e saiba como utilizá-lo na Digibee Integration Platform.
Atualizado
O HTTP File Trigger baixa arquivos grandes de forma robusta e eficiente, chamando o método GET.
Dê uma olhada nas opções 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 |
---|---|---|---|
Existe um parâmetro de configuração global que obriga todos os pipelines a serem publicados com ao menos a opção API Key ou Basic Auth habilitada.
Utilizamos vírgula para informar múltiplos valores em um header, mas não adicionamos espaço antes ou após a vírgula. Caracteres especiais não devem ser utilizados nas chaves, por conta de possíveis falhas em proxies e gateways.
Como explicado anteriormente, esta opção é recomendada para remover o prefixo de rota padrão Digibee da rota do pipeline.
Digamos que você tenha criado um pipeline e definido o trigger da seguinte forma:
Com as configurações aplicadas e o pipeline implantado, você terá uma nova URL:
Ao remover o prefixo padrão e definir a rota do pipeline pelo parâmetro Additional API Routes, tenha cuidado para não definir uma rota de pipeline existente que esteja em uso por outros pipelines. Caso você tenha mais do que uma versão principal do pipeline, também é importante ter em mente que o versionamento da rota do pipeline deve ser feito pelo usuário devido à ausência de um parâmetro para versionamento da rota. Por exemplo: /pipeline/realm/v1/.
Ao criarmos APIs, geralmente queremos limitar o número de requisições da API que usuários podem fazer em um dado intervalo de tempo.
Esta ação pode ser executada ativando a opção Rate Limit e aplicando as seguintes configurações:
Se a API possui rotas adicionais, o limite é compartilhado entre todas as rotas. Para aplicar as configurações de rate limit, a API precisa ser configurada com uma API Key ou Basic Auth para que o parâmetro Aggregate by possa ser usado por grupos de credenciais se a opção Consumer estiver selecionada, ou por credenciais individuais se a opção Credential (API Key, Basic Auth) estiver selecionada.
Se vários parâmetros Interval estiverem configurados com valores repetidos, apenas um desses valores é considerado. Também é necessário que um valor maior que zero seja informado para o parâmetro Limit.
Se as opções de rate limiting não forem definidas corretamente, elas serão ignoradas e um warning log será emitido. Você pode visualizar esse log na página de Pipeline Logs.
Digamos que você tenha um arquivo com mais de 5MB. Você pode chamar um endpoint de pipeline configurado com HTTP Trigger via GET com qualquer content type para que a requisição seja recebida e tratada. O arquivo é devolvido conforme o content type de saída e o seu conteúdo "as-is".
Para isso acontecer, basta você seguir estes passos:
Crie um pipeline e configure seu trigger como HTTP-File, incluindo o método GET e os Response Content Types aceitos.
Insira um File Connector no pipeline para buscar o arquivo a ser disponibilizado. Você pode, por exemplo, configurar o WGet para obter um arquivo de uma URL passada ao endpoint durante a chamada.
Insira o JSON Generator como o último passo do seu pipeline para ser gerado um JSON no seguinte formato:
Esse passo é fundamental para que o HTTP File Trigger entenda que o arquivo serve.
4. Implante o pipeline.
5. Crie um consumer e o configure de modo que tenha acesso ao pipeline.
6. Chame o pipeline através deste curl:
realm_name: se refere ao realm onde o pipeline se encontra.
generated_token: se refere à chave de API gerada pelo consumer recém-criado.
urlDownload: parâmetro passado para o WGet Connector resolver o valor do campo URL. O atributo não é obrigatório, mas permite uma abordagem mais flexível através de Double Braces. Funciona perfeitamente se você definir o path diretamente no WGet Connector.
É simples definir o formato da resposta do pipeline. Adicione um Transformer ao final do pipeline e defina a resposta:
Content-Type precisa ser um dos valores definidos em Response Content Types.
O HTTP File Trigger responde bodies que não sejam arquivos da mesma forma que o HTTP Trigger faz. Isso permite que o pipeline responda com o arquivo ou com alguma outro tipo de conteúdo de acordo com o contexto da invocação. Para que o HTTP File Trigger responda com um body qualquer, basta que o último passo do pipeline tenha a seguinte estrutura: