مستندات ای‌پی‌آی آی-سیستا

احراز هویت

تمام درخواست‌های ای‌پی‌آی برای احراز هویت به کلید ای‌پی‌آی نیاز دارند. می‌توانید کلید ای‌پی‌آی خود را از صفحه 'اتصال' در پیشخوان کسب‌وکارتان ایجاد و مدیریت کنید.

کلید ای‌پی‌آی باید در هدر هر درخواست به صورت زیر قرار گیرد:

api-key: YOUR_API_KEY

آدرس پایه: https://Aisista.com/api/

GET دریافت تاریخچه گفتگو

/api/?method=gethistory

این نقطه پایان تاریخچه گفتگو را برای یک کاربر خاص که با `chat_id` منحصر به فرد شناسایی می‌شود، بازیابی می‌کند.

پارامترها

پارامتر	نوع	توضیحات
`method`	String	اجباری. باید 'gethistory' باشد.
`chat_id`	String \| Integer	اجباری. شناسه منحصر به فرد برای کاربر نهایی شما (مثلاً شناسه کاربر از سیستم شما یا شناسه نشست).

نمونه درخواست (کرل)

curl -X GET "https://Aisista.com/api/?method=gethistory&chat_id=USER12345" \
-H "api-key: YOUR_API_KEY"

نمونه پاسخ

[
    {
        "user": "Hello, what are your opening hours?",
        "chatbot": "We are open from 9 AM to 5 PM on weekdays.",
        "to_follow": null,
        "time": "2024-08-15 10:30:00"
    },
    {
        "user": "Thanks!",
        "chatbot": "You're welcome! Is there anything else I can help with?",
        "to_follow": null,
        "time": "2024-08-15 10:30:15"
    }
]

POST ارسال پیام جدید

/api/?method=newmessage

این نقطه پایان یک پیام جدید از کاربر به چت‌بات ارسال می‌کند و پاسخ تولیدشده توسط هوش مصنوعی را برمی‌گرداند.

پارامترها

پارامتر	نوع	توضیحات
`method`	String	اجباری. باید 'newmessage' باشد.
`chat_id`	String \| Integer	اجباری. شناسه منحصر به فرد برای کاربر نهایی شما. این باعث تداوم گفتگو می‌شود.
`message`	String	اجباری. متن پیام کاربر.
`system_prompt`	String	اختیاری. دستورالعمل‌های اضافی و موقت برای هوش مصنوعی در این پیام خاص. مثلاً می‌توانید داده‌های کاربر مانند 'نام کاربر جان دو است.' را ارسال کنید.

نمونه درخواست (کرل)

curl -X POST "https://Aisista.com/api/" \
-H "api-key: YOUR_API_KEY" \
-d "method=newmessage" \
-d "chat_id=USER12345" \
-d "message=Do you ship to Canada?" \
-d "system_prompt=The user is currently viewing the 'Leather Watch' product page."

نمونه پاسخ

{
    "ok": true,
    "response": "Yes, we ship to Canada! Shipping for the Leather Watch takes about 5-7 business days."
}

مدیریت خطا

اگر یک درخواست با خطا مواجه شود، ای‌پی‌آی یک شیء جی‌سون با کلید `error` و یک پیام توضیحی برمی‌گرداند.

نمونه پاسخ خطا

{
    "error": "Invalid API key"
}