Web + Android API
وبسرویسهای ارسال مشترک Web Push و Android
endpointهای ارسال پوشفا برای Web/PWA و Android یکسان هستند؛ سرویس و مخاطب مقصد تعیین میکنند پیام به کدام پلتفرم تحویل شود.
اصل مشترک
برای ارسال از Backend، تفاوتی در endpointهای اصلی Web و Android وجود ندارد. همان api_public_key و api_private_key سرویس، همان عنوان و متن و همان روشهای هدفگیری استفاده میشوند. یک token یا Subscriber ID به پروفایل سرویس تعلق دارد و Pushfa آن را از طریق FCM به مقصد مناسب تحویل میدهد.
ثبت دستگاه Android با SDK انجام میشود، اما ارسال پیام از Backend از همین وبسرویسهای مشترک استفاده میکند.
انتخاب endpoint
| نیاز | Endpoint | پلتفرم |
|---|---|---|
| یک token یا Subscriber ID | send-single-message | Web و Android |
| ارسال تکی سبک | send-single-lite-message | Web و Android |
| همه، Topic یا لیست بدون گزارش | send-group-message-without-report | Web و Android |
| ارسال گروهی سبک | send-group-lite-message | Web و Android |
| ارسال گروهی با گزارش | send-group-message | Web و Android |
| همه دستگاههای یک External ID | send-via-user-alias-id | Web و Android |
| یک یا چند Subscriber ID | send-via-subscriber-id | Web و Android |
| Custom Alias برچسبدار | send-via-alias | Web و Android |
| استعلام نتیجه | check-notification-status | Web و Android |
فیلدهای مشترک پیام
| فیلد | کاربرد |
|---|---|
| title / body | عنوان و متن اصلی |
| link_url | URL وب یا Deep Link/مسیر قابلفهم برای اپ |
| image_url | تصویر اعلان در صورت پشتیبانی مقصد |
| btn_left / btn_right | حداکثر دو Action Button |
| ttl | مدت اعتبار پیام |
| collapse_idCollapse IDPro | ادغام پیام منتظر و جایگزینی اعلان فعال همموضوع |
| silentپوش بیصدا | درخواست اعلان بدون صدا و لرزش |
| additional_dataAdditional DataPro | داده JSON سفارشی برای Service Worker یا Android SDK |
| get_delivery_status / get_click_status | فعالکردن گزارش تحویل و کلیک |
| sendTime / time | ارسال فوری یا زمانبندیشده |
تفاوت فقط در مصرف سمت مقصد است
| موضوع | Web/PWA | Android |
|---|---|---|
| دریافت | Service Worker پوشفا | Pushfa Android SDK |
| link_url | URL مرورگر | URL، App Link، Custom Scheme یا مسیر داخلی |
| additional_dataAdditional DataPro | event یا payload وب | PushfaMessage.additionalData |
| collapse_idCollapse IDPro | WebPush Topic و tag اعلان | FCM collapse_key و notification tag/id |
| محدودیت پلتفرم | platform=desktop/ios در ارسال گروهی | platform=android |