مستندات API

راهنمای کامل استفاده از API بازگو برای ارسال بازخورد

آدرس پایه API
https://bazgo.site
احراز هویت
برای استفاده از API، نیاز به یک کلید API دارید

کلید API خود را از داشبورد دریافت کنید و آن را در هدر درخواست ارسال کنید:

x-api-key: bzg_your_api_key_here
ارسال بازخورد
ارسال بازخورد جدید از طریق API
POST/api/v1/feedback

این endpoint برای ارسال بازخورد جدید استفاده می‌شود. بازخورد به صورت خودکار با هوش مصنوعی تحلیل می‌شود.

هدرهای درخواست

Content-Type: application/json
x-api-key: bzg_your_api_key_here

بدنه درخواست (Body)

text(الزامی) - متن بازخورد
source(اختیاری) - منبع بازخورد (پیش‌فرض: "api")
metadata(اختیاری) - اطلاعات اضافی مانند ایمیل، شماره تلفن و...
{
"text": "متن بازخورد شما",
"source": "mobile_app",
"metadata": {
"email": "user@example.com",
"phone": "+989123456789",
"customField": "value"
}
}

مثال درخواست (cURL)

curl -X POST https://bazgo.site/api/v1/feedback \
-H "Content-Type: application/json" \
-H "x-api-key: bzg_your_api_key_here" \
-d '{'
"text": "این یک بازخورد تستی است",
"source": "mobile_app",
"metadata": {
"email": "user@example.com"
}
}'

پاسخ موفق (201 Created)

بازخورد با موفقیت ارسال شد
{
"success": true,
"message": "Feedback submitted successfully",
"data": {
"feedbackId": "uuid-here",
"analysis": {
"sentiment": "positive",
"sentimentScore": 85,
"category": "praise",
"summary": "خلاصه تحلیل..."
}
}
}

خطاها

401 Unauthorized

کلید API نامعتبر یا وجود ندارد

{ "success": false, "error": "Invalid API key", "code": "INVALID_API_KEY" }
400 Bad Request

متن بازخورد الزامی است

{ "success": false, "error": "Feedback text is required", "code": "MISSING_TEXT" }
429 Too Many Requests

سقف ماهانه بازخورد شما به پایان رسیده است

{ "success": false, "error": "Monthly feedback limit reached", "code": "QUOTA_EXCEEDED" }
ویژگی‌ها
  • تحلیل خودکار با هوش مصنوعی
  • تشخیص احساسات (Sentiment Analysis)
  • دسته‌بندی خودکار بازخوردها
  • استخراج کلمات کلیدی
  • پشتیبانی از متادیتای سفارشی
  • محدودیت نرخ درخواست (Rate Limiting)
نکات مهم

• کلید API خود را محرمانه نگه دارید و آن را در کد سمت کلاینت قرار ندهید

• از HTTPS برای تمام درخواست‌ها استفاده کنید

• بازخوردها به صورت خودکار با هوش مصنوعی تحلیل می‌شوند

• محدودیت نرخ درخواست برای هر کلید API اعمال می‌شود

• برای دریافت کلید API، به داشبورد خود مراجعه کنید