Web API
وبسرویسهای براکت
مرجع وبسرویسهای سروری برای ثبت، حذف و دریافت مقادیر براکت یک پروفایل مشترک.
POST
https://pushfa.com/api/webservices/brackets/*
پیش از استفاده
این صفحه فقط مرجع وبسرویسهای مدیریت براکت است. برای آشنایی با مفهوم براکت، قالبهای قابل استفاده، مقدار پیشفرض و فعالسازی شخصیسازی در ارسال گروهی، راهنمای کاربر را مطالعه کنید.
احراز هویت و شناسایی مشترک
تمام درخواستها به کلید عمومی و خصوصی سرویس نیاز دارند. فیلد fcm_token هم توکن FCM و هم Subscriber ID پایدار را میپذیرد؛ استفاده از 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"
}'