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,
    "idConector": 12,
    "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
`idConector`	Número	Sim, quando `ativo` é `true`	Conector do grupo econômico usado na leitura: ativo, do tipo `AmazonS3` e com o bucket informado. Ver Conectores. Pode ficar nulo só numa pasta inativa.
`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`), até 100 caracteres. Omitido, aceita qualquer extensão.

idConfiguracaoEnvioArquivo foi substituído por idConector

A conexão da pasta passou a ser informada em idConector, com o id de um conector (ver Conectores). O campo antigo idConfiguracaoEnvioArquivo deixou de ser lido: o valor é descartado sem aviso, e a requisição segue como se nenhuma conexão tivesse sido informada:

numa pasta com ativo: true, a requisição que traz só o campo antigo é recusada com 400 e a mensagem O conector do bucket é obrigatório.;
numa pasta enviada com ativo: false, a configuração é gravada sem conector. Na atualização, a pasta perde o conector que tinha.

Quem integrava com o campo antigo deve trocá-lo por idConector antes de criar ou atualizar pastas. O idConector de cada configuração de envio aparece em Configurações de Envio de Arquivos.

`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

{
  "idConector": 12,
  "nome": "Retornos de cessão",
  "ativo": true,
  "tipoArquivoLeitura": "RetornoCessao",
  "pathOrigem": "retornos/cessao",
  "extensoesAceitas": "csv"
}

Response Body — 200 OK

{
  "id": 7,
  "idConector": 12,
  "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`	Pasta ativa sem `idConector`; conector que não existe no grupo econômico; conector inativo, que não é `AmazonS3` ou sem bucket; pasta na raiz do bucket.

Mensagem	Quando
`O conector do bucket é obrigatório.`	Pasta ativa sem `idConector` (inclusive quando só o campo antigo `idConfiguracaoEnvioArquivo` foi enviado).
`O conector {idConector} não está disponível no grupo econômico.`	O conector não existe no grupo econômico.
`A leitura de pastas só é suportada em conectores ativos do tipo Amazon S3 com o bucket informado.`	Conector inativo, de outro tipo ou sem bucket. Uma pasta que já está inativa pode continuar com um conector que foi desativado.
`A pasta de origem é obrigatória e não pode ser a raiz do bucket.`	`pathOrigem` que, sem as barras das pontas, fica vazio (por exemplo, `/`).
`A pasta '{pasta}' do bucket '{bucket}' já é lida pela configuração '{nome}'.`	`409 Conflict`.
`Configuração de leitura {id} não encontrada na operação {idOperacao}.`	`404 Not Found` na atualização.

Response Body — 400 Bad Request (conector que não é Amazon S3)

{
  "status": "erro",
  "mensagem": "A leitura de pastas só é suportada em conectores ativos do tipo Amazon S3 com o bucket informado."
}

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.
`idConector`	Número	Conector do bucket usado na leitura. `null` numa pasta inativa gravada sem conector.
`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 da operação não leem a mesma pasta do mesmo bucket, mesmo por conectores diferentes que apontam para o 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.