مستندات پوشفا
SDK v2

SDK v2 — نصب و پیکربندی

راهنمای کامل نصب Pushfa SDK v2، تنظیم autoPrompt، نصب سرویس‌ورکر و مقایسه سرویس عادی با پوش پایدار.

نصب SDK

کد زیر را در <head> یا انتهای <body> سایت قرار دهید. مقدار YOUR_PUBLIC_KEY کلید عمومی سرویس در پنل است.

در حالت پیش‌فرض، تنظیمات زمان، اسکرول و تعداد بازدید ذخیره‌شده در پنل برای نمایش خودکار درخواست عضویت استفاده می‌شود.
<script
  src="https://pushfa.com/notification-v2.js?api_public_key=YOUR_PUBLIC_KEY"
  type="module">
</script>

نصب سرویس‌ورکر

فایل سرویس‌ورکر را از پنل (روبروی سرویس، دریافت کانفیگ) دانلود و با نام pushfa-messaging-sw.js در ریشه سایت آپلود کنید.

اگر فایل سرویس‌ورکر در زیرپوشه قرار بگیرد، پوش نوتیفیکیشن در پس‌زمینه کار نخواهد کرد.
# فایل باید در این آدرس در دسترس باشد:
https://yourdomain.com/pushfa-messaging-sw.js

غیرفعال کردن نمایش خودکار (Auto Prompt)

اگر می‌خواهید کنترل بیشتری بر زمان نمایش درخواست داشته باشید—مثلاً فقط در صفحات خاص یا پس از انجام اقدامات خاص—Auto Prompt را غیرفعال کنید. قبل از لود SDK این تنظیم را اضافه کنید:

اگر می‌خواهید کنترل بیشتری بر زمان نمایش درخواست عضویت داشته باشید—مثلاً فقط در صفحات خاص یا پس از اقدامات مشخص کاربر—Auto Prompt را غیرفعال کنید و درخواست را دستی نمایش دهید.
<script>
  window.PushfaConfig = { autoPrompt: false };
</script>
<script
  src="https://pushfa.com/notification-v2.js?api_public_key=YOUR_PUBLIC_KEY"
  type="module">
</script>

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

SDK v2 پوشفا روی مرورگرهای مدرن دسکتاپ و اندروید کار می‌کند.

مرورگر وضعیت نکته
Chrome ≥ 50 ✅ پشتیبانی کامل دسکتاپ و اندروید
Firefox ≥ 44 ✅ پشتیبانی کامل دسکتاپ
Edge (Chromium) ✅ پشتیبانی کامل دسکتاپ و اندروید
Samsung Internet ✅ پشتیبانی کامل اندروید
Safari ≥ 16 (macOS) ⚠️ محدود نیاز به تأیید کاربر در تنظیمات سافاری
iOS Safari ≥ 16.4 ⚠️ محدود فقط PWA یا افزودن به صفحه اصلی

پشتیبانی iOS از وب‌پوش

اپل از نسخه iOS 16.4+ پشتیبانی از وب‌پوش را برای آیفون و آیپد آغاز کرده است. برخلاف اندروید که وب‌پوش به‌محض بازدید در مرورگر پشتیبانی‌شده کار می‌کند، اپل چند شرط اضافه دارد: وجود فایل manifest.json و اضافه کردن سایت به صفحه اصلی توسط کاربر. اگر سایت شما PWA است، نیازی به این اقدام نیست.

راه‌اندازی وب‌پوش در iOS: فایل manifest.json موردنیاز را اضافه کنید و کاربران را راهنمایی کنید که سایت را به صفحه اصلی (Home Screen) اضافه کنند.
از حالت ناشناس (Incognito) یا مرور خصوصی استفاده نکنید—کاربران در این حالت نمی‌توانند عضو پوش شوند. همچنین تصویر در نوتیفیکیشن فقط در Chrome پشتیبانی می‌شود؛ در حالت جمع‌شده کوچک نمایش داده می‌شود و برای مشاهده کامل باید نوتیفیکیشن را باز کنید.

سرویس عادی در مقابل پوش پایدار

در پنل سرویس نوع سرویس را انتخاب کنید. سرویس عادی از Firebase Cloud Messaging (FCM) و Service Worker استفاده می‌کند. پوش پایدار (SosNet) برای محیط‌هایی که دسترسی به سرورهای Google ندارند طراحی شده و بدون لود Firebase SDK توکن را از زیرساخت پوشفا دریافت می‌کند.