/kenar-docs

راهنمای برنامه‌نویسانهٔ استفاده از کنارِ دیوار

Primary LanguageSCSS




کنار دیوار بستریست برای افزودن اطلاعات و خدمات به دیوار. با ارائه‌ی خدمات خود در کنار دیوار، به کاربران دیوار کمک کنید تجربه‌ی خرید و فروش ساده‌تر، مطمئن‌تر و دلنشین‌تری را تجربه کنند. در کنار دیوار می‌توانید:

  • به آگهی‌گذاران کمک کنید اطلاعات تکمیلی بر آگهی‌های خود اضافه کنند،
  • با همکاری آگهی‌گذاران خدمات تکمیلی روی آگهی‌ها ارائه دهید،
  • با ارائه‌ی خدمات در چت، تعامل کاربرها را در راستای معامله‌ی سریع‌تر و مطمئن‌تر تسهیل کنید.

🚀 برای شروع کار در کنار دیوار، در لیست انتظار ثبت‌نام کنید تا دسترسی شما به پنل کنار دیوار را فراهم کنیم.



🚧 در دست احداث 🚧

کنار دیوار‌ در حال حاضر در مرحله‌ی آزمایشی است و امکان ثبت‌نام عمومی در آن وجود ندارد. برای ثبت‌نام و فعالیت در این بستر، در لیست انتظار ثبت‌نام کنید. در این مرحله ممکن است قواعد، سیاست‌ها و ابزارهای کنار دیوار دچار تغییرات ناگهانی شوند. به دلیل سرعت تغییرات، ممکن است در بازه‌های زمانی خاصی اطلاعات ارائه شده در این مخزن نیز ناقص یا نیازمند بروزرسانی باشند.


نمای کلی

خدمات مختلف در کنار دیوار در قالب «برنامه‌ها» یا «اپلیکیشن» (Application) ها به کاربرهای دیوار می‌شوند. در مرحله‌ی آزمایشی، برای تعریف اپلیکیشن‌های جدید با ما تماس بگیرید. جزییات اپلیکیشن‌های خود را در صفحه‌ی اپ‌ها در پنل کنار دیوار مشاهده نمایید. اطلاعات بیشتر در مورد مدیریت اپلیکیشن‌ها را اینجا بخوانید.


خدمات روی آگهی‌ها 📜

ارائه‌ی خدمات روی آگهی‌های دیوار به طور کلی در قالب زیر انجام می‌شود:

۱. در انتهای ثبت آگهی‌های مرتبط، اپلیکیشن شما به کاربرها معرفی می‌شود.
۲. اگر کاربر اپلیکیشن را باز کند، به آدرس مشخص شده در اپلیکیشن هدایت شده و رابط‌کاربری وب‌بیس برنامه را می‌بیند.
۳. در این مرحله شما می‌توانید اطلاعات آگهی یا اطلاعات کاربر را (با اجازه‌ی کاربر) از دیوار بگیرید.
۴. به علاوه، در این مرحله می‌توانید با اجازه‌ی کاربر، به آگهی مربوطه محتوا اضافه کنید. این محتوا متشکل از ویجت‌هایی شامل متن، امتیاز، عکس، و ... است
۵. پس از پایان کار، برنامه می‌بایست کاربر را به دیوار برگرداند.
۶. پس از انتشار آگهی، کاربران آگهی‌بیننده می‌توانند با محتوای اضافه شده تعامل داشته باشند (برای مثال، با استفاده از دکمه‌های اضافه شده، آدرس‌های مشخص شده در برنامه‌ی شما را باز کرده و با رابط‌کاربری وب‌بیس شما تعامل کنند). دقت کنید که حتما بعد از پایان تعامل با کاربر، وی را به دیوار بازگردانید.


💡 مثال
یک سرویس کارشناسی خودرو بعد از ثبت یک آگهی خودرو سواری به کاربر معرفی می‌شود، کاربر به آدرس مشخص شده توسط برنامه هدایت می‌شود، برنامه شماره‌ی تماس کاربر و اطلاعات آگهی را دریافت کرده و با هماهنگی کاربر خودرو را کارشناسی می‌کند. سپس خلاصه‌ای از گزارش کارشناسی را به آگهی اضافه کرده و دکمه‌ای نیز برای مشاهده‌ی گزارش تفصیلی به انتهای خلاصه می‌افزاید.


💡 مثال
یک سرویس پرداخت آنلاین، بعد از ثبت آگهی کالای نو، با فروشنده هماهنگ کرده، اطلاعات و مجوزهای لازم را از وی می‌گیرد، سپس با افزودن دکمه‌ی پرداخت آنلاین به آگهی، به آگهی‌‌بینندگان امکان پرداخت سریع و از طریق درگاه را فراهم می‌آورد.



📖 اطلاعات بیشتر در مورد افزونه‌های آگهی‌ها را اینجا بخوانید.



خدمات در چت 💬

ارائه‌ی خدمات در چت دیوار به طور کلی در قالب زیر انجام می‌شود:

۱. برنامه‌ی شما در مکالمات مرتبط به کاربرها معرفی می‌شود.
۲. کاربر برنامه‌ را باز می‌کند. دیوار درخواستی به آدرس مشخص شده ارسال کرده و کاربر را به آدرسی که در پاسخ آمده هدایت می‌کند. کاربر رابط‌کاربری وب‌بیس برنامه را می‌بیند.
۳. در این مرحله شما می‌توانید اطلاعات آگهی یا اطلاعات کاربر را (با اجازه‌ی کاربر) از دیوار بگیرید.
۴. به علاوه، در این مرحله می‌توانید با اجازه‌ی کاربر، در مکالمه‌ پیام ارسال کنید.
۵. بعد از پایان تعامل، اپلیکیشن باید کاربر را به دیوار برگرداند.
۶. شما می‌توانید به پیام‌های ارسالی در مکالمه، دکمه‌هایی برای طرفین مکالمه ضمیمه کنید که کاربرها با استفاده از آن‌ها، با برنامه‌ی شما تعامل نمایند. دقت کنید که حتما بعد از پایان تعامل با کاربر، وی را به دیوار بازگردانید.


💡 مثال
برنامه‌ی پرداخت به کاربر خریدار پیشنهاد شده و وی برنامه را باز کرده، به آدرس ارسالی هدایت می‌شود. برنامه اطلاعات آگهی و شماره‌ی کاربر را دریافت کرده و از طریق درگاه بانکی، مبلغ را از وی دریافت می‌کند. برنامه‌ی پرداخت سپس پیامی در مکالمه ارسال می‌نماید که ذیل آن دکمه‌ای برای فروشنده قرار گرفته تا از طریق آن، مبلغ را دریافت نماید. فروشنده با کلیک بر روی این دکمه به آدرس مشخص شده هدایت می‌شود، برنامه شماره‌ی تماس وی را از دیوار دریافت کرده و سپس با دریافت اطلاعات بانکی، مبلغ را به فروشنده منتقل می‌نماید.


💡 مثال
برنامه‌ی تنظیم قرارداد به کاربر پیشنهاد می‌شود. وی از طریق برنامه نمونه‌ی قرارداد دلخواه را انتخاب کرده، اطلاعات مربوط به خویش را وارد کرده و به شکل دیجیتال امضاء می‌نماید. برنامه لینک مربوط به این قرارداد را به همراه پیامی در مکالمه برای طرف دیگر ارسال می‌کند، کاربر دیگر با باز کردن لینک مشخص شده قرارداد را پر نموده و به صورت دیجیتال امضاء می‌نماید، سپس برنامه نسخه‌ی امضاء شده را برای طرفین در مکالمه ارسال می‌کند.



📖 اطلاعات بیشتر در مورد افزونه‌های چت را اینجا بخوانید.



تعامل با سرویس‌های دیوار

برای استفاده از قابلیت‌های کنار دیوار باید درخواست‌های HTTP به آدرس مربوطه ارسال کنید. هر درخواست باید شامل یک کلید API متعلق به برنامه‌ی شما باشد تا دیوار از طریق آن هویت شما را احراز نماید. برای ایجاد کلید برای برنامه‌ی خود به صفحه‌ی کلیدها در پنل کنار مراجعه کنید.


🔒 نکات امنیتی

🔑 کلید را در هدر x-api-key قرار دهید. درخواست‌های بدون کلید رد خواهند شد.
🙈 در پنل کنار، کلید API را فقط در زمان ساخت می‌توانید ببینید. در نگهداری از آن دقت کنید.
🤹 یک اپلیکیشن می‌تواند کلیدهای مختلف با دسترسی‌های متفاوت داشته باشد.
🛂 مطمئن شوید که هر کلید کمینه‌ی دسترسی‌های مورد نیاز را دارد.
🕰️ کلیدها را به شکل دوره‌ای و منظم پاک کرده و با کلید‌های جدید جایگزین کنید.
🔥 هر اپلیکیشن می‌تواند فقط یک کلید برای دریافت اجازه‌های مختلف از کاربر داشته باشد.



📖 برای اطلاعات بیشتر در مورد امنیت کلیدها اینجا را بخوانید. برای اطلاعات بیشتر در مورد کلیدهای API اینجا را بخوانید.



برخی قابلیت‌ها، مثل دریافت اطلاعات شخصی کاربرها یا افزودن محتوا به آگهی، نیازمند دریافت اجازه از کاربر هستند. در کنار دیوار، این فرآیند بر مبنای استاندارد OAuth 2.0 انجام می‌شود. برای کار با این استاندارد، در زبان‌ها و فریم‌ورک‌های مختلف، ابزارهای متنوعی وجود دارند که برخی از آن‌ها را می‌توانید اینجا ببینید. برای اطلاعات بیشتر در این مورد، اینجا را بخوانید.


محیط تست


دسترسی سریع