مرجع API · إشعارات Webhook

قراءة عنوان الإشعارات

GET/v1/webhook-endpoint

تحقّق من العنوان المسجّل لتطبيقك وحالة التحقق منه.

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

المصادقةقراءة موقَّعة

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

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

حزمة SDK لـ ‎.NETanis.WebhookEndpoint.GetAsync()

الاستدعاء

موقَّعة بمفتاحك. بلا محتوى وبلا رقم استخدام لمرة واحدة (nonce).

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

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

الردود

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

ردود هذا الاستدعاء غير موقَّعة — لا ترويسة Signature ولا Signature-Input، سواء في النجاح أو الرفض. لا شيء تتحقق منه؛ فحماية TLS تكفيها. وتبقى Content-Digest و X-Request-Id موجودتين.

حالات الرفض

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

الخطأ	الرمز	الحالة
بيانات اعتماد غير صالحة	`invalid_credentials`	401
استدعاء موقّع غير سليم البنية	`malformed_signed_request`	400
صلاحية غير كافية	`insufficient_scope`	403
عنوان المصدر غير مسموح	`source_ip_not_allowed`	403
تجاوزت حدّ الاستدعاءات	`rate_limited`	429
فشل التحقق	`validation_failed`	422
الخدمة غير متاحة	`dependency_unavailable`	503
انتهت مهلة الاستدعاء	`request_timeout`	504
خطأ داخلي	`internal_error`	500
غير موجود	`resource_not_found`	404

الأنواع

WebhookEndpoint

الحقل	النوع	ملاحظات
`url`موجود دائمًا	string	عنوان HTTPS المسجّل لتطبيقك؛ ويكون `null` إن لم يُسجّل عنوان.
`status`موجود دائمًا	WebhookEndpointStatus	تكون `notConfigured` أو `pendingVerification` أو `verified` أو `disabled`. لا يستقبل العنوان المعطّل أي إشعارات.
`generation`موجود دائمًا	integer	رقم جيل التسجيل الوارد في تحدّي التحقق؛ ويكون `null` إن لم يُسجّل عنوان.