As consultas da Plataforma de Dados seguem uma estrutura padronizada, utilizada em todas as APIs da BigDataCorp.

Nesta seção, você aprenderá:

Como organizar corretamente os parâmetros no corpo da requisição.

O papel de cada parâmetro na construção da consulta.

Como montar consultas consistentes e reutilizáveis.

Como utilizar o padrão adotado em todas as APIs da plataforma.

Esses conceitos formam a base para a construção de consultas e serão fundamentais para compreender os próximos tópicos da documentação, incluindo parâmetros de consulta, chaves de identificação, personalização de retorno e recursos adicionais.

⭐
Ao concluir esta seção, você terá uma visão completa da estrutura base das consultas realizadas na Plataforma de Dados.

1️⃣ Estrutura básica da requisição

As APIs da Plataforma de Dados utilizam o método POST, e recebem, no corpo da requisição, três parâmetros principais:

q – chaves de busca (obrigatório)
Datasets – datasets desejados no retorno (obrigatório)
Limit – limite máximo de entidades retornadas (opcional)

{
  "q": "doc{12345678900}",
  "Datasets": "basic_data"
}

ℹ️
Essa estrutura é compartilhada por todas as APIs da Plataforma de Dados, incluindo Pessoas, Empresas, Endereços, Processos, Veículos e demais entidades disponíveis.