رفتن به محتوا
دانشیارمستندات
ورود
  • معرفی
  • شروع سریع
  • دانشیار چیست؟
  • صفحهٔ اپ‌ها
  • داخل یک اپ
  • فضای کاری: فایل‌ها و گفت‌وگو
  • اشتراک‌گذاری و اعضا
  • یادداشت و ضبط صدا
  • رزرو نوبت
  • خودکارسازی
  • صفحهٔ خواندن فایل
  • پروفایل شما
  • کلیدهای API
  • احراز هویت
  • اپ، فضای کاری، سند
  • پردازش سند
  • گفت‌وگو و نشست‌ها
  • ارجاع‌ها
  • مهارت‌ها
  • قراردادها
  • فضاهای کاری
  • سندها
  • گفت‌وگو
  • مهارت‌ها
  • خطاها
  • دستیار پشتیبانی مشتری
  • پایگاه دانش داخلی
  • چت‌بات مستندات
  • دستیار آموزشگاه
  • ابزارک سایت
  • تنظیمات ابزارک
  • راهنمای فریم‌ورک‌ها
  • امنیت
  • رفع اشکال
  • پرسش‌های پرتکرار
  1. مستندات
  2. ابزارک سایت
  3. ابزارک سایت

ابزارک سایت

با یک تگ اسکریپت، گفت‌وگو را به سایتتان اضافه کنید. فقط از روی اسناد یک فضای کاری پاسخ می‌دهد.

ابزارک یک پنل گفت‌وگو برای سایت خودتان است. بازدیدکننده سؤال می‌پرسد و پاسخی می‌گیرد که فقط از روی اسناد فضای کاری انتخابی شما نوشته شده است. بازدیدکننده وارد حسابی نمی‌شود، نمی‌تواند چیزی بارگذاری یا تغییر دهد، و فایل‌هایتان یا اینکه پاسخ از کدام سند آمده را نمی‌بیند.

کلید داخل این کد، کلید عمومی ابزارک (pk_…) است. هر کسی می‌تواند آن را در کد صفحه‌تان ببیند، اما با آن فقط می‌شود سؤال پرسید — نه با REST API کار می‌کند، نه فایل‌ها را فهرست می‌کند و نه چیزی را تغییر می‌دهد. پیش از راه‌اندازی، امن کردن کلید ابزارک را بخوانید.

افزودن در سه قدم

  1. ۱

    صفحهٔ ابزارک را باز کنید

    در کنسول، اپ و بعد فضای کاری‌ای را که ابزارک باید از آن پاسخ بدهد باز کنید و «ابزارک» را بزنید. این صفحه پیش‌نمایش زنده و کد ابزارک شما را نشان می‌دهد.

  2. ۲

    دامنه‌تان را اضافه کنید

    در بخش دامنه‌های مجاز، همهٔ سایت‌هایی را که ابزارک را نشان می‌دهند اضافه کنید؛ مثلاً clinic.ir و www.clinic.ir. همهٔ سایت‌ها به‌طور پیش‌فرض مسدودند: با فهرست خالی، ابزارک روی هیچ سایتی کار نمی‌کند.

  3. ۳

    کد را در سایت بگذارید

    کد را کپی کنید و در هر صفحه یک بار، درست پیش از </body> بگذارید. با async بارگذاری می‌شود، پس صفحه‌تان را کند نمی‌کند.

    HTML
    <script
      src="https://app.daneshyar.info/widget.js"
      data-api-key="sk_9f3aC2xQ7mB1vT8sE4nK6pR0jY5wZ2hL"
      data-app-id="2d7c0e91-4a5b-4f8e-b3c6-9e1f0a7d5c42"
      data-workspace-id="8f14e45f-ceea-467a-9f4c-1a2b3c4d5e6f"
      async
    ></script>

با React، Next.js، Vue یا فریم‌ورک دیگری کار می‌کنید؟ راهنمای فریم‌ورک‌ها را ببینید.

چطور کار می‌کند

اسکریپت یک دکمه روی صفحه‌تان می‌گذارد. وقتی بازدیدکننده آن را باز می‌کند، گفت‌وگو داخل یک iframe روی سایت خود دانشیار بارگذاری می‌شود؛ پس CSS شما آن را به هم نمی‌ریزد و ابزارک هم به صفحهٔ شما دسترسی ندارد.

صفحهٔ شماwidget.js را بارگذاری می‌کند و دکمهٔ گفت‌وگو را نشان می‌دهد.<script src="…/widget.js">
iframe ابزارکروی سایت دانشیار اجرا می‌شود. مرورگر فقط روی دامنه‌های مجاز شما نشانش می‌دهد و سرور ما هم فقط به سؤال‌های همان دامنه‌ها پاسخ می‌دهد.frame-ancestors
API ابزارککلید ابزارک را بررسی می‌کند و پاسخ را از اسناد شما پیدا می‌کند. پاسخ منبعی همراه ندارد./api/widget/chat/
روی سایتی که در فهرست مجاز شما نیست، مرورگر iframe را نشان نمی‌دهد و بازدیدکننده چیزی نمی‌بیند.
صفحهٔ شما widget.js را بارگذاری می‌کند. اسکریپت یک iframe روی سایت دانشیار باز می‌کند. iframe هر سؤال را همراه کلید ابزارک و نشانی صفحهٔ شما به API ابزارک می‌فرستد. روی سایت‌هایی که در فهرست مجاز نیستند، مرورگر iframe را نشان نمی‌دهد و سرور ما هم پاسخ نمی‌دهد.
  • ابزارک فقط می‌خواند: اسناد فضای کاری را فهرست می‌کند و به سؤال‌ها دربارهٔ آن‌ها پاسخ می‌دهد.
  • فقط با دو مسیر کار دارد: /api/widget/config/ و /api/widget/chat/.
  • پاسخ‌ها مستند هستند. اگر جواب در اسناد نباشد، ابزارک به‌جای حدس زدن همین را می‌گوید.

دربارهٔ کلید داخل کد

ابزارک با کلید عمومی ابزارکِ اپ احراز هویت می‌شود. این همان کلیدی نیست که REST API می‌پذیرد. آنچه می‌تواند و نمی‌تواند:

  • می‌تواند در فضاهای کاری این اپ سؤال بپرسد و دامنه‌های مجاز ابزارک را بخواند. همین و بس.
  • نمی‌تواند فایل‌هایتان را فهرست کند، بخواند یا دانلود کند، و پاسخ‌هایش نمی‌گویند از کدام سند آمده‌اند.
  • پاسخ‌ها همچنان محتوای اسنادتان را بازگو می‌کنند؛ پس در این فضای کاری فقط اسنادی بگذارید که اشکالی ندارد بازدیدکننده‌ها از محتوایشان باخبر شوند.
برای REST API از کلید محرمانه (sk_…) در سرورتان استفاده کنید. هیچ‌وقت کلید محرمانه را در کد ابزارک نگذارید.

بازدیدکننده چه می‌بیند

  • یک دکمهٔ گرد در گوشهٔ صفحه، یا گفت‌وگو داخل عنصری که خودتان تعیین می‌کنید (حالت درون‌صفحه‌ای).
  • فهرست اسنادی که پاسخ‌ها از روی آن‌ها نوشته می‌شوند.
  • پاسخ‌هایی به فارسی یا انگلیسی، فقط از روی اسناد شما.
  • روی گوشی‌های باریک‌تر از ۴۸۰ پیکسل، گفت‌وگو تمام‌صفحه باز می‌شود.

دامنه‌های مجاز

فهرست مجاز تعیین می‌کند کدام سایت‌ها اجازه دارند ابزارک را نشان دهند. این فهرست به کل اپ تعلق دارد، پس یک فهرست برای ابزارکِ همهٔ فضاهای کاری آن اپ کافی است. نام میزبان را بدون https:// و بدون مسیر وارد کنید. شمارهٔ پورت هم جزو نام میزبان حساب می‌شود.

چیزی که وارد می‌کنیدروی این کار می‌کندروی این کار نمی‌کند
clinic.irclinic.irwww.clinic.ir
*.clinic.irwww.clinic.ir · help.clinic.irclinic.ir
localhost:5173localhost:5173localhost:3000
  • همهٔ سایت‌ها به‌طور پیش‌فرض مسدودند. فهرست خالی یعنی ابزارک روی هیچ سایتی کار نمی‌کند — فقط پیش‌نمایش داخل کنسول.
  • الگویی مثل *.clinic.ir زیردامنه‌ها را پوشش می‌دهد، اما خود clinic.ir را نه. اگر هر دو را لازم دارید، هر دو را اضافه کنید.
  • فعلاً نمی‌توانید آخرین دامنه را در کنسول از فهرست حذف کنید. برای خاموش کردن ابزارک در همه‌جا، کلید ابزارک را در صفحهٔ اپ حذف کنید.

محدودیت‌ها و هزینه

هر محدودیت جداگانه حساب می‌شود. وقتی بازدیدکننده به یکی از آن‌ها برسد، ابزارک از او می‌خواهد کمی صبر کند و بعد دوباره امتحان کند.

محدودیتمقدار پیش‌فرضچه چیزی را می‌شمارد
widget_chat_ip۲۰ در ساعتسؤال‌های یک نشانی IP.
widget_chat_app۵۰۰ در روزسؤال‌های همهٔ بازدیدکننده‌ها از کل اپ شما.
widget_get_ip۶۰ در ساعتدفعه‌های بارگذاری تنظیمات و فهرست اسناد ابزارک از یک نشانی IP.

هر پاسخ، مثل گفت‌وگو در کنسول، از اعتبار حسابی کم می‌شود که مالک اپ است. وقتی اعتبار تمام شود، بازدیدکننده پیام «دستیار الان نمی‌تواند پاسخ بدهد» را می‌بیند و هیچ‌وقت پیامی دربارهٔ پرداخت نمی‌بیند.

تنظیمات ابزارکهمهٔ گزینه‌هایی که ابزارک می‌خواند، با مقدار پیش‌فرضشان، و ابزاری که کد را برایتان می‌سازد.راهنمای فریم‌ورک‌هاجای کد ابزارک در HTML، React، Next.js، Vue، Nuxt، Angular، SvelteKit و Laravel.امنیتهر کدام از دو کلید شما کجا می‌تواند باشد، چه چیزی از آن محافظت می‌کند، و چک‌لیست پیش از راه‌اندازی.رفع اشکالمشکل را از روی چیزی که می‌بینید پیدا کنید و بخوانید چرا پیش می‌آید و چطور حل می‌شود.
قبلیدستیار آموزشگاهبعدیتنظیمات ابزارک

در این صفحه

  • افزودن در سه قدم
  • چطور کار می‌کند
  • دربارهٔ کلید داخل کد
  • بازدیدکننده چه می‌بیند
  • دامنه‌های مجاز
  • محدودیت‌ها و هزینه

همهٔ نمونه‌های این مستندات روی API واقعی اجرا می‌شوند. اگر نمونه‌ای کار نکرد، به ما بگویید؛ آن یک باگ در مستندات است.

خدماتدربارهٔ ماگفت‌وگو با ما