إنتقل إلى المحتوى الرئيسي

نظرة عامة على REST API v2

يوفر FeedbackPulse SaaS واجهة API RESTful (v2) للوصول البرمجي إلى بيانات مستأجرك. استخدمها لدمج التغذية الراجعة في تطبيقاتك الخاصة، أو بناء لوحات التحكم، أو أتمتة سير العمل.

رابط URL الأساسي​

https://yourdomain.com/api/v2

المصادقة​

تتطلب جميع طلبات API Bearer token (مفتاح API):

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://yourdomain.com/api/v2/submissions

الحصول على مفتاح API​

  1. سجّل الدخول إلى لوحة تحكم مستأجرك
  2. انتقل إلى Settings > API Keys
  3. انقر على Create API Key
  4. انسخ المفتاح فوراً (يُعرض مرة واحدة فقط!)

تُخزَّن مفاتيح API كتجزئات SHA256. لا يمكن استرداد المفتاح الخام.

متطلب الخطة: يتطلب وصول API علامة الميزة api_access في خطتك.

تحديد معدل الطلبات​

الحدالقيمة
الطلبات في الدقيقة لكل مستأجر60

تُدرج رؤوس حد معدل الطلبات في كل استجابة:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57

نقاط النهاية المتاحة​

الطريقةنقطة النهايةالوصف
GET/api/v2/submissionsقائمة التقديمات
GET/api/v2/submissions/{id}الحصول على تقديم محدد
POST/api/v2/submissionsإنشاء تقديم
GET/api/v2/productsقائمة المنتجات
POST/api/v2/productsإنشاء منتج
GET/api/v2/campaignsقائمة الحملات
POST/api/v2/campaignsإنشاء حملة
GET/api/v2/webhooks/configالحصول على إعداد webhook
PUT/api/v2/webhooks/configتحديث إعداد webhook
GET/api/v2/webhooks/logsعرض سجلات تسليم webhook

صيغة الاستجابة​

جميع الاستجابات بصيغة JSON:

{
  "data": [...],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 42
  }
}

استجابات الأخطاء​

{
  "error": "Unauthenticated.",
  "status": 401
}
كود الحالةالمعنى
200نجاح
201تم الإنشاء
400طلب خاطئ (خطأ في التحقق)
401غير مصرح (مفتاح API غير صالح أو مفقود)
403محظور (صلاحيات غير كافية)
404غير موجود
429طلبات كثيرة جداً (تم تجاوز الحد)
500خطأ في الخادم

تعمّق أكثر​