AlvandCMS از یک سیستم REST API یکپارچه استفاده میکند. تمام APIها در مسیر core/system/api/ قرار دارند.
معماری API
core/system/api/
auth/ # API های احراز هویت
media/ # API های رسانه
settings/ # API های تنظیمات
posts/ # API های پستها
pages/ # API های برگهها
categories/ # API های دستهبندی
comments/ # API های نظرات
users/ # API های کاربران
access/ # API های دسترسی
menus/ # API های منوها
themes/ # API های قالبها
plugins/ # API های پلاگینها
node/ # API های گرهها
slider/ # API های اسلایدر
calendar/ # API های تقویم
statistics/ # API های آمار
notifications/ # API های اعلانها
services/ # API های سرویسها
page-builder/ # API های صفحه ساز
file/ # API های فایل
download/ # API های دانلود امن
dashboard/ # API های داشبورد
alvand/ # API های سیستمی
search.php # API جستجو
create.php # API ایجاد
read.php # API خواندن
update.php # API بهروزرسانی
delete.php # API حذف
ساختار استاندارد API
پاسخ استاندارد
json
{
"ok": true,
"data": { ... }
}
پاسخ خطا
json
{
"ok": false,
"error": "ERROR_CODE",
"message": "توضیحات خطا"
}
توابع پایه
json_out()
php
function json_out(array $arr, int $code = 200): void
require_method()
php
function require_method(string $method): void
check_csrf()
php
function check_csrf(?string $t): void
API های سیستمی
| مسیر | توضیح |
|---|
/api/alvand/check_update | بررسی بروزرسانی |
/api/alvand/do_update | اجرای بروزرسانی |
/api/alvand/license_check | اعتبارسنجی لایسنس |
/api/alvand/support | اطلاعات پشتیبانی |
API های عمومی
| مسیر | توضیح |
|---|
/api/search | جستجوی سراسری |
/api/token/generate | تولید توکن |
/api/guide/loader | بارگذاری راهنما |
/api/ui/load_field | بارگذاری فیلد فرم |
API های اعلانها
| مسیر | توضیح |
|---|
/api/notifications/create | ایجاد اعلان |
/api/notifications/read | خواندن اعلانها |
/api/notifications/update | بروزرسانی (خوانده شده) |
/api/notifications/delete | حذف اعلان |
/api/notificationChannels/create | ایجاد کانال |
/api/notificationChannels/read | خواندن کانالها |
/api/notificationChannels/update | بروزرسانی کانال |
API های تقویم
| مسیر | توضیح |
|---|
/api/calendar/create | ایجاد رویداد |
/api/calendar/read | خواندن رویدادها |
/api/calendar/delete | حذف رویداد |
/api/calendar/event | رویداد تکی |
/api/calendar/events | همه رویدادها |
/api/calendar/related | رویدادهای مرتبط |
API های پست و برگه
| مسیر | توضیح |
|---|
/api/post/create | ایجاد پست |
/api/post/read | خواندن پست |
/api/post/update | بروزرسانی پست |
/api/post/delete | حذف پست |
/api/post/smart-update | بروزرسانی هوشمند |
/api/page/create | ایجاد برگه |
/api/page/read | خواندن برگه |
/api/page/update | بروزرسانی برگه |
/api/page/delete | حذف برگه |
API های گره (Node)
| مسیر | توضیح |
|---|
/api/node/create | ایجاد گره |
/api/node/read | خواندن گره |
/api/node/update | بروزرسانی گره |
/api/node/delete | حذف گره |
/api/node/manage-definition | مدیریت تعریف گره |
API های دسترسی (Access)
| مسیر | توضیح |
|---|
/api/access/create | ایجاد نقش |
/api/access/read | خواندن نقشها |
/api/access/update | بروزرسانی نقش |
/api/access/delete | حذف نقش |
/api/access/tree-builder | درخت دسترسی |
API های علاقهمندی
| مسیر | توضیح |
|---|
/api/favorite/add | افزودن به علاقهمندی |
/api/favorite/remove | حذف از علاقهمندی |
API های گارانتی
| مسیر | توضیح |
|---|
/api/warranty/create | ایجاد گارانتی |
/api/warranty/read | خواندن گارانتی |
