شروع کار (Getting Started)
راهنمای جامع برای یکپارچهسازی سیستم بازخورد و تعامل با کاربران پلتفرم در سرویسهای شما.
به مستندات API پلتفرم فیدگاه خوش آمدید. این دسترسی به شما اجازه میدهد تا به سادگی و به صورت مستقیم، سیستم مدیریت بازخورد (Feedback)، نظرسنجی (Poll) و قابلیتهای تعاملی پلتفرم را با وبسایتها، اپلیکیشنها و جریانهای کاری داخلی خود یکپارچه (Integrate) کنید.
چرا استفاده از وبسرویس فیدگاه؟
این API با هدف انعطافپذیری بیشتر پلتفرم طراحی شده است تا شما محدود به استفاده از پنل وبسایت نباشید و بتوانید دادههای مربوط به دیدگاهها (Comments) و رأیهای کاربران را در هر محیطی که مایلید مدیریت کنید. با متصل کردن سرویسهای خود به این API، میتوانید از مزایای زیر بهرهمند شوید:
- مدیریت بازخوردها و ایدهها: امکان ثبت، دریافت و دستهبندی پیشنهادات یا گزارشهای خطای کاربران به صورت مستقیم از طریق API.
- سیستم رأیدهی (Upvote) و تعامل: دسترسی به دادههای مربوط به رأیها و دیدگاههای کاربران برای پیادهسازی سیستم اولویتبندی قابلیتها در محصول شما.
- هماهنگی هویت کاربران (SSO): امکان متصل کردن کاربران سیستم خودتان به این API، به طوری که هر کاربر با هویت واقعیاش بتواند بازخورد ثبت کند یا رأی بدهد.
این اتصال به شما کمک میکند تا بدون نیاز به جابهجایی میان پلتفرمهای مختلف، تجربهای یکپارچه از مدیریت صدای کاربران در اکوسیستم نرمافزاری خود ایجاد کنید.
شروع سریع (Quick Start)
فیدگاه سه روش یکپارچهسازی ارائه میدهد. بسته به نیاز و معماری سرویس خود، یکی از روشهای زیر را انتخاب کنید.
روش اول — SDK فرانتاند (کاربران مهمان)
سادهترین روش یکپارچهسازی است. کافی است یک خط اسکریپت در سایت خود قرار دهید؛ هیچ پیکربندی اضافهای نیاز نیست.
برای چه کسانی مناسب است؟ مشتریانی که میخواهند هر بازدیدکنندهای — حتی بدون ورود به سیستم (Login) — بتواند بازخورد ثبت کند یا رأی بدهد.
نحوه استفاده:
کد زیر را در انتهای تگ <body> سایت خود قرار دهید:
<script
src="https://fidegah.ir/api/sdk.js"
data-sdk-token="YOUR_WORKSPACE_TOKEN"
></script>در این حالت کاربران بدون نیاز به ورود به سیستم میتوانند دیدگاه یا رأی خود را به عنوان مهمان (Guest) ثبت کنند.
برای مشاهده تمام اتریبیوتهای قابل تنظیم SDK — از جمله چیدمان، تم، موقعیت و دکمه شناور و همچنین نحوه استفاده — به صفحه پیکربندی SDK مراجعه کنید.
روش دوم — احراز هویت و شناسایی کاربر (Identity & Authentication)
در این روش، دیدگاهها و رأیها با نام و ایمیل کاربران واقعی ثبت میشوند. این کار مدیریت بازخوردها را دقیقتر و قابل پیگیریتر میکند.
برای چه کسانی مناسب است؟ مشتریانی که کاربران آنها در سیستم حساب کاربری دارند و میخواهند بازخوردها به هویت واقعی هر کاربر نسبت داده شود.
نحوه استفاده:
پس از لود شدن اسکریپت SDK، اطلاعات کاربر را از طریق متد identify به فیدگاه معرفی کنید:
Fidegah.identify({
id: "9482", // شناسه (ID) کاربر در دیتابیس شما
name: "نریمان فلاحی",
email: "nariman@example.com",
avatar_url: "https://site.com/avatar.jpg", // اختیاری (Optional)
});برای کسب اطلاعات بیشتر و همچنین نحوه استفاده به صفحه امنیت پیشرفته (Secure Identify) مراجعه کنید.
روش سوم — API سرور به سرور (Server-to-Server)
در این روش، SDK فرانتاند اصلاً وارد کار نمیشود. شما فرمهای اختصاصی خود را طراحی کردهاید و تمام درخواستها مستقیماً از سرور شما به سرور فیدگاه ارسال میشوند.
برای چه کسانی مناسب است؟ مشتریان بزرگ یا توسعهدهندگانی که نمیخواهند از ویجتهای (Widget) آماده استفاده کنند و کنترل کامل روی رابط کاربری و جریان داده دارند.
نحوه استفاده:
درخواستهای HTTP خود را بههمراه کلید API (API Key) در هدر (Header) به endpoint های فیدگاه ارسال کنید:
POST https://fidegah.ir/api/v1/posts
x-api-key: YOUR_SECRET_API_KEY
Content-Type: application/jsonبرای آشنایی با نحوه دریافت کلید API و تنظیمات احراز هویت، به بخش احراز هویت (Authentication) مراجعه کنید.