وب‌سرویس‌های براکت

با این وب‌سرویس‌ها می‌توانید مقدارهای شخصی‌سازی پیام را برای هر مخاطب ذخیره کنید، بخوانید یا حذف کنید. درخواست‌ها باید از سرور شما ارسال شوند.

POST

https://pushfa.com/api/webservices/brackets/*

دانلود کالکشن Postman

پیش از استفاده

این صفحه فقط مرجع وب‌سرویس‌های مدیریت براکت است. برای آشنایی با مفهوم براکت، قالب‌های قابل استفاده، مقدار پیش‌فرض و فعال‌سازی شخصی‌سازی در ارسال گروهی، راهنمای کاربر را مطالعه کنید.

مشاهده راهنمای براکت‌ها

احراز هویت و شناسایی مشترک

تمام درخواست‌ها به کلید عمومی و خصوصی سرویس نیاز دارند. فیلد fcm_token هم توکن FCM و هم شناسه ثابت مخاطب (Subscriber ID) را می‌پذیرد؛ استفاده از شناسه ثابت مخاطب توصیه می‌شود چون با چرخش توکن تغییر نمی‌کند.

پارامتر	مقدار	اجباری
api_public_key	کلید عمومی سرویس پوشفا	بله
api_private_key	کلید خصوصی سرویس پوشفا	بله
fcm_token	توکن FCM یا شناسه ثابت مخاطب (Subscriber ID) پروفایل	بله

ثبت یا به‌روزرسانی براکت‌ها

POST

https://pushfa.com/api/webservices/brackets/add

یک یا چند key-value را روی پروفایل ذخیره می‌کند. اگر کلیدی از قبل وجود داشته باشد، مقدار آن به‌روزرسانی می‌شود.

پارامتر	مقدار	اجباری
api_public_key	کلید عمومی سرویس پوشفا	بله
api_private_key	کلید خصوصی سرویس پوشفا	بله
fcm_token	توکن FCM یا شناسه ثابت مخاطب (Subscriber ID) پروفایل	بله
brackets	آبجکت کلید-مقدار براکت‌ها؛ حداکثر ۵۰ مقدار در هر درخواست	بله

curl -X POST https://pushfa.com/api/webservices/brackets/add \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "SUBSCRIBER_ID_OR_FCM_TOKEN",
    "brackets": {
      "name": "سارا",
      "product_name": "کفش ورزشی",
      "new_price": "1290000"
    }
  }'

حذف براکت‌ها

POST

https://pushfa.com/api/webservices/brackets/remove

کلیدهای مشخص‌شده را از پروفایل مشترک حذف می‌کند.

پارامتر	مقدار	اجباری
api_public_key	کلید عمومی سرویس پوشفا	بله
api_private_key	کلید خصوصی سرویس پوشفا	بله
fcm_token	توکن FCM یا شناسه ثابت مخاطب (Subscriber ID) پروفایل	بله
keys	آرایه نام کلیدهایی که باید حذف شوند	بله

curl -X POST https://pushfa.com/api/webservices/brackets/remove \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "SUBSCRIBER_ID_OR_FCM_TOKEN",
    "keys": ["product_name", "new_price"]
  }'

دریافت همه براکت‌ها

POST

https://pushfa.com/api/webservices/brackets/get

تمام مقادیر براکت ذخیره‌شده روی پروفایل را به‌صورت یک آبجکت key-value برمی‌گرداند.

در پاسخ موفق، subscriber_id و آبجکت brackets شامل کلیدها و مقادیر فعلی پروفایل برگردانده می‌شوند.

پارامتر	مقدار	اجباری
api_public_key	کلید عمومی سرویس پوشفا	بله
api_private_key	کلید خصوصی سرویس پوشفا	بله
fcm_token	توکن FCM یا شناسه ثابت مخاطب (Subscriber ID) پروفایل	بله

curl -X POST https://pushfa.com/api/webservices/brackets/get \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "SUBSCRIBER_ID_OR_FCM_TOKEN"
  }'