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

اختبار استقبال الإشعارات

POST/v1/webhook-endpoint/test

اطلب من أنيس إرسال إشعار اختبار موقّع إلى عنوانك المتحقق منه. لا ينشئ الاختبار عملية شراء.

الصلاحيةلا شيء
المصادقةتغيير موقَّع
ردّ أنيسموقَّع
حدود الموظفين التي يُحتسب ضمنهاكل الاستدعاءات
حزمة SDK لـ ‎.NETanis.WebhookEndpoint.TestAsync()
  • وقّع بصمة المحتوى برقم استخدام واحد جديد، دون Idempotency-Key. لا ينشئ هذا التغيير عملية شراء.

الاستدعاء

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

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

المحتوى: البايتان {} بالضبط.

الردود

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

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

حالات الرفض

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

الخطأالرمزالحالة
بيانات اعتماد غير صالحةinvalid_credentials401
استدعاء موقّع غير سليم البنيةmalformed_signed_request400
صلاحية غير كافيةinsufficient_scope403
عنوان المصدر غير مسموحsource_ip_not_allowed403
تجاوزت حدّ الاستدعاءاتrate_limited429
فشل التحققvalidation_failed422
الخدمة غير متاحةdependency_unavailable503
انتهت مهلة الاستدعاءrequest_timeout504
خطأ داخليinternal_error500
اكتُشف تكرارreplay_detected409
غير موجودresource_not_found404
لم يُتحقق من العنوانwebhook_endpoint_unverified409

الأنواع

WebhookEventAccepted

الحقلالنوعملاحظات
idموجود دائمًاUUIDالمعرّف الذي أُعيد لهذا السجل. احتفظ به كما هو عند قراءته مجددًا.
typestringنوع الإشعار؛ ويكون webhook_endpoint.test في ردّ قبول الاختبار، ويُحذف في ردّ قبول إعادة الإرسال.
statusموجود دائمًاWebhookDeliveryStatusحالة تسليم الإشعار، وليست حالة الشراء.
queuedAtموجود دائمًاstring (date-time)وقت وضع طلب التسليم في الانتظار بتوقيت UTC.

WebhookDeliveryStatus