VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Exportação para BI

Envia dados da loja (pedidos, produtos, clientes, estoque, comissões) para um bucket S3 seu, de forma incremental, para análise em ferramentas de BI.

Quem faz análise de dados costuma querer os números da loja fora da loja: em um data lake, em um Looker, num notebook. A exportação para BI (warehouse export) copia seis conjuntos de dados para um bucket S3 (ou compatível, como MinIO ou Cloudflare R2) que você controla, em arquivos Parquet ou CSV, em horário fixo, mandando só o que mudou desde a última vez.

Você configura dois recursos: um destino (o bucket e as credenciais) e um ou mais jobs (qual conjunto exportar, em que formato e com que frequência).

Estas rotas não têm relação com armazém físico ou estoque de depósito: "warehouse" aqui é data warehouse.

Pontos-chave
  • Todas as rotas exigem o privilégio manage_settings, inclusive as de leitura.
  • As credenciais (access_key, secret_key) são só de escrita: ficam criptografadas e nenhuma resposta as devolve.
  • Os dados saem incrementais: cada job guarda uma marca d'água (watermark) e só exporta o que mudou depois dela.
  • Dinheiro sai em centavos (colunas terminadas em _cents); registros apagados continuam no arquivo, com deleted_at preenchido.
  • A cada 15 minutos um agendador executa os jobs que venceram (hourly ou daily). Depois de 3 falhas seguidas, o job se desativa.
  • Existem exatamente seis conjuntos de dados, descritos em Conjuntos de dados.

Como funciona

  1. Crie o destino

    Informe bucket, região, endpoint (se não for AWS) e as chaves. Use Testar para conferir que a plataforma consegue gravar no bucket.

  2. Crie um job por conjunto de dados

    Escolha dataset, format, csv_style e schedule. Já nasce ativo e com marca d'água zerada: a primeira execução exporta tudo.

  3. Deixe rodar, ou rode agora

    O agendador executa o job quando ele vence. Para antecipar, use Executar agora.

  4. Acompanhe

    Cada execução vira um registro (success ou failed) com a quantidade de linhas e o caminho do último arquivo.

Conceitos-chave

Marca d'água

A marca d'água é a data da última linha exportada. Cada execução pede ao banco as linhas com data de alteração (ou de criação, em conjuntos que nunca mudam) maiores que ela e só a avança depois que o arquivo foi gravado no bucket com sucesso. Uma queda no meio nunca perde linhas: no pior caso, repete. Zerar a marca d'água reexporta tudo na próxima execução.

Arquivos no bucket

Cada página de até 50 mil linhas vira um arquivo em <prefix>/<dataset>/v1/dt=<AAAA-MM-DD>/<tempo>_<id>.<parquet|csv>. O dt= usa o dia em que o arquivo foi gerado, no fuso da loja. O v1 é a versão do esquema.

Parquet e CSV

Parquet é o padrão: compacto e tipado. No CSV, csv_style: "international" escreve centavos como inteiro e datas em ISO 8601; "brazilian" escreve reais com vírgula (49,90) e datas dd/mm/aaaa hh:mm:ss.

Endpoints

Método e caminhoPara quêPágina
GET/POST /api/v1/admin/warehouse/destinationsLista e cria destinosDestinos
PUT/DELETE /api/v1/admin/warehouse/destinations/{id}Altera e apagaDestinos
POST /api/v1/admin/warehouse/destinations/{id}/testTesta a gravaçãoDestinos
GET/POST /api/v1/admin/warehouse/jobsLista e cria jobsJobs
PUT/DELETE /api/v1/admin/warehouse/jobs/{id}Altera e apagaJobs
POST /api/v1/admin/warehouse/jobs/{id}/run-nowExecuta agoraExecuções
POST /api/v1/admin/warehouse/jobs/{id}/reset-watermarkReexporta tudoExecuções
GET /api/v1/admin/warehouse/jobs/{id}/runsHistóricoExecuções
GET /api/v1/admin/warehouse/datasetsCatálogo de colunasConjuntos de dados

Erros comuns

  1. Esperar validação dos campos do destino. A API aceita name e bucket vazios; o erro só aparece no teste ou na primeira execução.
  2. Usar PUT de job com um campo só. O PUT regrava format, csv_style, schedule e is_active; o que faltar vira vazio e a gravação é recusada.
  3. Criar o mesmo job duas vezes. A combinação destino, conjunto e formato é única.
  4. Achar que a resposta de criação reflete o estado. A criação do job devolve is_active: false e marca d'água zerada mesmo que o job tenha nascido ativo.
  5. Ignorar deleted_at. Registros apagados na loja seguem no arquivo; aplique a exclusão no seu lado.
  6. Esperar execução imediata ao criar. O agendador roda a cada 15 minutos.

Próximos passos

Destinos
Cadastre o bucket e teste a gravação.
Jobs
Escolha o que exportar e quando.
Conjuntos de dados
Veja as colunas de cada conjunto.
Anterior
Configuração e histórico
Próxima
Destinos de exportação
Nesta página
  • Como funciona
  • Conceitos-chave
  • Marca d'água
  • Arquivos no bucket
  • Parquet e CSV
  • Endpoints
  • Erros comuns
  • Próximos passos