مرجع API

آدرس پایه

همه‌ی مسیرهای API عمومی زیر https://api.plexit.ir/v1 قرار دارند؛ برای نمونه، فهرست دستیارها در https://api.plexit.ir/v1/assistants است. همه‌ی درخواست‌ها و پاسخ‌ها JSON هستند (به‌جز بارگذاری فایل که multipart/form-data است).

احراز هویت

هر درخواست باید هدر Authorization: Bearer <raw_key> را داشته باشد. کلید را در کنسول پلکسیت بسازید؛ جزئیات در احراز هویت و کلیدهای API آمده است.

قالب پاسخ

هر پاسخ، چه موفق چه ناموفق، به شکل { "data": ..., "response": { "status", "message" } } است؛ فهرست‌ها در data.list و data.count برمی‌گردند و در خطاها data برابر null است. در کد خود بر اساس response.status و کد وضعیت HTTP تصمیم بگیرید، نه متن message — جزئیات در خطاها.

صفحه‌های مرجع

کلیدهای API دستیارها مدل‌ها گفتگو اسناد محصولات

مسیرهای دیگر روی همین میزبان

این‌ها جزو API محافظت‌شده با کلید بالا نیستند:

محتوای سایت — GET /v1/content/:type/articles، .../articles/:slug، .../categories و GET /v1/content/slugs مقاله‌های منتشرشده‌ی وبلاگ، راهنما و تغییرات plexit.ir را می‌دهند. کلید API نمی‌خواهند و به ازای هر IP محدود شده‌اند (۱٬۲۰۰ درخواست در دقیقه)؛ پاسخ‌ها ۶۰ ثانیه قابل کش‌اند.
وب‌هوک پیام‌رسان‌ها — POST /hooks/:driver/:connectionCode جایی است که تلگرام، بله و پلتفرم‌های مشابه پیام‌های یک کانال را که در کنسول وصل می‌کنید تحویل می‌دهند. کنسول آن را برای شما ثبت می‌کند؛ خودتان هرگز صدایش نمی‌زنید.