O cliente Python Truthlocks fornece métodos de recurso para emissão de identidades, chaves, atestados, verificação e recibos. Trate a versão do pacote instalado e a documentação atual como o contrato para sua integração. Um exemplo de blog não deve substituir uma assinatura de método ou requisito de endpoint.
Configurar um ambiente aprovado
Mantenha a credencial da API na configuração do lado do servidor ou no armazenamento secreto da sua implantação. Evite incorporá-la em notebooks que serão compartilhados, código de navegador, capturas de tela ou exemplos comprometidos. Defina explicitamente a URL base da API ao alternar ambientes para que um script de teste não possa direcionar silenciosamente o serviço errado.
A implementação do cliente inclui tempos limite configuráveis e configurações de nova tentativa. Escolha limites que correspondam ao fluxo de trabalho circundante e apresente um erro recuperável quando o serviço não responder. Não mantenha um usuário interativo esperando indefinidamente por um loop de nova tentativa em segundo plano.
Use o recurso apropriado para a tarefa
- Os recursos do emissor e da chave fornecem contexto para a fonte responsável por um registro.
- Os métodos de atestado funcionam com operações de registro assinado e formatos de payload suportados.
- Os métodos de verificação retornam resultados que sua aplicação deve interpretar, em vez de um substituto para a revisão de negócios.
- Os métodos de recibo conectam eventos registrados às identidades e referências que seu aplicativo fornece.
Confirme o suporte síncrono versus assíncrono na versão que você instalar. Um auxiliar de registro assíncrono não significa que todo método de recurso seja assíncrono. Verifique os requisitos de tempo de execução e a interface real do cliente antes de introduzi-lo em um loop de eventos.
Lidar com falhas deliberadamente
Distinga falhas de autenticação, entrada inválida, registros ausentes, limites de taxa e erros de serviço. Um registro ausente não é uma aprovação. Um tempo limite de rede não é evidência de que uma gravação falhou antes de chegar ao servidor. Revise o comportamento de repetição e idempotência do endpoint antes de repetir uma operação de emissão.
Registre referências comerciais e categorias de erro seguras em vez de credenciais ou cargas úteis sensíveis completas. Mantenha contexto suficiente para um revisor encontrar a solicitação original sem transformar os logs em uma cópia descontrolada dos registros do cliente.
Teste a experiência do destinatário
Antes de expandir a integração, teste um registro válido, conteúdo alterado, um registro revogado, um emissor desconhecido e um serviço indisponível. Em seguida, revise como cada resultado aparece para um usuário real. Explore o visão geral do desenvolvedor, documentação, e caso de uso de liberação de conjunto de dados para conectar o cliente a um fluxo de trabalho específico.
