Antes de iniciar suas integrações com as APIs da BigDataCorp, é importante garantir que todos os requisitos abaixo estejam atendidos. Esta página reúne os passos essenciais para habilitar seu ambiente de integração, desde o acesso inicial até a validação de tokens e endpoints.

Cumprir essas etapas garante que suas chamadas de API sejam autenticadas corretamente e que o ambiente esteja preparado para uma operação segura, estável e eficiente.

1️⃣ Ser um cliente ativo

Para utilizar as APIs da BigDataCorp, é necessário possuir uma conta ativa. Se ainda não é cliente, entre em contato para realizar o cadastro e obter acesso ao BDC Center.

2️⃣ Ter um usuário de integração

No BDC Center, crie um usuário de serviço dedicado às integrações via API. Esse usuário será responsável pelas autenticações e chamadas realizadas pelos sistemas da sua empresa.

Mais informações sobre gestão de usuários, autenticação e segurança estão disponíveis na seção Autenticação e Segurança.

⚠️
Atenção:
Utilize um e-mail corporativo válido e mantenha o acesso à ele restrito ao time técnico responsável pela integração.

3️⃣ Gerar o Token JWT

Com o usuário de integração criado, gere seu Token JWT, ele é necessário para autenticar todas as chamadas às APIs. Você pode gerar o token:

Diretamente no BDC Center, ou
Pela API de Tokens, para automatizar a geração e rotação.

Mais detalhes sobre geração, expiração e rotação de tokens estão disponíveis em Autenticação e Segurança → Rotacionamento de Tokens.

4️⃣ Confirmar acesso ao endpoint da entidade

Verifique se você possui acesso ao endpoint da entidade que deseja integrar. Todas as entidades da Plataforma de Dados utilizam o mesmo domínio base:

https://plataforma.bigdatacorp.com.br/

O que varia é o caminho específico de cada entidade. Alguns exemplos:

.../pessoas → chamadas aos datasets de Pessoas
.../empresas → chamadas aos datasets de Empresas
.../ondemand → chamadas aos datasets On-demand

5️⃣ Validar o ambiente de integração

Antes de iniciar o uso em produção:

Teste suas requisições utilizando o token gerado,
Valide os formatos de retorno e as respostas da API (exemplos disponíveis em Primeira Consulta).
Armazene tokens e credenciais em variáveis de ambiente, evitando exposição em código-fonte ou repositórios.

⚠️
Importante:
A ausência de qualquer um dos itens acima impedirá a execução das chamadas às APIs. Certifique-se de concluir todas as etapas antes de seguir para Primeira Consulta.