راهنمای API ویرایش

چابک وب‌ سرویس‌های (API) خود را در اختیار شما می‌گذارد. برای استفاده آسان و صحیح توصیه می‌کنیم این صفحه با دقت مطالعه کنید.

در استفاده از API شما نیاز به ایجاد دسترسی دارید. همینطور باید با فرم صحیح بکارگیری متدها و پارامترهایی که در اختیارتان گذاشته شده است آشنا شوید.

ایجاد دسترسی

قبل از شروع باید ابتدا (API Key (Access Token را از تنظیمات پنل بخش دسترسی‌ و توکن‌ها کپی کنید،

و آن را در بخش Authorize در بخش دمو قرار دهید.

نکته : توجه داشته باشید که بخش دمو روی محیط تستی (سندباکس) می‌باشد، بنابراین اگر اکانت عملیاتی دارید در فراخوانی آن، لینک پایه را از https://sandbox.push.adpdigital.com/api به https://{APP_ID}.push.adpdigital.com/api تبدیل کنید تا وارد محیط عملیاتی (پروداکشن) شوید. ({APP_ID} شما هم در پنل چابک قسمت تنظیمات تب دسترسی‌ها و توکن‌ها قرار گرفته است.)

فراخوانی متدها

در ادامه تمام قابلیت‌هایی که از طریق API چابک در اختیار شما قرار می‌گیرد، با دسته‌بندی آمده است. هر یک از این درخواست‌ها دو بخش parameters (داده‌هایی که شما باید به چابک بدهید) و responses (داده‌ای که چابک در پاسخ درخواست شما می‌دهد) دارند.

در هر یک از دو بخش پارامتر‌ها و پاسخ‌ها دو قسمت Example Value و Model به عنوان نمونه‌ای از داده‌های ارسالی و دریافتی با مقدار ورودی هر یک از آن‌ها قابل مشاهده است.

نکته : دقت کنید که پیش‌فرض روی قسمت Example Value است، بنابراین اگر می‌خواهید داده‌ها را با توضیح کامل مقادیر مشاهده کنید بر روی Model کلیک کنید.

نکته : توجه داشته باشید که مقادیری که در تب Model ستاره‌دارند الزامی هستند و باید مقدار‌دهی شوند در غیر این صورت چابک قادر به پاسخ درخواست شما نخواهد بود.

همینطور با کلیک بر روی Try it out می‌توانید هر یک از اعمال را به صورت آزمایشی امتحان کنید.

تفاوت صندوق پیام چابک و پوش‌نوتیفیکیشن در API

چابک برای ارسال پیام از دو مکانیزم صندوق پیام و پوش‌نوتیفیکیشن استفاده می‌کند. شما بسته به نیاز خود می‌توانید هر دو را بکار بگیرید. این مکانیزم‌ها را می‌توانید در پنل با گزینه صندوق پیام چابک کنترل کنید.

نکته: برای اطلاعات بیشتر در مورد تفاوت این دو مکانیزم این قسمت را مطالعه کنید.

در قسمت پوش (push)، چابک چهار متد را قرار داده است. دو متد اول یعنی toUsers و byQuery مخصوص صندوق پیام چابک است. یک متد دوم notifyUsers هم برای ارسال پوش‌نوتیفیکیشن می‌باشد.