رفتن به محتوا
دانشیارمستندات
ورود
  • ویجت جاسازی‌شدهدر نقشهٔ راه: به‌زودی
  • SDK برای TypeScriptدر نقشهٔ راه: به‌زودی
  1. مستندات
  2. یکپارچه‌سازی
  3. ویجت جاسازی‌شده

ویجت جاسازی‌شده

در نقشهٔ راه: به‌زودی

یک پنل گفت‌وگوی آماده برای سایت خودتان. هنوز در دسترس نیست.

وضعیت

ویجت جاسازی‌شده هنوز در دسترس نیست، و این صفحه هست تا روی چیزی که امروز نمی‌تواند کار کند برنامه‌ای نسازید.

نیمهٔ سمت کاربر تمام شده — اسکریپت بارگذار، ابزار پیکربندی در کنسول، و پنل گفت‌وگوی کارآمد وجود دارد. نیمهٔ سمت سرور هرگز ساخته نشد. ویجت جاسازی‌شده نمایش داده می‌شود و بعد نمی‌تواند به چیزی پاسخ بدهد، چون مسیرهایی که صدا می‌زند وجود ندارند.

تا آمدنش، راه پشتیبانی‌شده برای گذاشتن یک گفت‌وگوی مستند روی سایت خودتان این است که این API را از سرور خودتان پراکسی کنید، همان‌طور که نمونه‌های این مستندات انجام می‌دهند.

چطور کار خواهد کرد

طراحی قطعی شده است. مشتری یک تگ اسکریپت می‌چسباند؛ آن تگ یک iframe را روی یک فضای کاری سوار می‌کند و بازدیدکننده از سندهایی می‌پرسد که مالک اپ گردآوری کرده است. بازدیدکننده‌ها هرگز وارد نمی‌شوند و نمی‌توانند بارگذاری کنند — ویجت از پایه فقط‌خواندنی است.

از کلید انتشاری جداگانه‌ای استفاده خواهد کرد، نه کلید API که اینجا مستند شده. محدودیت اصلی همین است: کلید ویجت در کد صفحهٔ مشتری چاپ می‌شود و کلیدی که در این سایت می‌بینید می‌تواند فضای کاری حذف کند و همهٔ فایل‌های ذخیره‌شده را دانلود کند. این دو نمی‌توانند یک اعتبارنامه باشند.

چه چیزی مانع است

پنج چیز باقی مانده که همه سمت سرورند:

  1. سه مسیر باریک و فقط‌خواندنی برای ویجت — پیکربندی، سندها و گفت‌وگو.
  2. یک کلید انتشاری که فقط همان مسیرها را احراز هویت کند و نه چیز دیگری.
  3. فیلد دامنه‌های مجاز روی اپ، تا کلید برداشته‌شده از سایت دیگری قابل استفاده نباشد.
  4. اعتبارسنجی Origin سمت سرور. هدر frame-ancestors که از قبل تنظیم شده جلوی iframe شدن را می‌گیرد، اما جلوی درخواست مستقیم را نه.
  5. محدودیت نرخ به‌ازای هر کلید. کلید عمومی جلوی یک مدل زبانی بدون سقف، دعوت باز است.
قبلیچت‌بات مستنداتبعدیSDK برای TypeScript

در این صفحه

  • وضعیت
  • چطور کار خواهد کرد
  • چه چیزی مانع است

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

گفت‌وگو با ما