| Método | URL |
|---|---|
https://BASE_URL/public/api/v1/operacoes/{idOperacao}/conectores |
Lista os conectores do grupo econômico — as conexões cadastradas com buckets e servidores de arquivos —, sem os dados de acesso.
Serve para a leitura do bucket: o id de um conector AmazonS3 é o idConector que se informa ao configurar uma pasta em Pastas de Leitura do Bucket. Os conectores são cadastrados pela VeHub.
Conectores do grupo econômico, não só da operação
A rota devolve todos os conectores do grupo econômico, inclusive os que a operação da rota não usa. O idOperacao só confere que a operação existe e está ativa. Para a leitura de pastas, escolha um conector com tipoConexao igual a AmazonS3, ativo igual a true e bucket preenchido.
Path Params¶
| Campo | Tipo | Descrição |
|---|---|---|
idOperacao | Número | Identificador de uma operação ativa do grupo econômico. |
Esta rota não possui Request Body.
Exemplo de cURL
curl -X GET "https://BASE_URL/public/api/v1/operacoes/23/conectores" \
-H "Authorization: Bearer {token}" \
-H "GrupoEconomico: {grupo}"
Response Body — 200 OK
[
{
"id": 12,
"nome": "Bucket da administradora - Homologação",
"ativo": true,
"tipoConexao": "AmazonS3",
"bucket": "administradora-fidc-exemplo"
},
{
"id": 15,
"nome": "SFTP da administradora",
"ativo": true,
"tipoConexao": "Sftp",
"bucket": null
}
]
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¶
Conector¶
| Campo | Tipo | Descrição |
|---|---|---|
id | Número | Identificador do conector. É o idConector das Pastas de Leitura do Bucket. |
nome | Texto | Nome do conector. A lista vem em ordem alfabética de nome. |
ativo | Booleano | Indica se o conector está ativo. |
tipoConexao | Texto | Tipo de conexão. Ver Tipos de conexão. |
bucket | Texto | Bucket, quando a conexão é Amazon S3. null nos demais tipos. |
Tipos de conexão¶
tipoConexao | Conexão |
|---|---|
Default | FTP sem criptografia. |
SslExplicito | FTP com criptografia SSL/TLS explícita. |
SslImplicito | FTP com criptografia SSL/TLS implícita. |
Sftp | SFTP. |
AmazonS3 | Bucket Amazon S3. É o único tipo aceito na leitura de pastas. |
SftpVertrau | SFTP mantido pela própria plataforma. |
VeCheck | Validação documental de lastros. |
ApiQiTech | API da QI Tech para cadastro de cedentes. |
Observações¶
- Sem credenciais: endereço, porta, usuário, senha e região do conector nunca são devolvidos pela API pública.
- Conectores internos: conectores de uso interno da plataforma não aparecem na lista.
- Operação ativa: operação inexistente, inativa ou de outro grupo econômico responde
404.