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

API Documentation Page

FeedbackPulse provides an interactive API documentation page so tenants can explore and test available endpoints.

Accessing API Docs​

انتقل إلى /api-docs from the لوحة تحكم المستأجر to view the full API reference.

Endpoint Grouping​

Endpoints are organized by resource:

Resourceالوصف
المشاركاتCreate, read, update, and manage feedback submissions
المنتجاتManage products and their configurations
الحملاتCreate and manage feedback campaigns
الويب هوكConfigure and manage webhook subscriptions

Endpoint Details​

Each endpoint entry displays the following information:

الحقلالوصف
HTTP MethodThe request method (GET, POST, PUT, DELETE)
URLThe full endpoint path
المعلماتRequired and optional parameters with types and descriptions
Example RequestSample request body or query parameters
Example ResponseSample JSON response with status code

Authentication​

The API docs page includes authentication instructions. All API requests require an API key passed in the request header:

Authorization: Bearer {your-api-key}

مفاتيح API can be generated from the tenant الإعدادات page.

Copy-to-Clipboard​

Each endpoint includes a pre-built cURL command that can be copied to the clipboard with a single click, making it easy to test endpoints from the terminal.

الخطوات التالية​