الانتقال إلى المحتوى الرئيسي
رموز الأخطاء والأحكام المعيارية المستخدمة عبر منصة Truthlocks. هذه الرموز مستقرة ويمكن استخدامها للتعامل مع الأخطاء برمجيًا.

أحكام التحقق

أسباب التحقق

عند استدعاء نقطة نهاية التحقق، تتضمن الاستجابة مصفوفة reasons مع سياق إضافي. رموز السبب هذه معلوماتية وتظهر جنبًا إلى جنب مع الحكم:

رموز خطأ API

عام

التصديقات والمُصدرون

مفاتيح API

المستهلك

الهوية و DID

SSO

السياسة والحوكمة

الفوترة والقيود

إقامة البيانات

الأخطاء القابلة لإعادة المحاولة مقابل الأخطاء النهائية

عند اتخاذ قرار بإعادة محاولة طلب فاشل، استخدم رمز حالة HTTP لتحديد ما إذا كان الخطأ عابرًا أم دائمًا.

قابل لإعادة المحاولة (مؤقت)

يتم إعادة محاولة هذه الأخطاء تلقائيًا بواسطة SDKs عند تكوين MaxRetries (أو ما يعادله):

طرفي (لا تعاود المحاولة)

تشير هذه الأخطاء إلى وجود مشكلة في الطلب لن يتم حلها بإعادة المحاولة:
تتعامل جميع حزم تطوير البرامج الثلاثة مع الأخطاء القابلة لإعادة المحاولة تلقائيًا مع التراجع الأسي والارتعاش. تحتاج فقط إلى منطق إعادة المحاولة اليدوي إذا قمت بتعطيل عمليات إعادة المحاولة التلقائية أو كنت ترغب في سلوك مخصص بالإضافة إلى الإعدادات الافتراضية لحزمة تطوير البرامج.

تنسيق استجابة الخطأ

تُرجع كل استجابة خطأ كائن JSON بحقلين:
  • code — رمز خطأ مستقر وقابل للقراءة آليًا من الجداول أعلاه. استخدم هذا لمعالجة الأخطاء برمجيًا.
  • message — وصف سهل القراءة لما حدث خطأ. قد تتغير الرسائل بين الإصدارات؛ لا تطابقها برمجيًا.
يتم استبدال رسائل الخطأ التي قد تكشف تفاصيل البنية التحتية (مثل سلاسل اتصال قاعدة البيانات أو أسماء المضيفين الداخلية) تلقائيًا برسالة عامة قبل إعادتها إلى العميل. يتم تسجيل التفاصيل الأصلية على جانب الخادم فقط.

أخطاء البوابة (RFC 7807)

عندما يصل طلب إلى بوابة API ولكنه لا يتطابق مع أي مسار صالح، تُرجع البوابة استجابة خطأ منظمة تتبع مواصفات RFC 7807 Problem Details. ينطبق هذا على أخطاء 404 Not Found و 405 Method Not Allowed على مستوى البوابة.

تنسيق الاستجابة

تستخدم أخطاء البوابة application/problem+json كنوع محتوى وتتضمن أربعة حقول:

عندما ترى هذه الأخطاء

  • 404 Not Found — مسار الطلب لا يتطابق مع أي مسار API. تحقق جيدًا من عنوان URL، بما في ذلك بادئة إصدار /v1/ واسم المورد.
  • 405 Method Not Allowed — مسار الطلب موجود، ولكن طريقة HTTP التي استخدمتها (على سبيل المثال، DELETE على نقطة نهاية للقراءة فقط) غير مدعومة. تحقق من مرجع API للطريقة الصحيحة.

معالجة أخطاء البوابة في التعليمات البرمجية

إذا قمت بتحليل استجابات الأخطاء برمجيًا، فتحقق من رأس Content-Type لتمييز أخطاء البوابة عن أخطاء التطبيق:
  • application/problem+json — خطأ على مستوى البوابة (RFC 7807). استخدم حقلي status و title.
  • application/json — خطأ على مستوى التطبيق. استخدم حقلي code و message.
تتعامل حزم SDK من Truthlocks مع كلا تنسيقي الخطأ تلقائيًا. تحتاج فقط إلى التمييز بينهما إذا كنت تستدعي واجهة برمجة التطبيقات مباشرةً.

التعدادات القانونية

الخوارزمية

* Ed25519 * ES256 * ES384 * ES512 * RS256 * RS384 * RS512 * PS256 * PS384 * PS512

حالة المُصدر

  • pending * trusted * suspended * revoked

طبقة الثقة

  • self_issued * verified_org * regulated_issuer

حالة المفتاح

  • ACTIVE * DISABLED * EXPIRED * COMPROMISED

حالة التصديق

* ACTIVE * REVOKED * SUPERSEDED

تقييم المخاطر

  • unknown * low * medium * high * critical