راهنمای API

در این صفحه با استفاده صحیح و آسان از API چابک آشنا خواهیم شد.

قبل از شروع باید ابتدا 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 می‌توانید هر یک از اعمال را به صورت آزمایشی امتحان کنید.

عکس مربوطه