مستندات فنی

مستنداتِ ویجت

راهنمای نصب و استفاده از ویجتِ گفتگوی زنده روی سایت شما.

۱. نصب سریع

کدِ زیر را با کلیدِ سایتِ خود (YOUR_API_KEY) قبل از تگ </body> قرار دهید:

<script>
  window.ravin = window.ravin || { q: [] };
  window.ravin.q.push(['init', {
    apiKey: 'YOUR_API_KEY',
    baseUrl: 'https://www.ravinchat.com'
  }]);
</script>
<script src="/js/ravin-chat.js" async></script>

کلیدِ سایت را از پنل ← «سایت‌ها» ← سایتِ موردنظر بردارید.

۲. دکمهٔ «گفتگو با ما»

هر دکمه یا لینکی که ویژگیِ data-ravin-open داشته باشد، با کلیک پنجرهٔ گفتگو را باز می‌کند:

<a href="#" data-ravin-open>گفتگو با پشتیبانی</a>

همچنین از کد می‌توانید ravin('open')، ravin('close') و ravin('toggle') را صدا بزنید.

۳. افزونهٔ وردپرس

برای سایت‌های وردپرسی، از پنل ← سایتِ موردنظر، افزونهٔ ravin-chat.zip را دانلود کنید (کلید از قبل داخلش تنظیم شده) و از مسیرِ «افزونه‌ها ← افزودن ← بارگذاری افزونه» نصب و فعال کنید — بدونِ کدنویسی.

۴. صفحهٔ اختصاصیِ گفتگو

یک صفحهٔ کاملِ گفتگو با آدرسِ اختصاصی، بدونِ نیاز به سایت:

https://www.ravinchat.com/chat/YOUR_API_KEY

۵. API عمومی ویجت

  • GET /api/widget/{apiKey}/config — تنظیمات ویجت
  • POST /api/widget/{apiKey}/init — شروع مکالمه
  • POST /api/widget/{apiKey}/send — ارسال پیام
  • GET /api/widget/{apiKey}/poll — دریافت پیام‌های جدید