مستندات وب‌سرویس‌ها وب‌سرویس Alias — شناسه مستعار و سفارشی وب‌سرویس Alias — مدیریت شناسه مستعار و سفارشی
Backend API

وب‌سرویس Alias — مدیریت شناسه مستعار و سفارشی

مرجع وب‌سرویس‌های سروری برای ثبت، حذف و دریافت شناسه مستعار (Alias) و شناسه‌های سفارشی (Custom Aliases) با کلید API.

POST
https://pushfa.com/api/webservices/alias/*
دانلود کالکشن Postman

پیش‌نیاز: احراز هویت وب‌سرویس

تمام وب‌سرویس‌های این صفحه به کلید عمومی و خصوصی سرویس نیاز دارند. این کلیدها را از پنل (سرویس‌ها ← تنظیمات و جزئیات) دریافت کنید. در صورت تنظیم allowed_ips برای سرویس، فقط درخواست‌هایی که از IPهای مجاز ارسال شوند پذیرفته می‌شوند.

وب‌سرویس: ثبت شناسه مستعار

POST
https://pushfa.com/api/webservices/alias/set

ثبت یا به‌روزرسانی Alias یک دستگاه از سمت سرور:

پارامترمقداراجباری
api_public_key کلید عمومی سرویس بله
api_private_key کلید خصوصی سرویس بله
fcm_token توکن FCM یا Subscriber ID دستگاه بله
alias شناسه مستعار جدید (مثلاً موبایل، ایمیل یا user id) بله 
curl -X POST https://pushfa.com/api/webservices/alias/set \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "USER_FCM_TOKEN",
    "alias": "09351000000"
  }'

وب‌سرویس: حذف شناسه مستعار

POST
https://pushfa.com/api/webservices/alias/delete

حذف Alias یک دستگاه از سمت سرور (مثلاً هنگام logout کاربر):

پارامترمقداراجباری
api_public_key کلید عمومی سرویس بله
api_private_key کلید خصوصی سرویس بله
fcm_token توکن FCM یا Subscriber ID دستگاه بله 
curl -X POST https://pushfa.com/api/webservices/alias/delete \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "USER_FCM_TOKEN"
  }'

وب‌سرویس: دریافت شناسه مستعار

POST
https://pushfa.com/api/webservices/alias/get

خواندن Alias فعلی یک دستگاه از سمت سرور:

پاسخ: { "alias": "09351000000" } — اگر Alias ثبت نشده باشد مقدار null برمی‌گردد.
پارامترمقداراجباری
api_public_key کلید عمومی سرویس بله
api_private_key کلید خصوصی سرویس بله
fcm_token توکن FCM یا Subscriber ID دستگاه بله 
curl -X POST https://pushfa.com/api/webservices/alias/get \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "USER_FCM_TOKEN"
  }'

وب‌سرویس: افزودن شناسه‌های سفارشی

POST
https://pushfa.com/api/webservices/aliases/add

ثبت یک یا چند Custom Alias با برچسب‌های دلخواه روی یک دستگاه. افزودن مجدد یک برچسب مقدار قبلی را جایگزین می‌کند.

پارامترمقداراجباری
api_public_key کلید عمومی سرویس بله
api_private_key کلید خصوصی سرویس بله
fcm_token توکن FCM یا Subscriber ID دستگاه بله
aliases آبجکت کلید-مقدار از برچسب و شناسه (مثل { "crm_id": "123" }) بله 
curl -X POST https://pushfa.com/api/webservices/aliases/add \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "USER_FCM_TOKEN",
    "aliases": { "crm_id": "CRM-123", "tier": "gold" }
  }'

وب‌سرویس: حذف شناسه‌های سفارشی

POST
https://pushfa.com/api/webservices/aliases/remove

حذف یک یا چند Custom Alias با ارسال لیست برچسب‌ها:

پارامترمقداراجباری
api_public_key کلید عمومی سرویس بله
api_private_key کلید خصوصی سرویس بله
fcm_token توکن FCM یا Subscriber ID دستگاه بله
labels[] آرایه نام برچسب‌هایی که باید حذف شوند بله 
curl -X POST https://pushfa.com/api/webservices/aliases/remove \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "USER_FCM_TOKEN",
    "labels": ["crm_id", "tier"]
  }'

وب‌سرویس: دریافت همه شناسه‌های سفارشی

POST
https://pushfa.com/api/webservices/aliases/get

خواندن تمام Custom Aliases ثبت‌شده روی یک دستگاه:

پاسخ: { "aliases": { "crm_id": "CRM-123", "tier": "gold" } }
پارامترمقداراجباری
api_public_key کلید عمومی سرویس بله
api_private_key کلید خصوصی سرویس بله
fcm_token توکن FCM یا Subscriber ID دستگاه بله 
curl -X POST https://pushfa.com/api/webservices/aliases/get \
  -H "Content-Type: application/json" \
  -d '{
    "api_public_key": "YOUR_PUBLIC_KEY",
    "api_private_key": "YOUR_PRIVATE_KEY",
    "fcm_token": "USER_FCM_TOKEN"
  }'