Melhores Práticas da API Didit: Integração Eficaz (PT-PT)

Principais Conclusões

Melhores Práticas Priorize a gestão segura da chave de API, utilizando variáveis de ambiente e controlos de acesso.

Integração da API Utilize os SDKs da Didit para uma integração simplificada, mas compreenda a API subjacente para fluxos de trabalho personalizados.

Tratamento de Erros Implemente um tratamento de erros robusto com mecanismos de repetição e registo informativo para depuração.

Limites de Taxa Conceba a sua aplicação para respeitar e lidar com os limites de taxa da API Didit de forma elegante para garantir um serviço contínuo.

1. Considerações Arquiteturais para a Integração da API Didit

Integrar a API Didit na sua aplicação requer um planeamento arquitetural cuidadoso. Uma abordagem comum envolve uma arquitetura de microserviços, onde um “Serviço de Verificação” dedicado lida com todas as interações com a API Didit. Isto isola a lógica de verificação da sua aplicação principal e permite dimensionamento e atualizações independentes. Evite incorporar diretamente as chaves de API no seu código frontend; esta é uma vulnerabilidade de segurança crítica. Em vez disso, os seus servidores backend devem comunicar com a API Didit, atuando como um proxy para o seu frontend. Considere utilizar um Gateway de API para gerir a autenticação, a autorização e a limitação de taxa antes que os pedidos cheguem ao Serviço de Verificação.

Exemplo de Arquitetura:

[Frontend] --(Pedido API)--> [Gateway API] --(Autenticação/Autorização)--> [Serviço de Verificação] --(Pedido API Didit)--> [API Didit]

Para aplicações de elevado volume, a colocação em cache dos resultados da verificação pode reduzir significativamente as chamadas à API e melhorar o desempenho. Implemente estratégias de cache com base na sensibilidade dos dados e na frequência das alterações. Lembre-se de invalidar a cache quando os dados relevantes forem atualizados.

2. Gestão Segura da Chave de API: Melhores Práticas

A sua chave de API Didit é uma credencial crucial. A compromissão desta chave pode levar a acesso não autorizado e fraude potencial. Siga estas melhores práticas:

• Variáveis de Ambiente: Guarde a sua chave de API em variáveis de ambiente, não diretamente no seu código base.
• Controlo de Acesso: Restrinja o acesso às variáveis de ambiente que contêm a sua chave de API apenas a pessoal e sistemas autorizados.
• Rotação da Chave: Rode regularmente a sua chave de API como precaução de segurança.
• Monitorização: Monitorize a utilização da API para atividades suspeitas.
• Nunca Cometer ao Controlo de Versão: Garanta que a sua chave de API nunca é cometida aos repositórios de controlo de origem.

A Didit fornece várias chaves de API para diferentes ambientes (desenvolvimento, preparação, produção). Utilize estas chaves separadas para isolar os ambientes e evitar impactos acidentais na produção durante os testes.

3. Tratamento Eficaz de Erros e Mecanismos de Repetição

As integrações de API são inerentemente propensas a erros transitórios. Implemente um tratamento de erros robusto para garantir uma experiência de utilizador fluida. A API Didit devolve códigos de estado HTTP padrão para indicar sucesso ou falha. Especifique, preste atenção a:

• 400 Pedido Errado: Indica um pedido inválido. Valide os seus dados de entrada cuidadosamente.
• 429 Muitos Pedidos: Indica que excedeu o limite de taxa. Implemente a lógica de repetição com recuo exponencial (ver secção 4).
• 500 Erro Interno do Servidor: Indica um erro do lado da Didit. Implemente a lógica de repetição com atrasos crescentes.

Implemente um registo abrangente para capturar detalhes de erros, parâmetros de pedido e carimbos de data/hora. Esta informação é inestimável para a depuração e identificação de problemas recorrentes. Utilize um formato de registo estruturado (por exemplo, JSON) para facilitar a análise.

4. Compreender e Lidar com Limites de Taxa

A API Didit impõe limites de taxa para proteger a sua infraestrutura e garantir uma utilização justa. Os limites de taxa são definidos como pedidos por minuto (RPM). Exceder o limite de taxa resultará num erro 429 Muitos Pedidos. Para lidar com os limites de taxa de forma elegante:

• Monitorizar Cabeçalhos de Limite de Taxa: A API Didit devolve cabeçalhos de limite de taxa na resposta, indicando a sua utilização atual e a quota restante.
• Implementar Recuo Exponencial: Quando receber um erro 429, implemente uma estratégia de repetição com recuo exponencial. Comece com um atraso curto (por exemplo, 1 segundo) e aumente-o exponencialmente com cada tentativa subsequente (por exemplo, 2 segundos, 4 segundos, 8 segundos).
• Cache: Como mencionado anteriormente, a cache reduz o número de chamadas à API.
• Colocação em Fila: Para cargas de trabalho de elevado volume, considere utilizar uma fila de mensagens para colocar em buffer os pedidos de API e suavizar os picos de tráfego.

5. Como a Didit Ajuda

A Didit simplifica a verificação de identidade através de uma abordagem focada no programador. Os nossos SDKs abrangentes (Web, iOS, Android, React Native, Flutter) abstraem as complexidades da API, permitindo-lhe integrar a verificação de forma rápida e fácil. No entanto, compreender os princípios da API subjacentes discutidos acima é crucial para construir aplicações robustas e escaláveis. A Consola de Negócios da Didit fornece ferramentas detalhadas de análise e monitorização para rastrear a utilização da API e identificar potenciais problemas. A nossa precificação transparente e o modelo de pagamento por utilização eliminam taxas ocultas e custos inesperados.

Pronto para Começar?

Explore a documentação da API Didit em https://docs.didit.me e inscreva-se numa conta gratuita para começar a construir hoje! Consulte o nosso Centro de Demonstração para exemplos interativos. Para perguntas específicas, contacte a nossa equipa de suporte em hello@didit.me.