Primeira consulta

Agora que você já tem suas credenciais e tokens válidos, é hora de realizar sua primeira chamada.

Vamos realizar a suaprimeira chamada às APIs da BigDataCorp de forma simples e segura?

Aqui você encontrará exemplos práticos de requisições para diferentes entidades , mostrando como utilizar seu token JWT, configurar os headers necessários e interpretar os retornos recebidos.

O objetivo é que você consiga validar rapidamente a integração com a nossa Plataforma de Dados, seguindo o formato padrão de chamadas adotado em todas as APIs da BigDataCorp.



🔑 Usando seu Token JWT

Todas as chamadas às APIs da BigDataCorp exigem autenticação via tokens JWT, utilizando os headers AccessToken e TokenId.

     --header 'AccessToken: SEU-ACCESSTOKEN' \
     --header 'TokenId: SEU-TOKENID' \

Esses tokens podem ser gerados diretamente no BDC Center ou pela API de Tokens.


📘

Mais detalhes sobre autenticação e segurança estão disponíveis na seção Autenticação e segurança.



⚙️ Fazendo as chamadas

Abaixo você encontra um exemplo real de requisição, demonstrando o formato padrão utilizado na Plataforma de Dados da BigDataCorp.


API de Pessoas | Dados Cadastrais Básicos

curl --request POST \
     --url https://plataforma.bigdatacorp.com.br/pessoas \
     --header 'AccessToken: SEU-ACCESSTOKEN' \
     --header 'TokenId: SEU-TOKENID' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "q": "doc{NUMERO-DO-CPF}",
  "Datasets": "basic_data"
}
'

Se a autenticação estiver correta:

A resposta trará um conteúdo JSON com os dados cadastrais básicos do CPF consultado.
Caso contrário, verifique se:

  • O token é válido e não expirou;
  • Os headers AccessToken e TokenId estão corretamente informados;
  • O endpoint está correto (.../pessoas);
  • O dataset informado está correto (basic_data);
  • O CPF foi informado corretamente, dentro do parâmetro q, no seguinte formato: doc{NUMERO-DO-CPF}.
💡

Lembrete:

O formato de autenticação é o mesmo para todas as APIs da Plataforma de Dados. Basta ajustar o endpoint de acordo com a entidade desejada. Por exemplo:

.../pessoas → chamadas aos datasets de Pessoas

.../empresas → chamadas aos datasets de Empresas