Saltar al contenido

Traducción automática — la versión en portugués es la referencia. Ver en portugués

Actualizado el 2026-10-04

VTEX — conector

Lee pedidos del OMS y el catálogo público de productos de la API de VTEX y los carga en la capa Bronze.

En esta página (15)

Leia antes: ../conectores.md (mapa de estados) y fichas.md (índice de las fichas).


Qué es#

Lee pedidos del OMS y el catálogo público de productos de la API de VTEX y los carga en la capa Bronze.

Modos de ingestión soportados:

  • Nós buscamos — Nós buscamos os dados na sua fonte.

Para qué sirve#

Traer los datos de VTEX a su datalake y dejarlos disponibles en 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#

Usar 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#

  • Plano: núcleo del producto (los conectores forman parte de todos los planos; 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.
  • Desconexión: la ejecución de ingestión puede desactivarse temporalmente (mantenimiento o incidente). Cuando esto ocurre, la pantalla informa que el recurso no está disponible en este momento.

Requisitos previos#

  • Una cuenta VTEX con acceso a los datos que desea ingerir.
  • En el Admin VTEX, vaya a Configurações da conta → Chaves de aplicação, cree una clave con los perfiles de acceso OMS - Full access (lectura de pedidos) y Catalog (lectura de productos) y pegue aquí la AppKey y el AppToken. El AppToken está cifrado (AES-256-GCM) y nunca se muestra de nuevo.

Credenciales#

Forma de autenticación: Clave de API generada en el panel del proveedor, enviada en encabezado/parámetro.

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.

  • AppToken (appToken) — Secreto de la clave de aplicación (X-VTEX-API-AppToken).

Los secretos nunca se reexhiben y pasan por la redacción en todo error/log (token en crudo, URL-encoded y en JSON).

Campos del formulario#

CampoRótuloTipoObligatorioObservación
accountNameNome da contatextosimO account name da VTEX — o prefixo de https://minhaloja.vtexcommercestable.com.br.
environmentAmbientetextonãopadrão: vtexcommercestable; Quase sempre vtexcommercestable; só mude se a VTEX indicou outro ambiente.
appKeyAppKeytextosimIdentificador público da chave de aplicação (X-VTEX-API-AppKey).
appToken 🔒AppTokensenha/segredosimsegredo (cifrado; cofre externo opcional); Segredo da chave de aplicação (X-VTEX-API-AppToken).

Paso a paso#

  1. No menu Dados → Conexões, use Nova conexão.
  2. Elija VTEX en el catálogo.
  3. Complete los campos del formulario (vea la tabla arriba).
  4. 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.
  5. Use Salvar conexão. Salvar NÃO inicia ingestión ninguna.
  6. 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.
  7. 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):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
accountName = <accountName>
environment = vtexcommercestable
appKey = 1234567890123
appToken = •••••• (cifrado — nunca exibido)

Resultado esperado#

El Testar conexão retorna 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: límite duro por ejecución (por defecto 10.000 páginas / 5.000.000 filas); guarda anti-loop.
  • Carga SaaS: por defecto batchSize 5.000, maxRows 200.000 por recurso.
  • Volumen estimado: ~0.5 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 fugas entre workspaces.
  • Secretos cifrados: material sensible se cifra con AES-256-GCM antes de ser guardado. El cofre externo de credenciales es opcional y se activa 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 vez 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 peticiones (429) — el proveedor pidió esperar. La extracción respeta Retry-After y reintenta; si se repite, espere y reduzca la frecuencia de la agenda.
  • Recurso no encontrado — revise el identificador del recurso (cuenta, objeto, informe) y los permisos concedidos.
  • Cursor de paginación bloqueado — 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 indicando el conector y el recurso.
  • Camino de registros vacío — la respuesta llegó sin registros en el lugar esperado. Revise 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 programar.
  • Siga las ejecuciones en la observabilidad por conector (tasa de error, p50/p95, freshness).
  • Un cambio de esquema en la fuente se señala por el schema drift (columna nueva = info; columna removida/tipo cambiado = atención).

Relacionados#


Última revisión: 2026-10-04. Ficha generada automáticamente del catálogo de conectores del producto.

Enlaces relacionados