logo
REST API

مستندات API شاپ پیلوت

راهنمای یکپارچه‌سازی چت‌بات هوشمند با بک‌اند، اپ موبایل یا CRM

ابتدا در پنل بات بسازید و سرویس API را فعال کنید. سپس با توکن API از endpointهای زیر استفاده کنید. پاسخ‌ها JSON و قابل parse در هر زبان برنامه‌نویسی هستند.

۱. ساخت بات

در پنل بات بسازید، آموزش دهید و وضعیت آن را فعال کنید.

۲. دریافت API Token

از بخش پروفایل پنل، توکن API خود را کپی کنید.

۳. فراخوانی REST

درخواست HTTP بزنید و پاسخ JSON را در UI خود نمایش دهید.

POST /chat/template API Token

ارسال پیام به بات

پیام کاربر را به بات فعال ارسال می‌کند و پاسخ هوشمند JSON دریافت می‌کنید.

این endpoint اصلی یکپارچه‌سازی REST است. با ارسال متن پیام، شناسه بات و کلید API، پاسخ بات را دریافت می‌کنید. برای ادامه مکالمه مهمان، فیلد guest_key را در درخواست‌های بعدی ارسال کنید.

پارامترها

نام نوع الزامی توضیح
text string بله متن پیام کاربر (حداکثر ۵۰۰۰ کاراکتر)
bot_uid uuid بله شناسه یکتای بات فعال در پنل
api_key string بله توکن API از بخش پروفایل پنل
guest_key uuid خیر شناسه مهمان برای ادامه مکالمه (در پاسخ اول برگردانده می‌شود)

Request Body

{
    "text": "وضعیت سفارش #8823 چیه؟",
    "bot_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "api_key": "your_api_token_here",
    "guest_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Response 200

{
    "status": "success",
    "result": "سفارش 8823 در وضعیت «آماده ارسال» است.",
    "q": [],
    "base_message": "وضعیت سفارش #8823 چیه؟",
    "total_token": 142,
    "time_response": 1.24,
    "suggest": [
        "بله، لینک رهگیری بفرست"
    ],
    "guest_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

خطاهای رایج

  • 401 کلید API نامعتبر است.
  • 403 این کلید API به این بات دسترسی ندارد.
  • 404 بات فعال یافت نشد.
  • 422 خطای اعتبارسنجی پارامترها.
GET /is-active-server بدون احراز هویت

بررسی وضعیت سرور AI

وضعیت دسترسی به سرویس هوش مصنوعی را بررسی می‌کند.

برای health check و مانیتورینگ استفاده کنید. اگر سرویس AI در دسترس باشد مقدار status برابر success است.

Response 200

{
    "status": "success"
}

خطاهای رایج

  • 200 در صورت عدم دسترسی، status برابر error است.

آماده یکپارچه‌سازی هستید؟

ثبت‌نام کنید، بات بسازید و سرویس API را فعال کنید — اولین درخواست را امروز بزنید.

شروع رایگان

فعال‌سازی Pay as you go

مکالمه با هوش مصنوعی