يوفر عميل Truthlocks Python طرقًا للموارد حول إصدار الهويات والمفاتيح والشهادات والتحقق والإيصالات. تعامل مع إصدار الحزمة المثبتة والوثائق الحالية كعقد لتكاملك. يجب ألا يتجاوز مثال المدونة توقيع طريقة أو متطلب نقطة نهاية.
تكوين بيئة معتمدة
احتفظ ببيانات اعتماد API في تكوين جانب الخادم أو في مخزن الأسرار الخاص بنشرك. تجنب تضمينها في دفاتر الملاحظات التي ستتم مشاركتها، أو رمز المتصفح، أو لقطات الشاشة، أو الأمثلة الملتزمة. قم بتعيين عنوان URL الأساسي لـ API بشكل صريح عند تبديل البيئات حتى لا يتمكن نص الاختبار من استهداف الخدمة الخاطئة بصمت.
يتضمن تنفيذ العميل مهلات قابلة للتكوين وإعدادات إعادة المحاولة. اختر الحدود التي تتناسب مع سير العمل المحيط وقدم خطأ قابلاً للاسترداد عندما لا تستجيب الخدمة. لا تجعل المستخدم التفاعلي ينتظر إلى أجل غير مسمى لحلقة إعادة محاولة في الخلفية.
استخدم المورد المناسب للمهمة
- توفر موارد المصدر والمفتاح سياقًا للمصدر المسؤول عن السجل.
- تعمل طرق الإثبات مع عمليات السجل الموقعة المدعومة وتنسيقات الحمولة.
- تعيد طرق التحقق النتائج التي يجب على تطبيقك تفسيرها، بدلاً من أن تكون بديلاً للمراجعة التجارية.
- تربط طرق الإيصال الأحداث المسجلة بالهويات والمراجع التي يوفرها تطبيقك.
تأكيد الدعم المتزامن مقابل غير المتزامن في الإصدار الذي تقوم بتثبيته. لا يعني مساعد التسجيل غير المتزامن أن كل طريقة مورد غير متزامنة. تحقق من متطلبات وقت التشغيل وواجهة العميل الفعلية قبل إدخالها في حلقة حدث.
تعامل مع الإخفاقات عمدًا
ميز بين فشل المصادقة، والإدخال غير الصالح، والسجلات المفقودة، وحدود المعدل، وأخطاء الخدمة. السجل المفقود ليس موافقة. مهلة الشبكة ليست دليلًا على فشل الكتابة قبل الوصول إلى الخادم. راجع سلوك إعادة المحاولة والتكرارية لنقطة النهاية قبل تكرار عملية إصدار.
سجل مراجع الأعمال وفئات الأخطاء الآمنة بدلاً من بيانات الاعتماد أو الحمولات الحساسة الكاملة. احتفظ بسياق كافٍ للمراجع للعثور على الطلب الأصلي دون تحويل السجلات إلى نسخة غير متحكم فيها من سجلات العملاء.
اختبر تجربة المستلم
قبل توسيع التكامل، اختبر سجلًا صالحًا، ومحتوى متغيرًا، وسجلًا ملغيًا، وجهة إصدار غير معروفة، وخدمة غير متاحة. ثم راجع كيف تظهر كل نتيجة لمستخدم فعلي. استكشف نظرة عامة للمطورين, الوثائق، و حالة استخدام إصدار مجموعة البيانات لربط العميل بسير عمل محدد.
