Le client Python de Truthlocks fournit des méthodes de ressources autour de l'émission d'identités, de clés, d'attestations, de vérifications et de reçus. Traitez la version du package installé et la documentation actuelle comme le contrat pour votre intégration. Un exemple de blog ne doit pas remplacer une signature de méthode ou une exigence de point de terminaison.
Configurer un environnement approuvé
Conservez les identifiants API dans la configuration côté serveur ou dans le magasin de secrets de votre déploiement. Évitez de les intégrer dans des notebooks qui seront partagés, du code de navigateur, des captures d'écran ou des exemples validés. Définissez explicitement l'URL de base de l'API lors du changement d'environnement afin qu'un script de test ne puisse pas cibler silencieusement le mauvais service.
L'implémentation du client inclut des délais d'attente et des paramètres de nouvelle tentative configurables. Choisissez des limites qui correspondent au flux de travail environnant et présentez une erreur récupérable lorsque le service ne répond pas. Ne laissez pas un utilisateur interactif attendre indéfiniment une boucle de nouvelle tentative en arrière-plan.
Utilisez la ressource appropriée à la tâche
- Les ressources de l'émetteur et de la clé fournissent un contexte pour la source responsable d'un enregistrement.
- Les méthodes d'attestation fonctionnent avec les opérations d'enregistrement signé et les formats de charge utile pris en charge.
- Les méthodes de vérification renvoient des résultats que votre application doit interpréter, plutôt qu'un substitut à l'examen métier.
- Les méthodes de réception connectent les événements enregistrés aux identités et aux références fournies par votre application.
Confirmez le support synchrone ou asynchrone dans la version que vous installez. Un assistant d'enregistrement asynchrone ne signifie pas que chaque méthode de ressource est asynchrone. Vérifiez les exigences d'exécution et l'interface client réelle avant de l'introduire dans une boucle d'événements.
Gérer les échecs délibérément
Distinguez les échecs d'authentification, les entrées invalides, les enregistrements manquants, les limites de débit et les erreurs de service. Un enregistrement manquant n'est pas une approbation. Un délai d'attente réseau n'est pas la preuve qu'une écriture a échoué avant d'atteindre le serveur. Examinez le comportement de réessai et d'idempotence du point de terminaison avant de répéter une opération d'émission.
Enregistrez les références commerciales et les catégories d'erreurs sûres au lieu des identifiants ou des charges utiles sensibles complètes. Conservez suffisamment de contexte pour qu'un examinateur puisse trouver la demande originale sans transformer les journaux en une copie incontrôlée des dossiers clients.
Testez l'expérience du destinataire
Avant d'étendre l'intégration, testez un enregistrement valide, un contenu modifié, un enregistrement révoqué, un émetteur inconnu et un service indisponible. Ensuite, examinez comment chaque résultat apparaît à un utilisateur réel. Explorez le aperçu du développeur, documentation, et cas d'utilisation de la publication de jeux de données pour connecter le client à un flux de travail spécifique.
