Antes de iniciar suas integrações com as APIs da BigDataCorp, é importante garantir que todas as condições abaixo estejam atendidas. 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 esses requisitos assegura que suas chamadas de API sejam autenticadas corretamente e que o ambiente esteja pronto para execução segura e estável.

1️⃣ Ser um cliente ativo

Você precisa ter uma conta ativa na BigDataCorp. Se ainda não é cliente, entre em contato pelo e-mail comercial@bigdatacorp.com.br 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 específico para integrações. Esse usuário será responsável pelas chamadas realizadas via API. Mais detalhes sobre gestão de usuários e senhas 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 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 informações sobre geração e rotação 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/

Apenas o caminho muda conforme a entidade. Seguem 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 executar chamadas em produção:

Teste suas requisições com o token gerado.
Valide a resposta e formato de retorno (exemplos disponíveis em Primeira Consulta).
Armazene tokens em variáveis de ambiente, nunca em código-fonte.

⚠️
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.