Der Truthlocks Python-Client bietet Ressourcenmethoden für die Ausgabe von Identitäten, Schlüsseln, Attestierungen, Verifizierungen und Belegen. Behandeln Sie die installierte Paketversion und die aktuelle Dokumentation als Vertrag für Ihre Integration. Ein Blog-Beispiel sollte eine Methodensignatur oder Endpunktanforderung nicht außer Kraft setzen.
Eine genehmigte Umgebung konfigurieren
Bewahren Sie die API-Anmeldeinformationen in der serverseitigen Konfiguration oder im Geheimnisspeicher Ihrer Bereitstellung auf. Vermeiden Sie es, sie in Notizbüchern, die geteilt werden, Browsercode, Screenshots oder festgeschriebenen Beispielen einzubetten. Legen Sie die API-Basis-URL beim Wechsel der Umgebungen explizit fest, damit ein Testskript nicht stillschweigend den falschen Dienst anspricht.
Die Client-Implementierung umfasst konfigurierbare Timeouts und Wiederholungseinstellungen. Wählen Sie Grenzwerte, die zum umgebenden Workflow passen, und zeigen Sie einen wiederherstellbaren Fehler an, wenn der Dienst nicht antwortet. Lassen Sie einen interaktiven Benutzer nicht unbegrenzt auf eine Hintergrund-Wiederholungsschleife warten.
Verwenden Sie die für die Aufgabe geeignete Ressource
- Aussteller- und Schlüsselressourcen liefern Kontext für die Quelle, die für einen Datensatz verantwortlich ist.
- Attestierungsmethoden funktionieren mit unterstützten signierten Datensatzoperationen und Nutzlastformaten.
- Verifikationsmethoden liefern Ergebnisse, die Ihre Anwendung interpretieren muss, anstatt einen Ersatz für eine geschäftliche Überprüfung zu bieten.
- Belegmethoden verbinden aufgezeichnete Ereignisse mit den Identitäten und Referenzen, die Ihre Anwendung bereitstellt.
Synchronen versus asynchronen Support in der von Ihnen installierten Version bestätigen. Ein asynchroner Registrierungshelfer bedeutet nicht, dass jede Ressourcenmethode asynchron ist. Überprüfen Sie die Laufzeitanforderungen und die tatsächliche Client-Schnittstelle, bevor Sie sie in eine Ereignisschleife einführen.
Fehler bewusst behandeln
Unterscheiden Sie Authentifizierungsfehler, ungültige Eingaben, fehlende Datensätze, Ratenbegrenzungen und Dienstfehler. Ein fehlender Datensatz ist keine Genehmigung. Ein Netzwerk-Timeout ist kein Beweis dafür, dass ein Schreibvorgang fehlgeschlagen ist, bevor er den Server erreichte. Überprüfen Sie das Wiederholungs- und Idempotenzverhalten des Endpunkts, bevor Sie einen Ausgabevorgang wiederholen.
Protokollieren Sie Geschäftsreferenzen und sichere Fehlerkategorien anstelle von Anmeldeinformationen oder vollständigen sensiblen Nutzdaten. Behalten Sie genügend Kontext bei, damit ein Prüfer die ursprüngliche Anfrage finden kann, ohne Protokolle in eine unkontrollierte Kopie von Kundendaten zu verwandeln.
Testen Sie die Empfängererfahrung
Bevor Sie die Integration erweitern, testen Sie einen gültigen Datensatz, geänderte Inhalte, einen widerrufenen Datensatz, einen unbekannten Aussteller und einen nicht verfügbaren Dienst. Überprüfen Sie dann, wie jedes Ergebnis einem tatsächlichen Benutzer angezeigt wird. Erkunden Sie die Entwicklerübersicht, Dokumentation, und Anwendungsfall für die Veröffentlichung von Datensätzen um den Client mit einem bestimmten Workflow zu verbinden.
