Confira dicas e boas práticas que ajudam a manter sua integração segura, estável e eficiente.
Seguir boas práticas de integração ajuda a tornar suas operações mais seguras, estáveis e escaláveis. Nesta seção, reunimos recomendações para melhorar a gestão de credenciais, otimizar chamadas às APIs e aumentar a confiabilidade das integrações com a Plataforma de Dados da BigDataCorp.
Seguindo essas práticas, sua integração permanecerá segura, escalável e confiável em todas as APIs da BigDataCorp.
🔐 Segurança e autenticação
Garantir a segurança dos tokens e usuários é essencial para proteger suas integrações.
Não armazene tokens no código-fonte; use variáveis de ambiente seguras.
Mantenha usuários e tokens distintos para teste e produção.
Cada aplicação deve ter credenciais próprias.
Evite tokens com validade excessiva e siga a política da sua empresa.
🔁 Rotacionamento de tokens
A rotação de tokens previne problemas de segurança e garante que suas integrações funcionem de forma contínua e confiável.
Configure intervalos regulares para gerar novos tokens.
Gere novos tokens com antecedência para evitar falhas.
Não rotacione repetidamente em curtos intervalos.
⚙️ Integração
Seguir boas práticas de integração aumenta a confiabilidade e facilita a manutenção das chamadas às APIs.
Use usuários, tokens, endpoints e parâmetros distintos para validação e produção, preferencialmente via variáveis de ambiente.
Analise o corpo das respostas JSON e monitore falhas diretamente nas requisições.
Guarde registros com headers, payloads e códigos de status para auditoria e suporte técnico.
Adote retries com backoff exponencial para lidar com erros transitórios e manter estabilidade.
Distribua as chamadas para evitar sobrecarga, respeitando o limite de 5.000 requisições a cada 5 minutos por IP.
Ao identificar o status -205 — DEPRECATED DATASET, revise o uso do dataset e planeje a migração quando aplicável.
🧠 Testes e validação
Testes consistentes garantem que a integração esteja funcionando antes de operar em produção.
Use um usuário específico e com limite de requisições para testar chamadas.
Faça chamadas simples para confirmar que tudo está funcionando.
Consulte o JSON retornado para entender mensagens e detalhes explicativos.
Guarde o ticketID ou QueryID e envie ao suporte quando necessário.
⚡ Performance e consumo
Aplicar boas práticas de consumo mantém a integração eficiente e evita sobrecarga nos sistemas.
Evite múltiplas requisições pequenas quando puder consolidar consultas.
Prefira chamadas em lote quando esse recurso estiver disponível.
Use filas ou mecanismos assíncronos para controlar grandes volumes.
