Início rápido da API do Reporter

Este guia é destinado a desenvolvedores. Se você está procurando uma visão geral de nível de negócio sobre o que o Reporter faz, veja O que é o Reporter?.

Coloque o Reporter em funcionamento em minutos. Este guia percorre o caminho completo, desde o upload do seu primeiro template até o download de um relatório gerado.

Antes de começar

Você precisa de:

Uma instância do Reporter em execução
Um token de autenticação válido (se o Access Manager estiver habilitado)
Um arquivo de template .tpl pronto para upload

Todos os exemplos usam cURL. Substitua *** em cada cabeçalho Authorization pelo seu token de autenticação e https://reporter.example.com pela URL do seu Reporter.

Passo 1: Fazer upload de um template

Faça upload de um arquivo .tpl que define a estrutura e o conteúdo do seu relatório. O conteúdo do template deve corresponder ao formato de saída selecionado: HTML para HTML e PDF, XML para XML, CSV para CSV e texto não vazio para TXT. O arquivo enviado deve ter extensão .tpl.

Referência da API: Upload de template

cURL

curl -X POST "https://reporter.example.com/v1/templates" \
 -H "Authorization: Bearer ***" \
 -F "template=@account_summary.tpl" \
 -F "outputFormat=PDF" \
 -F "description=Relatório de resumo diário de contas"

{
  "id": "0196b270-a315-7137-9408-3f16af2685e1",
  "outputFormat": "pdf",
  "description": "Relatório de resumo diário de contas",
  "fileName": "0196b270-a315-7137-9408-3f16af2685e1.tpl",
  "createdAt": "2026-03-05T10:00:00Z",
  "updatedAt": "2026-03-05T10:00:00Z"
}

Guarde o id do template. Você o usará para gerar relatórios.

Formatos de saída suportados

Formato	Caso de uso
`CSV`	Exportações de dados e integração com planilhas
`XML`	Dados estruturados e envios regulatórios
`HTML`	Relatórios visualizáveis no navegador
`PDF`	Documentos prontos para impressão e compartilhamento
`TXT`	Texto simples e integração com sistemas legados

Passo 2: Verificar o template

Liste seus templates para confirmar que o upload foi bem-sucedido.

Referência da API: Listar templates

cURL

curl -X GET "https://reporter.example.com/v1/templates" \
 -H "Authorization: Bearer ***"

Passo 3: Gerar um relatório

Envie uma requisição de geração de relatório com o ID do template e o objeto obrigatório filters. Adicione filtros para restringir os dados ou envie {} quando não precisar filtrar.

Referência da API: Criar relatório

cURL

curl -X POST "https://reporter.example.com/v1/reports" \
 -H "Authorization: Bearer ***" \
 -H "Content-Type: application/json" \
 -d '{
   "templateId": "0196b270-a315-7137-9408-3f16af2685e1",
   "filters": {
     "midaz_onboarding": {
       "account": {
         "created_at": {
           "between": ["2026-03-01", "2026-03-05"]
         }
       }
     }
   }
 }'

{
  "id": "0196c5c0-5044-724f-95f3-4b32076e7ad7",
  "templateId": "0196b270-a315-7137-9408-3f16af2685e1",
  "templateOutputFormat": "pdf",
  "templateDescription": "Relatório de resumo diário de contas",
  "filters": {
    "midaz_onboarding": {
      "account": {
        "created_at": {
          "between": ["2026-03-01", "2026-03-05"]
        }
      }
    }
  },
  "status": "Processing",
  "metadata": null,
  "completedAt": null,
  "createdAt": "2026-03-05T10:05:00Z",
  "updatedAt": "2026-03-05T10:05:00Z",
  "deletedAt": null
}

Guarde o id do relatório para os próximos passos.

Estrutura de filtros

Os filtros seguem o caminho: fonte de dados > tabela > campo > operador > valores.

Operador	Descrição	Exemplo
`eq`	Igual a	`{ "eq": ["active"] }`
`gt` / `gte`	Maior que / maior ou igual	`{ "gte": ["2026-01-01"] }`
`lt` / `lte`	Menor que / menor ou igual	`{ "lt": [1000] }`
`between`	Valor dentro de um intervalo	`{ "between": ["2026-03-01", "2026-03-31"] }`
`in` / `nin`	Valor em / não em uma lista	`{ "in": ["active", "pending"] }`

O campo filters é obrigatório. Para gerar um relatório sem filtros, envie um objeto vazio: "filters": {}.

Passo 4: Verificar status do relatório

A geração de relatórios é assíncrona. Consulte o endpoint de status até que o relatório esteja pronto.

Referência da API: Verificar status do relatório

cURL

curl -X GET "https://reporter.example.com/v1/reports/0196c5c0-5044-724f-95f3-4b32076e7ad7" \
 -H "Authorization: Bearer ***"

Status	Significado
`Processing`	O Reporter está consultando dados e renderizando o template
`Finished`	O relatório está pronto para download
`Partial`	Algumas seções de dados foram geradas e outras falharam; o campo `metadata` do relatório carrega os códigos de erro por seção
`Error`	Um erro impediu a geração do relatório.

Aguarde o status Finished antes de prosseguir para o download.

Passo 5: Baixar o relatório

Quando o relatório estiver finalizado, baixe o arquivo gerado.

Referência da API: Baixar relatório

cURL

curl -X GET "https://reporter.example.com/v1/reports/0196c5c0-5044-724f-95f3-4b32076e7ad7/download" \
 -H "Authorization: Bearer ***" \
 -o account_summary.pdf

O arquivo é retornado com cabeçalhos Content-Disposition indicando o nome do arquivo e formato.

Passo 6: Explorar fontes de dados

Para entender quais dados estão disponíveis para seus templates, liste as fontes de dados configuradas. Em seguida, use GET /v1/data-sources/{dataSourceId} para inspecionar o esquema de uma fonte de dados.

Referência da API: Listar fontes de dados | Obter fonte de dados

cURL

curl -X GET "https://reporter.example.com/v1/data-sources" \
 -H "Authorization: Bearer ***"

A resposta de listagem identifica cada fonte de dados. A resposta de detalhe inclui as tabelas e os campos disponíveis, que você pode referenciar nos templates usando a sintaxe {{ datasource.table.field }}.

Próximos passos

O que é o Reporter?

Visão completa da sintaxe de templates, tags e filtros.

Formatos de templates

Exemplos práticos para templates HTML, XML e TXT.

Usando o Reporter

Guia detalhado sobre templates, armazenamento e configuração de fontes de dados.

Tratamento de erros

Lista completa de códigos de erro e como resolvê-los.

Primeiros passos

API de Templates

API do Construtor de Templates

API de Relatórios

API de Prazos

API de Fontes de Dados

API de Métricas

API de Streaming

Tratamento de erros

Início rápido da API do Reporter

Antes de começar

Passo 1: Fazer upload de um template

Formatos de saída suportados

Passo 2: Verificar o template

Passo 3: Gerar um relatório

Estrutura de filtros

Passo 4: Verificar status do relatório

Passo 5: Baixar o relatório

Passo 6: Explorar fontes de dados

Próximos passos

O que é o Reporter?

Formatos de templates

Usando o Reporter

Tratamento de erros

​Antes de começar

​Passo 1: Fazer upload de um template

​Formatos de saída suportados

​Passo 2: Verificar o template

​Passo 3: Gerar um relatório

​Estrutura de filtros

​Passo 4: Verificar status do relatório

​Passo 5: Baixar o relatório

​Passo 6: Explorar fontes de dados

​Próximos passos

O que é o Reporter?

Formatos de templates

Usando o Reporter

Tratamento de erros

Antes de começar

Passo 1: Fazer upload de um template

Formatos de saída suportados

Passo 2: Verificar o template

Passo 3: Gerar um relatório

Estrutura de filtros

Passo 4: Verificar status do relatório

Passo 5: Baixar o relatório

Passo 6: Explorar fontes de dados

Próximos passos