Saltar al contenido principal
POST
Activar una obtención e ingesta manual desde un transporte externo

Autorizaciones

Authorization
string
header
requerido

Autenticación con token Bearer (formato: "Bearer {token}")

Parámetros de ruta

contextId
string<uuid>
requerido

Context ID ID del contexto

sourceId
string<uuid>
requerido

Source ID ID de la fuente

Cuerpo

application/json
credentialRef
string
requerido

Referencia de credencial almacenada opaca (no un secreto)

Minimum string length: 1
Ejemplo:

"cred-handle-123"

host
string
requerido

Nombre de host o IP del endpoint remoto

Minimum string length: 1
Ejemplo:

"sftp.bank.example"

path
string
requerido

Directorio remoto del cual listar/obtener

Minimum string length: 1
Ejemplo:

"outbound/returns"

port
integer<int64>
requerido

Puerto del endpoint remoto

Rango requerido: 1 <= x <= 65535
Ejemplo:

22

connectOptions
object

Ajuste de transporte no secreto opcional (p. ej. known_hosts, user, timeout_seconds)

format
string

Sugerencia de formato de contenido de respaldo aplicada cuando un objeto obtenido no declara ninguno. Acepta la clave FormatDescriptor con espacio de nombres (región/familia/variante) o los alias planos heredados (cnab240, cielo_edi, ...); ambos se resuelven a través del mismo registro de parsers

Ejemplo:

"br/cnab240/febraban-base"

glob
string

Filtro glob opcional; vacío obtiene todo

Ejemplo:

"*.ret"

kind
enum<string>

Tipo de transporte que selecciona el adaptador

Opciones disponibles:
sftp,
https,
s3,
imap
Ejemplo:

"sftp"

Respuesta

Aceptado

files
object[] | null
requerido

Resultados por archivo del lote de obtención e ingesta, en orden de obtención