Lea antes:
../conectores.md(mapa de estados) yfichas.md(índice de las fichas).
Qué es#
Lee los registros de una API REST JSON descrita por usted (URL, ruta que lista los registros, dónde está el array en el JSON y cómo pagina: por página, offset o URL en el cuerpo). Carga los datos en la capa Bronze.
Modos de ingesta soportados:
- Nós buscamos — Nosotros buscamos los datos en su fuente.
Para qué sirve#
Traer los datos de API REST genérica a su datalake y ponerlos a disposición en las capas Bronze/Silver/Gold, en los modelos de BI y en el wizard de preguntas en lenguaje natural.
Cuándo usar / cuándo no usar#
Use cuando necesita consolidar esta fuente en el datalake de forma programada, 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 atraso, suspendida o cancelada, la ejecución queda bloqueada.
- Apagado: la ejecución de ingesta puede ser desactivada temporalmente (mantenimiento o incidente). Cuando esto sucede, la pantalla informa que el recurso está indisponible en este momento.
Prerrequisitos#
- Una cuenta API REST genérica con acceso a los datos que desea ingerir.
- Describa la API: la URL base, la ruta que lista los registros, dónde está el array en el JSON (ej.: data) y cómo pagina (por página, offset o URL de la próxima página en el cuerpo). Si la API exige token, péguelo abajo — se envía como Authorization: Bearer y está cifrado (AES-256-GCM). Las columnas se descubren en la primera lectura.
Credenciales#
Forma de autenticación: Token de acceso pegado por usted. Está cifrado (AES-256-GCM) y nunca se muestra de nuevo, ni aparece en logs o mensajes de error.
Campos sensibles. Están 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.
- Token Bearer (
token) — Enviado como Authorization: Bearer <token>. Déjelo vacío para APIs abiertas.
Los secretos nunca se vuelven a mostrar y pasan por redacción en todo error/log (token crudo, URL-encoded y en JSON).
Campos del formulario#
| Campo | Rótulo | Tipo | Obligatorio | Observación |
|---|---|---|---|---|
baseUrl | URL base | texto | sí | Comienza con https://. La ruta abajo se suma a ella. |
caminho | Ruta del recurso | texto | sí | Endpoint que LISTA los registros (una tabla Bronze por fuente). |
metodo | Método HTTP | selección | no | predeterminado: GET; opciones: GET / POST |
caminhoLista | Ruta del listado en la respuesta | texto | no | Dónde está el array de registros en el JSON (ej.: data, results, data.items). Vacío = la respuesta ya es el array. |
paginacao | Paginación | selección | no | predeterminado: ninguna; opciones: ninguna / pagina / offset / urlNoCorpo |
paramPagina | Parámetro de página / offset | texto | no | predeterminado: page; aparece cuando paginacao = pagina / offset; Por página: el número de la página (ej.: page). Por desplazamiento: el parámetro de offset (ej.: offset, skip). |
paramTamanho | Parámetro de tamaño de página | texto | no | predeterminado: limit; aparece cuando paginacao = pagina / offset / urlNoCorpo; Ej.: limit, per_page, page_size. Vacío = no enviar. |
tamanhoPagina | Tamaño de la página | número | no | predeterminado: 100; aparece cuando paginacao = pagina / offset / urlNoCorpo; Use el MÁXIMO que la API acepta: la lectura se detiene en la primera página que venga más corta que esto. |
caminhoProximaUrl | Ruta de la próxima URL | texto | no | predeterminado: next; aparece cuando paginacao = urlNoCorpo; Dónde la respuesta trae la URL de la próxima página (ej.: next, links.next, paging.next). Acepta URL relativa. |
token 🔒 | Token Bearer | contraseña/secreto | no | secreto (cifrado; cofre externo opcional); Enviado como Authorization: Bearer <token>. Déjelo vacío para APIs abiertas. |
queryExtra | Query extra | texto | no | Parámetros fijos sumados a toda llamada (formato clave=valor&clave=valor). |
Paso a paso#
- En el menú Dados → Conexões, use Nova conexão.
- Elija API REST genérica 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 ingesta.
- 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 se copia.
- 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; secretos aparecen enmascarados):
# Exemplo sintético (valores fictícios — não são credenciais reais)
baseUrl = <baseUrl>
caminho = <caminho>
metodo = GET
caminhoLista = <caminhoLista>
paginacao = nenhuma
token = •••••• (cifrado — nunca exibido)
queryExtra = <queryExtra>Resultado esperado#
El Testar conexão devuelve la lista de tablas/recursos descubiertos. Después de 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 (por defecto 10.000 páginas / 5.000.000 filas); guarda anti-loop.
- Carga SaaS: por defecto
batchSize5.000,maxRows200.000 por recurso. - Volumen estimado: ~0.1 GB/mes (estimación de catálogo, no medición).
- **
Seguridad#
- Ámbito por workspace: cada cliente lee y escribe sólo en su propio datalake (
<prefixo>_bronze/_silver/_gold); nunca hay fuga entre workspaces. - Secretos cifrados: el material sensible se cifra con AES-256-GCM antes de grabarse. El cofre externo de credenciales es opcional y se liga por conexión; sin él, el valor cifrado queda en la base. Cambiar el valor aquí NO revoca la credencial en la fuente.
- Redacción: todo error/log pasa por la redacción de secretos (crudo, URL-encoded y en JSON).
- Producción no simula: una ruta que caerìa en mock activa la guarda 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 detenido — la extracción termina 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 (período, 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 programar.
- Acompañe las ejecuciones en la observabilidad por conector (tasa de error, p50/p95, freshness).
- Un cambio de esquema en la fuente es señalizado por el schema drift (columna nueva = info; columna eliminada/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— programación, 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.