فراخوانی API یکی از مهم‌ترین قابلیت‌های بیکس‌چت است که به شما امکان می‌دهد به صورت خودکار از سرویس‌های خارجی اطلاعات بگیرید یا اطلاعاتی ارسال کنید. این عملیات می‌تواند مسیر گفتگو با کاربران را بر اساس داده‌های لحظه‌ای و زنده تغییر دهد.
در ادامه قدم به قدم با هم فرآیند ایجاد یک عملیات فراخوانی API را مرور می‌کنیم:
ورود به بخش تنظیمات چت‌بات #
ابتدا وارد پنل بیکس‌بات شوید.
از منوی سمت راست، روی چت بات‌های هوشمند کلیک کنید.
در لیست چت‌بات‌ها، چت موردنظر خود را انتخاب کرده و روی آیکون تنظیمات (پیاده‌سازی ساختار چت هوشمند) کلیک کنید.
افزودن عملیات جدید #
در صفحه تنظیمات چت‌بات، روی آیکون افزودن (علامت +) کلیک کنید.
یک پنجره در سمت راست باز می‌شود.
در این مرحله باید نوع عملیات را انتخاب کنید.
از بین گزینه‌ها، فراخوانی API را انتخاب کنید.
سپس روی مرحله بعد کلیک کنید.
تکمیل اطلاعات عملیات فراخوانی API #
حالا باید تنظیمات مربوط به این عملیات را انجام دهید:
بخش اول: تعیین شرط ورود کاربر به این عملیات
پاسخ‌های عملیات قبلی:
در این فیلد باید تعیین کنید که این عملیات بر چه اساسی فعال شود.
اگر می‌خواهید این فراخوانی API فقط برای کاربرانی انجام شود که یک پاسخ مشخص در مراحل قبلی داده‌اند، مقدار دقیق پاسخ را وارد کنید.
اگر می‌خواهید بدون توجه به پاسخ قبلی همه کاربران وارد این عملیات شوند، گزینه‌ی به ازای تمام پاسخ‌ها را فعال کنید.
بخش دوم: نام‌گذاری عملیات #
نام عملیات:
یک عنوان داخلی برای این عملیات وارد کنید. این عنوان فقط در پنل مدیریت دیده می‌شود و به کاربر نمایش داده نمی‌شود.
این کمک می‌کند عملیات‌های مختلف خود را راحت‌تر شناسایی و مدیریت کنید.
توضیحات عملیات #
توضیحات عملیات (در پنل ادمین):
شرح کوتاهی درباره‌ی کاربرد این عملیات بنویسید تا اگر بعداً خواستید آن را ویرایش یا بررسی کنید، بدانید این عملیات چه نقشی دارد.
توضیحات قابل نمایش به کاربر:
اگر می‌خواهید همزمان با اجرای فراخوانی API متنی به کاربر نمایش داده شود (مثلاً یک سوال یا پیام راهنما)، اینجا وارد کنید.
این متن در جریان چت به کاربر نمایش داده خواهد شد.
بخش سوم: تعریف API #
API یا URL :
آدرس سرویس API که می‌خواهید اطلاعات را از آن بگیرید یا به آن ارسال کنید را وارد نمایید.
دقت کنید که این URL باید درست، معتبر و قابل دسترسی باشد.
بخش چهارم: تعریف نام فیلد #
نام فیلد:
این نام اهمیت زیادی دارد.
اطلاعاتی که از API دریافت می‌شود در این فیلد ذخیره می‌شود و اگر در عملیات‌های بعدی نیاز به ارجاع به این اطلاعات داشته باشید، باید همین نام را فراخوانی کنید.
پیشنهاد می‌کنیم برای نظم بهتر، از نام انگلیسی و بدون فاصله استفاده کنید (مثل: user_info یا order_status)
تعیین نوع نمایش داده دریافتی #
نوع نمایش API:
انتخاب کنید که داده‌ی دریافتی چگونه به کاربر نشان داده شود.
مثلاً اگر API یک لیست از آیتم‌ها برمی‌گرداند، ممکن است بخواهید آن را به صورت چند گزینه‌ای به کاربر نمایش دهید.
یا اگر فقط یک متن ساده است، نمایش به صورت متن ساده کافی خواهد بود.
انتخاب درست این بخش باعث می‌شود تجربه کاربری بهتری بسازید.
بخش پنجم: تعیین توکن مصرفی #
توکن مصرفی:
مشخص کنید با اجرای این عملیات چه مقدار توکن از حساب کاربر کسر شود.
این عدد باید بر حسب ریال وارد شود و مستقیماً به کیف پول شما (صاحب کسب‌وکار) اضافه خواهد شد.
نکات مهم درباره عملیات فراخوانی API: #
اگر API شما نیاز به احراز هویت یا پارامترهای خاصی دارد، باید حتماً از ساختار درست آدرس‌دهی استفاده کنید یا از تیم فنی بخواهید پشتیبانی مناسب برای اتصال را فراهم کنند.
نام‌گذاری درست عملیات‌ها و فیلدها اهمیت زیادی دارد و در پروژه‌های بزرگ باعث صرفه‌جویی در زمان و کاهش اشتباه می‌شود.
