El cliente Python de Truthlocks proporciona métodos de recursos para emitir identidades, claves, atestaciones, verificación y recibos. Trate la versión del paquete instalado y la documentación actual como el contrato para su integración. Un ejemplo de blog no debe anular una firma de método o un requisito de punto final.
Configurar un entorno aprobado
Mantenga la credencial de la API en la configuración del lado del servidor o en el almacén de secretos de su implementación. Evite incrustarla en cuadernos que se compartirán, código de navegador, capturas de pantalla o ejemplos comprometidos. Establezca la URL base de la API explícitamente al cambiar de entorno para que un script de prueba no pueda apuntar silenciosamente al servicio equivocado.
La implementación del cliente incluye tiempos de espera y configuraciones de reintento configurables. Elija límites que coincidan con el flujo de trabajo circundante y presente un error recuperable cuando el servicio no responda. No mantenga a un usuario interactivo esperando indefinidamente un bucle de reintento en segundo plano.
Utilice el recurso apropiado para la tarea
- Los recursos del emisor y de la clave proporcionan contexto para la fuente responsable de un registro.
- Los métodos de atestación funcionan con operaciones de registro firmadas y formatos de carga útil compatibles.
- Los métodos de verificación devuelven resultados que su aplicación debe interpretar, en lugar de un sustituto de la revisión comercial.
- Los métodos de recibo conectan los eventos registrados con las identidades y referencias que proporciona su aplicación.
Confirme el soporte síncrono versus asíncrono en la versión que instale. Un asistente de registro asíncrono no significa que cada método de recurso sea asíncrono. Verifique los requisitos de tiempo de ejecución y la interfaz de cliente real antes de introducirlo en un bucle de eventos.
Manejar los fallos deliberadamente
Distinga fallas de autenticación, entrada no válida, registros faltantes, límites de velocidad y errores de servicio. Un registro faltante no es una aprobación. Un tiempo de espera de red no es evidencia de que una escritura falló antes de llegar al servidor. Revise el comportamiento de reintento e idempotencia del punto final antes de repetir una operación de emisión.
Registre referencias comerciales y categorías de errores seguros en lugar de credenciales o cargas útiles sensibles completas. Conserve suficiente contexto para que un revisor encuentre la solicitud original sin convertir los registros en una copia incontrolada de los registros de los clientes.
Pruebe la experiencia del destinatario
Antes de expandir la integración, pruebe un registro válido, contenido cambiado, un registro revocado, un emisor desconocido y un servicio no disponible. Luego, revise cómo aparece cada resultado a un usuario real. Explore el descripción general para desarrolladores, documentación, y caso de uso de lanzamiento de conjunto de datos para conectar el cliente a un flujo de trabajo específico.
