Esta página foi criada para ajudá-lo a entender como as consultas são estruturadas na Plataforma de Dados da BigDataCorp.
Aqui você aprenderá como organizar corretamente os parâmetros no corpo da requisição, compreender o papel de cada um deles e montar consultas consistentes, reutilizáveis e alinhadas ao padrão adotado em todas as APIs da plataforma.

Ao final desta seção, você terá uma visão completa da estrutura base de uma consulta, que servirá como ponto de partida para explorar, nas próximas páginas, os parâmetros disponíveis, as chaves de identificação, a personalização do retorno e os recursos adicionais.

Estrutura básica da requisição

As APIs da Plataforma de Dados utilizam o método POST, recebendo 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)

Consulta utilizando chave principal (CPF)

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

Consulta utilizando chaves alternativas e `Limit`

{
  "q": "name{josé da silva}, birthdate{01-01-1970}, dateformat{dd-mm-yyyy}",
  "Datasets": "basic_data",
  "Limit": 5
}

Essa estrutura é utilizada em todas as APIs da Plataforma de Dados (pessoas, empresas, endereços, processos, produtos, veículos etc.).

Próximos passos

Depois de compreender a estrutura básica da consulta, você pode evoluir para:

Parâmetros de consulta, onde encontrará todos os parâmetros obrigatórios e opcionais, incluindo chaves principais, alternativas e opcionais, seus conceitos, explicações e exemplos práticos.
Personalizar retorno, onde aprenderá a selecionar campos específicos, aplicar filtros e ordenar dados retornados.
Recursos adicionais, onde verá como enviar um documento hasheado e como adicionar tags às chamadas para rastrear fluxos ou operações internas.