متدهای API پوش نوتیفیکیشن (بخش اول)
آیا به دنبال راهی سریع برای ارسال پیامهای لحظهای هستید؟ در این راهنما، متدهای اصلی API پوش نوتیفیکیشن را به دقت بررسی میکنیم. با استفاده از این ابزارها، تعامل با کاربران به شدت افزایش مییابد. 🚀
ورود به دنیای متدهای API پوش نوتیفیکیشن
در مقاله قبلی، با مفاهیم اولیه و مقدمات وبسرویس پوش نوتیفیکیشن آشنا شدیم. اکنون زمان آن فرا رسیده است تا وارد مباحث فنیتر شویم. در این بخش، به تشریح درگاههای “بفرست” و متدهای کلیدی برای ارسال و رهگیری پیامها میپردازیم. استفاده صحیح از متدهای API پوش نوتیفیکیشن به شما کمک میکند تا زیرساخت ارتباطی قدرتمندی بسازید. 🛠️
مزیتهای استفاده از متدهای API پوش نوتیفیکیشن
استفاده از این متدها برای کسبوکارهای آنلاین مزایای بیشماری دارد. برخی از این موارد عبارتند از:
- ⚡ ارسال آنی: پیامها بدون وقفه و در سریعترین زمان ممکن به مقصد میرسند.
- 📊 قابلیت رهگیری: میتوانید وضعیت دقیق هر پیام را به صورت لحظهای بررسی کنید.
- 🎯 هدفگیری دقیق: امکان ارسال پیام به یک کاربر خاص یا گروههای مشخص فراهم است.
- 🛡️ امنیت بالا: با استفاده از رشته Auth، امنیت درخواستهای شما تضمین میشود.
پیشنیازها و نکات حیاتی درگاههای “بفرست”
قبل از شروع کار با درگاهها، رعایت نکات زیر الزامی است. این موارد تضمینکننده عملکرد صحیح کدهای شما هستند:
- 💡 نوع درخواست: به Request Method (مانند POST یا GET) قبل از هر آدرس دقت کنید.
- 🆔 جایگذاری شناسهها: مقادیر AID و CHID باید با کدهای معتبر پروژه شما جایگزین شوند.
- ⚠️ مدیریت خطا: مقدار
errorCodeصفر یعنی همه چیز عالی است؛ در غیر این صورت، پیام خطا را بررسی کنید.
آموزش ساخت رشته Auth برای امنیت API
رشته auth ابزاری برای احراز هویت شماست. این توکن از ترکیب آدرس درگاه و API Key اختصاصی شما ساخته میشود. برای تولید آن، مراحل زیر را دنبال کنید:
- ابتدا آدرس درگاه را به دو بخش تقسیم کنید. برای مثال در آدرس
https://gw.bef.rest/xapi/2/publish/AID/CHIDبخش دوم یعنیxapi/2/publish/AID/CHID/مد نظر ماست. - بخش دوم را به API Key خود بچسبانید (بدون هیچ فاصله یا کاراکتر اضافی).
- رشته نهایی را با الگوریتم MD5 هش کنید. اکنون توکن شما آماده استفاده در هدر
X-BF-AUTHاست. 🔐
متد ارسال پیام به کانال انفرادی
این متد برای ارسال پیام به یک کاربر خاص (از طریق CHID) استفاده میشود. این روش یکی از پرکاربردترین متدهای API پوش نوتیفیکیشن است.
- آدرس درگاه:
POST: https://api.bef.rest/xapi/2/publish/AID/CHID - هدر X-BF-TTL: مدت زمان ماندگاری پیام در صف (حداکثر ۱۴ روز) را مشخص میکند.
- بدنه درخواست: پیام خود را به صورت raw در بدنه قرار دهید.
در پاسخ، شما یک messageId دریافت میکنید که برای پیگیریهای بعدی بسیار مهم است. 📥
بررسی وضعیت پیامهای ارسال شده
پس از ارسال، احتمالاً میخواهید بدانید پیام به دست کاربر رسیده است یا خیر. بنابراین، از این متد استفاده کنید:
- آدرس:
GET: https://api.bef.rest/xapi/2/message-status/AID/MESSAGE-ID
وضعیتهای خروجی شامل موارد زیر است:
- ✅ D (Delivered): پیام با موفقیت دریافت شده است.
- ⏳ Q (Queued): پیام در صف است و به محض آنلاین شدن کاربر ارسال میشود.
- ❌ E (Expired): زمان منقضی شده و کاربر پیام را دریافت نکرده است.
ارسال پیام گروهی (Multi-Publish)
اگر قصد دارید یک پیام واحد را برای چندین کاربر ارسال کنید، این متد بهترین گزینه است. با این کار در زمان و منابع صرفهجویی میکنید. 📢
- هدر X-BF-CH: شناسههای کانال را با کاما (,) از هم جدا کنید (حداکثر ۶ کیلوبایت).
- کاربردها: اطلاعرسانی تخفیفهای همگانی، اخبار مهم یا بروزرسانیهای سیستمی.
کاربردهای اصلی متدهای وبسرویس
- 📱 اپلیکیشنهای موبایل: اطلاعرسانی تراکنشهای بانکی یا پیامهای چت.
- 🌐 پنلهای کاربری: ارسال کد تایید یا هشدارهای امنیتی ورود.
- 🛒 فروشگاههای آنلاین: یادآوری سبد خرید رها شده به مشتریان.
راهنمای ثبتنام در سامانه
برای شروع استفاده از این خدمات و دریافت API Key، مراحل زیر را طی کنید:
- به وبسایت اصلی مراجعه نمایید.
- روی دکمه ثبتنام کلیک کنید.
- اطلاعات درخواستی را به دقت وارد نمایید.
- از طریق لینک p.api.ir وارد پنل کاربری خود شوید و اولین پروژه را بسازید. 💎
در این مقاله، بخش اول متدهای API پوش نوتیفیکیشن شامل نحوه احراز هویت، ارسال انفرادی، پیگیری وضعیت و ارسال گروهی را آموختیم. پیادهسازی درست این متدها، سرعت و دقت ارتباطات شما را تضمین میکند. در مقاله بعدی، به سراغ متدهای پیشرفتهتر خواهیم رفت.
آیا در پیادهسازی متد Auth با مشکلی روبرو شدید؟ سوالات خود را در بخش نظرات بپرسید تا کارشناسان ما شما را راهنمایی کنند! 👇