مرجع API · إشعارات Webhook
اختبار استقبال الإشعارات
POST
/v1/webhook-endpoint/testاطلب من أنيس إرسال إشعار اختبار موقّع إلى عنوانك المتحقق منه. لا ينشئ الاختبار عملية شراء.
الصلاحيةلا شيء
المصادقةتغيير موقَّع
ردّ أنيسموقَّع
حدود الموظفين التي يُحتسب ضمنهاكل الاستدعاءات
حزمة SDK لـ .NET
anis.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_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 |
| اكتُشف تكرار | replay_detected | 409 |
| غير موجود | resource_not_found | 404 |
| لم يُتحقق من العنوان | webhook_endpoint_unverified | 409 |
الأنواع
WebhookEventAccepted
| الحقل | النوع | ملاحظات |
|---|---|---|
idموجود دائمًا | UUID | المعرّف الذي أُعيد لهذا السجل. احتفظ به كما هو عند قراءته مجددًا. |
type | string | نوع الإشعار؛ ويكون webhook_endpoint.test في ردّ قبول الاختبار، ويُحذف في ردّ قبول إعادة الإرسال. |
statusموجود دائمًا | WebhookDeliveryStatus | حالة تسليم الإشعار، وليست حالة الشراء. |
queuedAtموجود دائمًا | string (date-time) | وقت وضع طلب التسليم في الانتظار بتوقيت UTC. |