پرش به محتوای اصلی
گویچهGUYCHE
مستندات توسعه‌دهنده

نصب ایمن و غیرمسدودکننده ابزارک گویچه

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

1

Site را در داشبورد بسازید

Site ID را از صفحه ابزارک کپی و فقط دامنه‌های مجاز واقعی را ثبت کنید.

2

اسکریپت را async بارگذاری کنید

قطعه زیر پس از parser اجرا می‌شود و نباید مسیر رندر اولیه صفحه میزبان را مسدود کند.

3

CSP را هماهنگ کنید

در صورت استفاده از CSP محدود، https://www.guyche.ir را برای script-src و connect-src مجاز کنید.

4

سناریوهای شکست را بیازمایید

موبایل، صفحه‌کلید، پاسخ streaming، سؤال بدون پاسخ، reconnect و انتقال به اپراتور را پیش از انتشار تست کنید.

قطعه نصب

مقدار placeholder را با Site ID همان محیط جایگزین کنید. Site ID کلید محرمانه نیست، اما فقط برای Site و دامنه‌های تعریف‌شده معتبر است.

<script>
  (function () {
    var script = document.createElement("script");
    script.src = "https://www.guyche.ir/widget.js";
    script.async = true;
    script.dataset.siteId = "SITE_ID_FROM_GUYCHE_DASHBOARD";
    document.head.appendChild(script);
  })();
</script>

مرزهای امنیتی

  • Origin و دامنه مجاز در API ابزارک بررسی می‌شود.
  • محتوای پیام و لینک‌ها پیش از رندر امن‌سازی می‌شوند.
  • Secret یا کلید ارائه‌دهنده هوش مصنوعی نباید در snippet قرار گیرد.

رفتار عملکردی

اسکریپت async است و رابط داخل Shadow DOM رندر می‌شود. سایت میزبان باید همچنان loading واقعی، اثر بر LCP و INP و اندازه viewport خود را اندازه‌گیری کند؛ async بودن به‌تنهایی تضمین امتیاز نیست.