Esta página foi criada para ajudar você a entender como navegar pela API Reference da Plataforma de Dados da BigDataCorp. Aqui, você encontrará orientações sobre:

Onde localizar cada informação dentro das páginas de endpoint,
Como identificar rapidamente os elementos necessários para a integração, e
Como utilizar o console interativo para realizar e validar chamadas diretamente pela documentação.

O objetivo é facilitar sua navegação, permitindo explorar, testar e implementar integrações com as APIs da BigDataCorp de forma mais simples, rápida e eficiente.

📌 Guia rápido: onde encontrar cada informação

Informação	Onde encontrar
Nome do dataset/tecnologia/plugin	Título da página
Endpoint e método HTTP	Logo abaixo do título
Descrição do dataset/tecnologia/plugin	Seção Descrição, no centro da página
Regras de preço	Seção Tabela de preços, no centro da página
Outras informações relevantes (quando aplicável)	Logo abaixo da Tabela de preços
Linguagens de programação de exemplo	Seletor Language, no canto superior direito
Inserir as credenciais da API	Seção Credentials, no canto superior direito
Exemplo de requisição	Console cURL Request, quadro preto no canto superior direito
Resultado da chamada e exemplo de resultado	Área de resposta do console, abaixo do quadro preto da direita
Histórico de chamadas executadas utilizando o Console	Seção Recent Requests, no final da página
Parâmetros da requisição	Seção Body Params, no final da página
Estrutura da resposta, com descrição dos campos principais	Seção Response, no final da página

🔎 Informações gerais

Na região central da página, você encontra as principais informações para entender o contexto da API e como utilizá-la.

Aqui você encontra:

Nome do dataset, tecnologia ou plugin
Método HTTP e endpoint da requisição
Descrição funcional da API
Tabela de preços
Informações adicionais (quando aplicável)

Use essa seção para entender rapidamente o que a API faz, quando utilizá-la e quais são suas regras de consumo.

💻 Exemplo de requisição e retorno

No painel lateral direito, você encontra o console interativo da API.

Página de endpoint: console de requisição

Aqui você pode:

Visualizar o código da requisição pronto para uso
Selecionar a linguagem de integração desejada (Shell, Node, Ruby, PHP, Python etc.)
Copiar e adaptar o código para sua aplicação
Executar a chamada diretamente pela documentação

Logo abaixo do console, está a área de resposta.

Página de endpoint: área de retorno da chamada

Nessa seção, você pode:

Visualizar exemplos de retorno com e sem dados (quando disponível)
Validar o resultado da sua chamada
Copiar o retorno para testes e desenvolvimento

🧩 Campos e tipos de retorno

Ao final da página, a seção Response apresenta a estrutura detalhada do retorno da API.

Página de endpoint: campos da resposta, tipos de retorno e descrições

Aqui você pode:

Identificar os campos retornados
Ver o tipo de dado de cada campo
Entender o significado de cada informação
Explorar campos adicionais expansíveis (quando disponíveis)

Use essa seção para implementar corretamente o tratamento da resposta na sua integração.

▶️ Fazendo uma requisição pela documentação

Você pode testar a API diretamente pela API Reference.

Página de endpoint: fazer uma requisição pela documentação

Siga os passos abaixo:

Preencha os parâmetros na seção Body Params
Insira suas credenciais de acesso em Credentials
Selecione a linguagem desejada
Clique em Try It para executar a requisição
Visualize o resultado na seção Response, logo abaixo do console.

🕘 Histórico de requisições

Na seção Recent Requests, ao final da página, você pode acompanhar as chamadas realizadas.

Use essa área para:

Revisar requisições executadas
Validar respostas anteriores
Apoiar testes e depuração