صفحة توثيق API

يوفر FeedbackPulse صفحة توثيق API تفاعلية تتيح للمستأجرين استكشاف نقاط النهاية المتاحة واختبارها.

الوصول إلى توثيق API

انتقل إلى /api-docs من لوحة تحكم المستأجر لعرض مرجع API الكامل.

تُنظَّم نقاط النهاية حسب المورد:

المورد	الوصف
الإرسالات	إنشاء إرسالات التغذية الراجعة وقراءتها وتحديثها وإدارتها
المنتجات	إدارة المنتجات وإعداداتها
الحملات	إنشاء حملات التغذية الراجعة وإدارتها
Webhooks	إعداد اشتراكات Webhook وإدارتها

تعرض كل إدخالة لنقطة نهاية المعلومات التالية:

الحقل	الوصف
طريقة HTTP	طريقة الطلب (`GET` و`POST` و`PUT` و`DELETE`)
عنوان URL	مسار نقطة النهاية الكامل
المعاملات	المعاملات المطلوبة والاختيارية مع أنواعها وأوصافها
مثال الطلب	نموذج جسم الطلب أو معاملات الاستعلام
مثال الاستجابة	نموذج استجابة JSON مع رمز الحالة

تتضمن صفحة توثيق API تعليمات المصادقة. تتطلب جميع طلبات API مفتاح API يُمرَّر في ترويسة الطلب:

Authorization: Bearer {your-api-key}

يمكن إنشاء مفاتيح API من صفحة الإعدادات الخاصة بالمستأجر.

تتضمن كل نقطة نهاية أمر cURL جاهزًا يمكن نسخه إلى الحافظة بنقرة واحدة، مما يُسهّل اختبار نقاط النهاية من سطر الأوامر.