Ir para o conteúdo
Método URL
GET https://BASE_URL/public/api/v1/operacoes/{idOperacao}/configuracoes-envio-arquivo

Lista as configurações de envio de arquivos da operação — as conexões com o bucket ou o servidor da administradora do fundo, usadas para enviar a remessa e os lastros.

Cada configuração usa um conector, informado em idConector. Para configurar uma pasta em Pastas de Leitura do Bucket, informe o idConector, não o id desta rota. A lista completa de conectores disponíveis está em Conectores. As conexões são cadastradas pela VeHub no cadastro da operação.

O id desta rota não identifica mais a conexão da pasta

Antes, a pasta de leitura recebia o id de uma configuração de envio em idConfiguracaoEnvioArquivo. Hoje ela recebe o idConector. O idConector de cada configuração de envio aparece na resposta abaixo.

Path Params

Campo Tipo Descrição
idOperacao Número Identificador da operação (ver Listar Operações).

Esta rota não possui Request Body.

Exemplo de cURL
curl -X GET "https://BASE_URL/public/api/v1/operacoes/23/configuracoes-envio-arquivo" \
  -H "Authorization: Bearer {token}" \
  -H "GrupoEconomico: {grupo}"
Response Body — 200 OK
[
  {
    "id": 41,
    "idConector": 12,
    "nome": "Bucket da administradora - Homologação",
    "ativo": true,
    "tipoConexao": "AmazonS3",
    "bucket": "administradora-fidc-exemplo",
    "pathDestino": "remessas/cessao"
  }
]

Erros

Response Body — 404 Not Found (operação inexistente ou inativa)
{
  "status": "erro",
  "mensagem": "Operação com ID 23 não encontrada."
}

Modelo de dados

Configuração de envio

Campo Tipo Descrição
id Número Identificador da configuração de envio.
idConector Número Conector usado pela configuração. É o valor que se informa em idConector numa pasta de leitura.
nome Texto Nome da configuração.
ativo Booleano Indica se a configuração está ativa.
tipoConexao Texto Tipo de conexão do conector (ver Conectores). A leitura de pastas aceita apenas AmazonS3.
bucket Texto Bucket do conector, quando a conexão é Amazon S3.
pathDestino Texto Pasta de destino dos arquivos enviados.

Observações

  • Sem credenciais: endereço, porta, usuário, senha e região da conexão nunca são devolvidos pela API pública.
  • Operação ativa: as rotas desta seção só aceitam operação ativa do grupo econômico; inexistente ou inativa responde 404.