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

قراءة دعوة

GET/v1/enrollments/{invitationId}

حالة الدعوة ووقت انتهاء صلاحيتها. مُصرَّح به برمز التسجيل لا بتوقيع.

الصلاحيةلا شيء
المصادقةرمز التسجيل
ردّ أنيسموقَّع
حدود الموظفين التي يُحتسب ضمنهالا شيء
حزمة SDK لـ ‎.NETenrollment.GetAsync()

المعاملات

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

الاستدعاء

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

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

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

الردود

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

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

حالات الرفض

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

الخطأالرمزالحالة
الدعوة غير صالحةinvitation_invalid401
غير موجودresource_not_found404
تجاوزت حدّ الاستدعاءاتrate_limited429
الخدمة غير متاحةdependency_unavailable503
انتهت مهلة الاستدعاءrequest_timeout504
خطأ داخليinternal_error500

الأنواع

EnrollmentState

الحقلالنوعملاحظات
invitationIdUUIDالدعوة.
applicationIdUUIDالتطبيق الذي يُسجَّل له المفتاح.
statestringpendingInvitation أو pendingProof أو pendingApproval أو active أو unavailable.
expiresAtstring (date-time)وقت انتهاء صلاحية الدعوة — بعد 24 ساعة من إصدارها.