API

Giumeeh Nest یک REST API با احراز هویت توکنی (Laravel Sanctum) برای اپلیکیشن موبایل و سرویس‌های دیگر دارد.

فعال‌سازی

مسیر: تنظیمات ← تنظیمات API

API را فعال کنید. وقتی API غیرفعال باشد، مسیرهای /api/v1/* پاسخ نمی‌دهند. در همین صفحه می‌توانید یک کلید API تعریف کنید تا همهٔ درخواست‌ها هدر X-API-KEY داشته باشند.

احراز هویت

مسیر	کاربرد
POST /api/v1/register	ثبت‌نام مشتری
POST /api/v1/login	ورود و دریافت توکن (توکن فقط یک بار نمایش داده می‌شود)
POST /api/v1/password/forgot	درخواست بازیابی رمز عبور
POST /api/v1/resend-verify-account-email	ارسال دوبارهٔ ایمیل تأیید حساب
GET /api/v1/logout	خروج و باطل کردن توکن‌های کاربر

توکن را در درخواست‌های بعدی ارسال کنید:

Authorization: Bearer {token}

مسیرهای دیگر

API شامل مسیرهای پروفایل و تنظیمات کاربر، محتوای بلاگ و صفحات، و ثبت توکن دستگاه (/api/v1/device-tokens) برای اعلان‌های Push است. مستندات کامل مسیرها با دستور زیر تولید می‌شود:

php artisan cms:api:generate-docs

اعلان Push (Firebase)

1. فایل JSON حساب سرویس Firebase را در تنظیمات ← تنظیمات API بارگذاری کنید.
2. اپلیکیشن موبایل توکن دستگاه را در /api/v1/device-tokens ثبت می‌کند.
3. اعلان را از همان صفحهٔ تنظیمات یا با دستور زیر بفرستید:

php artisan cms:push-notification:send

اعلان‌های زمان‌بندی‌شده با Cron Job ارسال می‌شوند.

قالب پاسخ‌ها

پاسخ موفق شامل error: false و داده است؛ خطاها error: true و پیام خطا برمی‌گردانند. پاسخ‌های صفحه‌بندی‌شده اطلاعات صفحه و پیوندهای پیمایش دارند.

هشدارها

⚠️ کلید API و فایل حساب سرویس Firebase را در کد سمت کاربر (مثلاً اپلیکیشن منتشرشده یا جاوااسکریپت سایت) یا مخزن گیت عمومی قرار ندهید.

بازگشت

نمای کلی