مرجع API · تسجيل المفتاح

قراءة حالة التسجيل

GET/v1/enrollments/{invitationId}/status

أين وصل المفتاح: بانتظار الإثبات، أو بانتظار موظفي أنيس، أو فعّال، أو قيد الاستبدال. وحين يصبح المفتاح فعّالًا يحمل الرد أيضًا تاريخ انتهاء المفتاح، keyExpiresAt: اطلب من موظفي أنيس مفتاحًا بديلًا قبله بأسابيع.

الصلاحيةلا شيء

المصادقةرمز التسجيل

ردّ أنيسموقَّع

حدود الموظفين التي يُحتسب ضمنهالا شيء

حزمة SDK لـ ‎.NETenrollment.GetStatusAsync()

بعد إرسال مفتاحك تظل قراءة الحالة تُجيب بالرمز (token) نفسه حتى بعد انتهاء صلاحية الدعوة، إلى أن ينتهي المفتاح. أما resource_not_found هنا فيعني أن الدعوة أو الرمز غير معروفين، أو أن الدعوة انتهت قبل إرسال أي مفتاح، أو أن المفتاح انتهى (أُلغي، أو أُنهي بعد استبداله، أو تجاوز تاريخ انتهائه): تواصل مع موظفي أنيس.

المعاملات

الاسم	الموضع	النوع	ملاحظات
`invitationId`إلزامي	`path`	UUID	معرّف UUID بأحرف صغيرة مع الشرطات.

الاستدعاء

مُصرَّح به عبر Authorization: Enrollment <token>؛ غير موقَّع.

الترويسات: Accept-Language (اختياري). تضبطها حزم SDK كلها نيابةً عنك.

المحتوى: لا يوجد.

الردود

الحالة	المعنى	المحتوى
200	نجاح.	EnrollmentStatus
401	مرفوض: لم تتم المصادقة.	مشكلة
404	مرفوض: غير موجود، أو ليس لك.	مشكلة
429	مرفوض: بلغتَ حدًا.	مشكلة
503	لا قرار: خدمة مطلوبة غير متاحة.	مشكلة

كل ردّ على هذا الاستدعاء موقَّع من أنيس — النجاح وكل رفض. اشترط وجود التوقيع وتحقّق منه قبل أن تتصرف بناءً على الردّ؛ والردّ بلا توقيع فشل، لا يُعدّ ردًّا (كيف).

حالات الرفض

كل رفض لهذا الاستدعاء مشكلةٌ موقَّعة. ابنِ منطقك على رمزها code؛ وكلٌّ منها يرتبط بصفحة تشرح معناه وما عليك فعله.

الخطأ	الرمز	الحالة
الدعوة غير صالحة	`invitation_invalid`	401
غير موجود	`resource_not_found`	404
تجاوزت حدّ الاستدعاءات	`rate_limited`	429
الخدمة غير متاحة	`dependency_unavailable`	503
انتهت مهلة الاستدعاء	`request_timeout`	504
خطأ داخلي	`internal_error`	500

الأنواع

EnrollmentStatus

الحقل	النوع	ملاحظات
`keyId`	UUID	معرّف مفتاحك.
`challengeGeneration`	integer	رقم التحدّي الحالي.
`proofState`	string	`pending` أو `accepted` أو `failed` — إثبات لم يُتحقق منه أو جاء متأخرًا. وبعد خمس محاولات إثبات فاشلة تُرفض المحاولة التالية بالرمز `invitation_invalid`: اطلب من موظفي أنيس إعادة بدء تسجيل المفتاح.
`approvalState`	string	`pending` ما دام موظفو أنيس لم يؤكّدوا المفتاح، و `approved` بعد أن يصبح فعّالًا، و `notApplicable` في غير ذلك.
`state`	string	`pendingInvitation` أو `pendingProof` أو `pendingApproval` أو `active` — المفتاح يوقّع الاستدعاءات — أو `unavailable` (المفتاح قيد الاستبدال بمفتاح أحدث). أما المفتاح الملغى أو المُنهى أو المنتهي الصلاحية فلا يُعرض: تُجيب قراءة الحالة بالرمز `resource_not_found`.
`expiresAt`	string (date-time)	وقت انتهاء خطوة التسجيل الحالية: الدعوة، ما دامت مفتوحة. لا يظهر بعد أن يصبح المفتاح فعّالًا أو حين لا يعود متاحًا — أما تاريخ انتهاء المفتاح نفسه فهو `keyExpiresAt`.
`keyExpiresAt`	string (date-time)	تاريخ توقف مفتاحك النشط عن العمل (لا يظهر قبل أن يصبح المفتاح نشطًا). اطلب من موظفي أنيس مفتاحًا بديلًا قبله بأسابيع: فالمفتاح الذي تجاوز تاريخ انتهائه يُرفض بالرمز `invalid_credentials` في كل استدعاء، بما في ذلك كشف بطاقات اشتريتها من قبل.