Configura as pastas do bucket da administradora que a VeHub lê para a operação — retorno de cessão, retorno de baixas, estoque diário, liquidados, aquisições. Cada pasta é lida periodicamente: só os arquivos diretamente na pasta são lidos, e nada é movido nem apagado no bucket da administradora.
Listar pastas¶
| Método | URL |
|---|---|
https://BASE_URL/public/api/v1/operacoes/{idOperacao}/configuracoes-leitura-arquivo |
Exemplo de cURL
curl -X GET "https://BASE_URL/public/api/v1/operacoes/23/configuracoes-leitura-arquivo" \
-H "Authorization: Bearer {token}" \
-H "GrupoEconomico: {grupo}"
Response Body — 200 OK
[
{
"id": 7,
"idConfiguracaoEnvioArquivo": 41,
"nome": "Retornos de cessão",
"ativo": true,
"tipoArquivoLeitura": "RetornoCessao",
"pathOrigem": "retornos/cessao",
"extensoesAceitas": "csv"
}
]
Criar pasta¶
| Método | URL |
|---|---|
https://BASE_URL/public/api/v1/operacoes/{idOperacao}/configuracoes-leitura-arquivo |
Atualizar pasta¶
| Método | URL |
|---|---|
https://BASE_URL/public/api/v1/operacoes/{idOperacao}/configuracoes-leitura-arquivo/{id} |
Para parar de ler uma pasta sem apagar a configuração, atualize com ativo: false.
Path Params¶
| Campo | Tipo | Descrição |
|---|---|---|
idOperacao | Número | Identificador da operação. |
id | Número | Identificador da configuração de leitura (só na atualização). |
Request Body¶
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
idConfiguracaoEnvioArquivo | Número | Sim | Conexão AmazonS3 da mesma operação usada na leitura. Ver Configurações de Envio de Arquivos. |
nome | Texto | Sim | Nome da configuração (até 200 caracteres). |
ativo | Booleano | Não | Se a pasta deve ser lida. Padrão true. |
tipoArquivoLeitura | Texto | Sim | O que os arquivos da pasta são, pelo nome (ver tabela abaixo). |
pathOrigem | Texto | Sim | Pasta dentro do bucket (até 500 caracteres). Não pode ser a raiz. |
extensoesAceitas | Texto | Não | Extensões aceitas, separadas por vírgula (ex.: csv,txt). Omitido, aceita qualquer extensão. |
tipoArquivoLeitura | Conteúdo da pasta |
|---|---|
RetornoCessao | Retorno das ofertas de cessão (aceites e críticas). |
RetornoBaixa | Retorno das baixas (liquidações e recompras). |
EstoqueDiario | Estoque diário do fundo. |
Liquidados | Relatório de liquidados. |
Aquisicao | Relatório de aquisições. |
Renegociacao | Renegociações. |
RetornoRenegociacao | Retorno das renegociações. |
Request Body
{
"idConfiguracaoEnvioArquivo": 41,
"nome": "Retornos de cessão",
"ativo": true,
"tipoArquivoLeitura": "RetornoCessao",
"pathOrigem": "retornos/cessao",
"extensoesAceitas": "csv"
}
Response Body — 200 OK
{
"id": 7,
"idConfiguracaoEnvioArquivo": 41,
"nome": "Retornos de cessão",
"ativo": true,
"tipoArquivoLeitura": "RetornoCessao",
"pathOrigem": "retornos/cessao",
"extensoesAceitas": "csv"
}
Erros¶
Erros de regra retornam o envelope RetornoPadrao.
| HTTP | Quando |
|---|---|
404 Not Found | Operação inexistente ou inativa; na atualização, configuração que não é da operação. |
409 Conflict | A mesma pasta, do mesmo bucket, já está em outra configuração ativa da operação. |
400 Bad Request | Conexão de outra operação ou que não é AmazonS3, pasta em branco ou na raiz do bucket. |
Response Body — 400 Bad Request (conexão de outra operação)
{
"status": "erro",
"mensagem": "A configuração de envio 41 não pertence à operação 23."
}
Validação da requisição
Campo obrigatório ausente, tipoArquivoLeitura fora da lista ou texto acima do limite é recusado antes da regra: 400 Bad Request no formato ProblemDetails, descrito em Primeiros Passos.
Modelo de dados¶
Configuração de leitura¶
| Campo | Tipo | Descrição |
|---|---|---|
id | Número | Identificador da configuração de leitura. |
idConfiguracaoEnvioArquivo | Número | Conexão do bucket usada na leitura. |
nome | Texto | Nome da configuração. |
ativo | Booleano | Indica se a pasta está sendo lida. |
tipoArquivoLeitura | Texto | O que os arquivos da pasta são. |
pathOrigem | Texto | Pasta lida dentro do bucket. |
extensoesAceitas | Texto | Extensões aceitas; null aceita qualquer extensão. |
Observações¶
- Uma pasta, uma leitura: duas configurações ativas não leem a mesma pasta do mesmo bucket. Desative a antiga antes de criar outra para a mesma pasta.
- Arquivos já lidos não se repetem: cada arquivo é lido uma vez; acompanhe o resultado em Arquivos Lidos do Bucket.