راهنمای کامل استفاده از وب سرویس پوش نوتیفیکیشن متد ارسال (Push API)
قدرت ارتباط با کاربران از طریق API
ارتباط مستمر با کاربران، کلید موفقیت هر اپلیکیشن موبایل یا وبسایت مدرن است. در مقالات قبلی درباره نحوه شروع کار با سرویسهای اطلاعرسانی صحبت کردیم. اما امروز قصد داریم به صورت تخصصی به بررسی وب سرویس پوش نوتیفیکیشن متد ارسال بپردازیم. این متد به توسعهدهندگان اجازه میدهد تا به صورت سیستمی و خودکار، پیامهای شخصیسازی شده را در لحظه مناسب به دست مخاطب برسانند. با استفاده از این API، شما کنترل کاملی بر زمان، محتوا و گروه هدف پیامهای خود خواهید داشت. 🚀
مزیتهای استفاده از وب سرویس پوش نوتیفیکیشن
استفاده از متد ارسال مستقیم از طریق API، فراتر از یک اطلاعرسانی ساده است. این ابزار به شما قدرت تحلیل و مدیریت هوشمند را میدهد. برخی از مهمترین مزایا عبارتند از:
- ✅ اتوماسیون کامل: ارسال پیامها بدون نیاز به پنل کاربری و به صورت کاملاً خودکار.
- ✅ شخصیسازی پیشرفته: امکان ارسال دادههای خاص (Custom Data) به اپلیکیشن.
- ✅ زمانبندی دقیق: تعیین بازه زمانی مشخص برای نمایش پیام به کاربر.
- ✅ گزارشگیری لحظهای: دریافت وضعیت ارسال و اطمینان از رسیدن پیام به مقصد.
- ✅ فیلترینگ هوشمند: هدفگذاری دقیق کاربران بر اساس شناسههای اختصاصی.
کاربردهای اصلی متد ارسال در وب سرویس
وب سرویس پوش نوتیفیکیشن متد ارسال در سناریوهای مختلفی به کمک کسبودارها میآید:
- 🔔 اطلاعرسانی تراکنشی: ارسال تاییدیه خرید یا تغییر وضعیت سفارش.
- 🎯 کمپینهای تبلیغاتی: معرفی تخفیفهای ویژه به گروه خاصی از مشتریان.
- 📢 اخبار فوری: انتشار سریع اخبار مهم برای کاربران اپلیکیشنهای خبری.
- 🔗 هدایت به لینک خاص: باز کردن صفحات تلگرام، وبسایت یا بخش خاصی از اپ.
مستندات فنی و نحوه پیادهسازی متد ارسال
برای استفاده از این سرویس، شما باید درخواست خود را به آدرس زیر ارسال کنید. توجه داشته باشید که این درخواست از نوع POST است و نیاز به احراز هویت از طریق API Key دارد. 🛠️
آدرس Endpoint:
POST https://api.cheshmak.me/v1/push/app/{{appId}}/send
پارامترهای بدنه درخواست (JSON)
در جداول زیر، مهمترین فیلدهایی که میتوانید در بدنه درخواست (Body) استفاده کنید، آورده شده است:
| نام پارامتر | نوع | اجباری | توضیحات |
|---|---|---|---|
afterOpenType | String | بله | عملکرد پس از باز شدن (openProgram, url, telegram) |
pushData.title | String | بله | عنوان اصلی نوتیفیکیشن (حداکثر ۱۰۰ کاراکتر) |
start | Unix Time | خیر | زمان دقیق شروع ارسال پیام |
end | Unix Time | خیر | زمان انقضای ارسال برای جلوگیری از ارسال دیرهنگام |
filter.cheshmakIds | Array | خیر | لیست شناسههای کاربری برای ارسال هدفمند |
مراحل ثبتنام و دریافت کلید دسترسی (API Key)
برای شروع کار و استفاده از این قابلیتهای فنی، ابتدا باید در پنل توسعهدهندگان عضو شوید. فرآیند ثبتنام بسیار ساده است:
- 👤 ابتدا به آدرس p.api.ir مراجعه نمایید.
- 📧 اطلاعات پایه خود را وارد کرده و حساب کاربری خود را تایید کنید.
- 📱 اپلیکیشن خود را در پنل ثبت نموده و
appIdوAPI Keyاختصاصی را دریافت کنید. - 💻 از مستندات زیر برای اتصال کدها به وب سرویس استفاده کنید.
نمونه کد پیادهسازی (PHP و CURL)
برای درک بهتر، در این بخش یک مثال عملی از پیادهسازی وب سرویس پوش نوتیفیکیشن متد ارسال با زبان PHP آورده شده است. این کد به شما نشان میدهد چگونه یک درخواست استاندارد ارسال کنید. 👨💻
<?php
$appId="YOUR_APP_ID";
$apiKey="YOUR_API_KEY";
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.cheshmak.me/v1/push/app/$appId/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
"afterOpenType" => "openProgram",
"pushData" => ["title" => "سلام! خوش آمدید"]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json",
"key: $apiKey"
],
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
تحلیل پاسخهای سرور (Status Codes)
هنگام ارسال درخواست به وب سرویس، سرور کدهای وضعیت مختلفی را بازمیگرداند که باید در برنامه خود مدیریت کنید:
- 🟢 کد ۲۰۰: عملیات با موفقیت انجام شد و
pushIdتولید شده است. - 🟠 کد ۴۰۶: اطلاعات وارد شده ناقص یا فرمت JSON اشتباه است.
- 🔴 کد ۴۰۳: کلید API یا شناسه اپلیکیشن نامعتبر است.
- ⚪ کد ۵۰۰: خطای داخلی سرور؛ در این حالت بعد از مدتی مجدد تلاش کنید.
گام بعدی
در این مقاله به بررسی دقیق وب سرویس پوش نوتیفیکیشن متد ارسال پرداختیم. آموختیم که چگونه با استفاده از ساختار JSON و متدهای استاندارد، پیامهای خود را به کاربران برسانیم. استفاده درست از این ابزار میتواند نرخ بازگشت کاربران (Retention Rate) شما را به طرز چشمگیری افزایش دهد. 📈
پیشنهاد: اگر هنوز کلید دسترسی خود را دریافت نکردهاید، همین حالا در سیستم ثبتنام کنید و اولین پوش نوتیفیکیشن تست خود را ارسال نمایید. در مقاله بعدی، نحوه دریافت گزارش دقیق از وضعیت پوشهای ارسال شده را بررسی خواهیم کرد.
آیا در پیادهسازی کدها با مشکلی روبرو شدید؟ سوالات خود را در بخش نظرات بپرسید تا متخصصان ما شما را راهنمایی کنند! 👇
