Lea antes:
../conectores.md(mapa de estados) yfichas.md(índice de las fichas).
Qué es#
Lee facturas, suscripciones, clientes y transacciones de la API v1 de Vindi y carga en la capa Bronze.
Modos de ingestión soportados:
- Nosotros buscamos — Nosotros buscamos los datos en su fuente.
Para qué sirve#
Traer los datos de Vindi a su datalake y disponibilizarlos a las capas Bronze/Silver/Gold, a los modelos de BI y al asistente de preguntas en lenguaje natural.
Cuándo usar / cuándo no usar#
Use cuando necesita consolidar esta fuente en el datalake de forma agendada, con aislamiento por workspace.
Recuerde que la primera ejecución con credencial real la acompaña nuestro equipo antes de la liberación completa del conector.
Plan y permisos#
- Plan: núcleo del producto (los conectores forman parte de todos los planes; el límite es el número de fuentes del plan).
- Acceso: requiere workspace activo — con la suscripción en mora, suspendida o cancelada, la ejecución queda bloqueada.
- Desactivación: la ejecución de ingestión puede ser desactivada temporalmente (mantenimiento o incidente). Cuando esto sucede, la pantalla informa que el recurso está indisponible en este momento.
Requisitos previos#
- Una cuenta Vindi con acceso a los datos que desea ingerir.
- En Vindi, vaya a Configurações → Chaves de API y genere una clave (preferiblemente solo-lectura). Péguela abajo; la clave es cifrada (AES-256-GCM) y nunca se muestra de nuevo. Para validar sin tocar producción, elija el entorno Sandbox (clave generada en sandbox-app).
Credenciales#
Forma de autenticación: Usuario y contraseña (o clave y secreto) en autenticación Basic.
Campos sensibles. Son cifrados (AES-256-GCM) y nunca quedan en el config de la conexión, en la definición del pipeline, en el export o en la DAG. Por defecto el valor cifrado queda en la base; mover la credencial de esta conexión al cofre externo de credenciales es una elección explícita, hecha por conexión después de guardar — ver ../../administracao/credenciais-e-rotacao.md.
- Chave da API (
chaveApi) 🔒 — Clave de la API v1 (Configurações → Chaves de API). Va como usuario del HTTP Basic, con contraseña vacía.
Los secretos nunca se vuelven a mostrar y pasan por la redacción en todo error/log (token crudo, URL-encoded y en JSON).
Campos del formulario#
| Campo | Rótulo | Tipo | Obligatorio | Observación |
|---|---|---|---|---|
ambiente | Ambiente | selección | no | predeterminado: producao; opciones: producao / sandbox |
chaveApi 🔒 | Chave da API | senha/segredo | sí | secreto (cifrado; cofre externo opcional); Chave da API v1 (Configurações → Chaves de API). Va como usuario del HTTP Basic, con contraseña vacía. |
Paso a paso#
- En el menú Dados → Conexões, use Nova conexão.
- Elija Vindi en el catálogo.
- Complete los campos del formulario (vea la tabla arriba).
- Use Testar conexão. El resultado viene separado en Conectividade, Autenticação y Listagem/leitura — cada uno con OK, Falló, No aplica o No probado. Una capacidad sin prueba propia para este conector aparece como No aplica, y No aplica nunca cuenta como éxito.
- Use Salvar conexão. Guardar NO inicia ninguna ingestión.
- En la tarjeta de la conexión, use Montar extração (o vaya a Orquestração → Pipelines y use Conectar fonte). El pipeline apunta a la conexión guardada — la credencial no es copiada.
- En la revisión, Publicar (agenda desligada) crea la versión 1 sin ejecutar nada. Después, Ativar agenda y Executar agora son acciones separadas.
Ejemplo — prueba de conexión#
Configuración de ejemplo (todos los valores son ficticios; los secretos aparecen enmascarados):
# Exemplo sintético (valores fictícios — não são credenciais reais)
ambiente = producao
chaveApi = •••••• (cifrado — nunca exibido)Resultado esperado#
El Testar conexão devuelve la lista de tablas/recursos descubiertos. Tras la primera carga, las filas aparecen en la capa Bronze de su workspace, listas para el pipeline.
Límites y costos#
- Paginación: techo duro por ejecución (default 10.000 páginas / 5.000.000 filas); guarda anti-loop.
- Carga SaaS: default
batchSize5.000,maxRows200.000 por recurso. - Volumen estimado: ~0.3 GB/mes (estimación de catálogo, no medición).
- **
Seguridad#
- Ámbito por workspace: cada cliente lee y escribe solo en su propio datalake (
<prefixo>_bronze/_silver/_gold); nunca hay fuga entre workspaces. - Secretos cifrados: material sensible es cifrado con AES-256-GCM antes de ser grabado. El cofre externo de credenciales es opcional y se conecta por conexión; sin él, el valor cifrado queda en la base. Cambiar el valor aquí NO revoca la credencial en el origen.
- Redacción: todo error/log pasa por la redacción de secretos (crudo, URL-encoded y en JSON).
- Producción no simula: un camino que caería en mock activa la protección de producción (falla explícita en lugar de simular éxito).
Errores comunes#
- Credencial rechazada (401/403) — el proveedor no aceptó la credencial: expirada, revocada o sin el permiso necesario. Reconecte la fuente (la fuente y el historial se preservan; no recree la fuente).
- Límite de solicitudes (429) — el proveedor pidió esperar. La extracción respeta
Retry-Aftery reintenta; si se repite, espere y reduzca la frecuencia de la agenda. - Recurso no encontrado — verifique el identificador del recurso (cuenta, objeto, informe) y los permisos concedidos.
- Cursor de paginación atascado — la extracción finaliza cuando el cursor de la API no avanza (guarda anti-loop). Si ocurre en ejecuciones seguidas, abra un ticket con soporte informando el conector y el recurso.
- Ruta de registros vacía — la respuesta llegó sin registros en el lugar esperado. Verifique el recurso seleccionado y los filtros (periodo, cuenta, estado) antes de asumir que no hay datos.
Solución de problemas#
- Use Testar conexão para aislar problemas de credencial/red antes de agendar.
- Siga las ejecuciones en la observabilidad por conector (tasa de error, p50/p95, freshness).
- Un cambio de esquema en el origen se señala por el schema drift (columna nueva = info; columna removida/tipo cambiado = atención).
Relacionados#
../conectores.md— catálogo de conectores por estado../ingestao-incremental-backfill.md— full, incremental por watermark, backfill y checkpoint../pipeline-medalhao.md— capas Bronze/Silver/Gold y calidad../agendamento-retry-dlq.md— agendamiento, retry/backoff y DLQ../custo-limites-seguranca.md— costo, techos y seguridad por workspace
Última revisión: 2026-10-04. Ficha generada automáticamente del catálogo de conectores del producto.