راهنما
مدیریت بخش راهنمای سیستم شامل دستهبندیها و مقالات راهنما.
endpointهای موجود
| Method |
Path |
توضیح |
| GET |
/api/help/categories |
لیست دستهبندیهای راهنما |
| POST |
/api/help/categories |
ایجاد دستهبندی جدید |
| GET |
/api/help/categories/{id} |
مشاهده جزئیات یک دستهبندی |
| PUT |
/api/help/categories/{id} |
بروزرسانی کامل یک دستهبندی |
| PATCH |
/api/help/categories/{id} |
بروزرسانی جزئی یک دستهبندی |
| DELETE |
/api/help/categories/{id} |
حذف یک دستهبندی |
| GET |
/api/help/articles/suggestions |
پیشنهادات مقالات |
| GET |
/api/help/articles |
لیست مقالات راهنما |
| POST |
/api/help/articles |
ایجاد مقاله جدید |
| GET |
/api/help/articles/{id} |
مشاهده جزئیات یک مقاله |
| PUT |
/api/help/articles/{id} |
بروزرسانی کامل یک مقاله |
| PATCH |
/api/help/articles/{id} |
بروزرسانی جزئی یک مقاله |
| DELETE |
/api/help/articles/{id} |
حذف یک مقاله |
مثال درخواست
curl -X GET "https://example.com/api/help/categories" \
-H "Authorization: Bearer {token}"
پاسخ موفق (200)
{
"records": [],
"meta": {
"total": 0,
"current_page": 1,
"per_page": 20
}
}
خطاها
| کد |
توضیح |
| 401 |
توکن معتبر نیست |
| 403 |
دسترسی غیرمجاز |
| 404 |
رکورد یافت نشد |
| 422 |
خطای اعتبارسنجی |