ابزارک سایت
با یک تگ اسکریپت، گفتوگو را به سایتتان اضافه کنید. فقط از روی اسناد یک فضای کاری پاسخ میدهد.
ابزارک یک پنل گفتوگو برای سایت خودتان است. بازدیدکننده سؤال میپرسد و پاسخی میگیرد که فقط از روی اسناد فضای کاری انتخابی شما نوشته شده است. بازدیدکننده وارد حسابی نمیشود، نمیتواند چیزی بارگذاری یا تغییر دهد، و فایلهایتان یا اینکه پاسخ از کدام سند آمده را نمیبیند.
افزودن در سه قدم
صفحهٔ ابزارک را باز کنید
در کنسول، اپ و بعد فضای کاریای را که ابزارک باید از آن پاسخ بدهد باز کنید و «ابزارک» را بزنید. این صفحه پیشنمایش زنده و کد ابزارک شما را نشان میدهد.
دامنهتان را اضافه کنید
در بخش دامنههای مجاز، همهٔ سایتهایی را که ابزارک را نشان میدهند اضافه کنید؛ مثلاً
clinic.irوwww.clinic.ir. همهٔ سایتها بهطور پیشفرض مسدودند: با فهرست خالی، ابزارک روی هیچ سایتی کار نمیکند.کد را در سایت بگذارید
کد را کپی کنید و در هر صفحه یک بار، درست پیش از
</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 شما آن را به هم نمیریزد و ابزارک هم به صفحهٔ شما دسترسی ندارد.
<script src="…/widget.js">frame-ancestors/api/widget/chat/- ابزارک فقط میخواند: اسناد فضای کاری را فهرست میکند و به سؤالها دربارهٔ آنها پاسخ میدهد.
- فقط با دو مسیر کار دارد:
/api/widget/config/و/api/widget/chat/. - پاسخها مستند هستند. اگر جواب در اسناد نباشد، ابزارک بهجای حدس زدن همین را میگوید.
دربارهٔ کلید داخل کد
ابزارک با کلید عمومی ابزارکِ اپ احراز هویت میشود. این همان کلیدی نیست که REST API میپذیرد. آنچه میتواند و نمیتواند:
- میتواند در فضاهای کاری این اپ سؤال بپرسد و دامنههای مجاز ابزارک را بخواند. همین و بس.
- نمیتواند فایلهایتان را فهرست کند، بخواند یا دانلود کند، و پاسخهایش نمیگویند از کدام سند آمدهاند.
- پاسخها همچنان محتوای اسنادتان را بازگو میکنند؛ پس در این فضای کاری فقط اسنادی بگذارید که اشکالی ندارد بازدیدکنندهها از محتوایشان باخبر شوند.
بازدیدکننده چه میبیند
- یک دکمهٔ گرد در گوشهٔ صفحه، یا گفتوگو داخل عنصری که خودتان تعیین میکنید (حالت درونصفحهای).
- فهرست اسنادی که پاسخها از روی آنها نوشته میشوند.
- پاسخهایی به فارسی یا انگلیسی، فقط از روی اسناد شما.
- روی گوشیهای باریکتر از ۴۸۰ پیکسل، گفتوگو تمامصفحه باز میشود.
دامنههای مجاز
فهرست مجاز تعیین میکند کدام سایتها اجازه دارند ابزارک را نشان دهند. این فهرست به کل اپ تعلق دارد، پس یک فهرست برای ابزارکِ همهٔ فضاهای کاری آن اپ کافی است. نام میزبان را بدون https:// و بدون مسیر وارد کنید. شمارهٔ پورت هم جزو نام میزبان حساب میشود.
| چیزی که وارد میکنید | روی این کار میکند | روی این کار نمیکند |
|---|---|---|
clinic.ir | clinic.ir | www.clinic.ir |
*.clinic.ir | www.clinic.ir · help.clinic.ir | clinic.ir |
localhost:5173 | localhost:5173 | localhost:3000 |
- همهٔ سایتها بهطور پیشفرض مسدودند. فهرست خالی یعنی ابزارک روی هیچ سایتی کار نمیکند — فقط پیشنمایش داخل کنسول.
- الگویی مثل *.clinic.ir زیردامنهها را پوشش میدهد، اما خود clinic.ir را نه. اگر هر دو را لازم دارید، هر دو را اضافه کنید.
- فعلاً نمیتوانید آخرین دامنه را در کنسول از فهرست حذف کنید. برای خاموش کردن ابزارک در همهجا، کلید ابزارک را در صفحهٔ اپ حذف کنید.
محدودیتها و هزینه
هر محدودیت جداگانه حساب میشود. وقتی بازدیدکننده به یکی از آنها برسد، ابزارک از او میخواهد کمی صبر کند و بعد دوباره امتحان کند.
| محدودیت | مقدار پیشفرض | چه چیزی را میشمارد |
|---|---|---|
widget_chat_ip | ۲۰ در ساعت | سؤالهای یک نشانی IP. |
widget_chat_app | ۵۰۰ در روز | سؤالهای همهٔ بازدیدکنندهها از کل اپ شما. |
widget_get_ip | ۶۰ در ساعت | دفعههای بارگذاری تنظیمات و فهرست اسناد ابزارک از یک نشانی IP. |
هر پاسخ، مثل گفتوگو در کنسول، از اعتبار حسابی کم میشود که مالک اپ است. وقتی اعتبار تمام شود، بازدیدکننده پیام «دستیار الان نمیتواند پاسخ بدهد» را میبیند و هیچوقت پیامی دربارهٔ پرداخت نمیبیند.