کنار دیوار
کنار دیوار بستری برای افزودن اطلاعات و خدمات به دیوار است. با ارائهٔ خدمات خود در کنار دیوار، به کاربران دیوار کمک کنید تجربهٔ خرید و فروش ساده‌تر، مطمئن‌تر و دلنشین‌تری را تجربه کنند. در کنار دیوار می‌توانید:
- به آگهی‌گذاران کمک کنید اطلاعات تکمیلی در آگهی‌های خود درج کنند.
- با همکاری آگهی‌گذاران خدمات تکمیلی مرتبط با آگهی‌ها ارائه دهید.
- با ارائهٔ خدمات در چت، تعامل کاربران را در راستای معاملهٔ سریع‌تر و مطمئن‌تر تسهیل کنید.
خدمات روی آگهی‌ها 📜
در حال حاضر خدماتی که از طریق صفحات مربوط به آگهی می‌توانید ارائه دهید، در قالب زیر است:
۱. برنامه‌های مرتبط با آگهی (از نظر دسته، شهر یا موارد دیگر) در قسمت مدیریت آگهی به کاربر پیشنهاد می‌شود.
۲. کاربر پس از انتخاب برنامه شما، به آدرس مشخص شده هدایت می‌شود و وب‌اپلیکیشن شما در اپ دیوار باز خواهد شد.
۳. در صورت نیاز می‌توانید در وب‌اپ خود اطلاعات آگهی، اطلاعات کاربر یا آگهی‌های کاربر (با کسب اجازهٔ کاربر) را از دیوار دریافت کنید.
۴. به علاوه می‌توانید از کاربر اجازهٔ درج محتوا در آگهی مورد نظر را نیز بگیرید. این محتوا از ویجت‌های دیوار مثل متن، عکس، امتیاز و ... تشکیل می‌شود.
۵. پس از پایان کار، برنامه باید کاربر را به دیوار برگرداند.
۶. پس از انتشار، کاربران آگهی‌بیننده می‌توانند با محتوای درج‌شده تعامل داشته‌باشند (برای مثال، با استفاده از دکمه‌های اضافه شده، آدرس‌های مشخص شده در برنامه شما را باز کرده و با وب‌اپلیکیشن شما تعامل کنند). دقت کنید که حتما بعد از پایان تعامل با کاربر، وی را به دیوار بازگردانید.
💡 مثال
یک سرویس پرداخت آنلاین، بعد از ثبت آگهی کالای نو، با فروشنده هماهنگ کرده، اطلاعات و مجوزهای لازم را از وی می‌گیرد، سپس با افزودن دکمهٔ پرداخت آنلاین به آگهی، به آگهی‌‌بینندگان امکان پرداخت سریع و از طریق درگاه را فراهم می‌آورد.
ارائه خدمات به بیننده آگهی
در این حالت سرویس شما به عنوان سرویس سمت بیننده آگهی ثبت می‌شود، در هنگام بازدید آگهی به کاربر معرفی خواهد شد و اگر کاربر بیننده انتخاب کند به سایت شما منتقل خواهد شد و اطلاعات مورد نیاز بیننده آگهی را در اختیار او قرار می‌دهید
برای اطلاعات دقیق تر اینجا را مطالعه کنید
💡 مثال
یک سرویس ارزیابی قیمت خودرو تحت عنوان ارزیابی قیمت در دسته‌های خودرو به بیننده های آگهی نمایش داده می‌شود، کاربر در صورت انتخاب کردن این سرویس به سایت آن ریدایرکت خواهد شد. سرویس مذکور اطلاعات آگهی را دریافت کرده و درباره مناسب بودن یا نبودن قیمت به کاربر اطلاعات می‌دهد.
📖 اطلاعات بی شتر در مورد افزونه‌های آگهی‌ها را اینجا بخوانید.
خدمات در چت 💬
ارائهٔ خدمات در چت دیوار به دو روش اصلی انجام می‌شود:
خدمات افزونه‌ای در چت
این روش برای ارائه خدمات تکمیلی در چت‌های موجود کاربران استفاده می‌شود:
۱. برنامه‌های مرتبط با آگهی و چت کاربران پیشنهاد داده می‌شود.
۲. پس از انتخاب برنامه شما توسط کاربر، درخواستی از طرف دیوار به آدرسی که از قبل توسط شما در پنل مشخص شده ارسال می‌شود و کاربر به آدرسی که در پاسخ به درخواست دیوار می‌دهید، هدایت می‌شود.
۳. در این مرحله شما می‌توانید اطلاعات آگهی یا اطلاعات کاربر را (با اجازهٔ کاربر) از دیوار بگیرید.
۴. به علاوه، در این مرحله می‌توانید با اجازهٔ کاربر، در چت پیام ارسال کنید.
۵. شما می‌توانید به پیام‌های ارسالی در چت، دکمه‌هایی برای طرفین چت ضمیمه کنید که کاربران با استفاده از آن‌ها، با برنامهٔ شما تعامل نمایند.
۶. بعد از پایان تعامل، برنامهٔ شما باید کاربر را به دیوار برگرداند.
۶. بعد از پایان تعامل، برنامه شما باید کاربر را به دیوار برگرداند.
خدمات چت‌بات
کنار دیوار امکان ایجاد چت‌بات اختصاصی برای ارائه خدمات تعاملی را فراهم کرده است. چت‌بات شما در آدرس https://divar.ir/chat/addon_{your_app_slug} در دسترس کاربران قرار می‌گیرد و دو حالت تعامل دارد:
تعامل پاسخ‌محور
در این حالت کاربر مکالمه را شروع کرده و شما پاسخ می‌دهید:
۱. کاربر پیام شروع را به چت‌بات شما ارسال می‌کند.
۲. پیام کاربر از طریق webhook به آدرس رویدادهای شما ارسال می‌شود.
۳. شما با استفاده از API های کنار دیوار، پاسخ مناسب را همراه با دکمه‌ها و اکشن‌های تعاملی ارسال می‌کنید.
۴. کاربر می‌تواند با دکمه‌ها تعامل کرده و خدمات مورد نظر را دریافت کند.
تعامل پیش‌فعال
در این حالت شما مکالمه را شروع می‌کنید:
۱. از کاربر اجازهٔ ارسال پیام مستقیم دریافت می‌کنید.
۲. با استفاده از user_id و access_token، می‌توانید پیام اول را به کاربر ارسال کنید.
۳. کاربر پاسخ داده و مکالمه ادامه می‌یابد.
۴. شما خدمات خود را از طریق پیام‌ها، دکمه‌ها و لینک‌های تعاملی ارائه می‌دهید.
💡 مثال
برنامهٔ پرداخت به کاربر خریدار پیشنهاد شده و وی برنامه را باز کرده، به آدرس ارسالی هدایت می‌شود. برنامه اطلاعات آگهی و شمارهٔ کاربر را دریافت کرده و از طریق درگاه بانکی، مبلغ را از وی دریافت می‌کند. برنامهٔ پرداخت سپس پیامی در چت ارسال می‌کند که ذیل آن دکمه‌ای برای فروشنده قرار گرفته تا از طریق آن، مبلغ را دریافت کند. فروشنده با زدن دکمه به آدرس مشخص‌شده هدایت می‌شود. در این مرحله، برنامه شماره تماس او را از دیوار دریافت کرده و پس از گرفتن اطلاعات بانکی، مبلغ را به حساب وی منتقل می‌کند.
💡 مثال
برنامهٔ تنظیم قرارداد به کاربر پیشنهاد می‌شود. وی از طریق برنامه نمونه قرارداد دلخواه را انتخاب کرده، اطلاعات مربوط به خود را وارد کرده و به شکل دیجیتال امضاء می‌کند. برنامه لینک مربوط به این قرارداد را به همراه پیامی در چت برای طرف دیگر ارسال می‌کند، کاربر دیگر با باز کردن لینک مشخص شده قرارداد را پر نموده و به صورت دیجیتال امضاء می‌کند، سپس برنامه نسخه امضاء شده را برای طرفین در چت ارسال می‌کند.
📖 اطلاعات بیشتر در مورد افزونه‌های چت را اینجا بخوانید.
شروع سریع
برای ارسال اولین درخواست به API های کنار دیوار این مراحل را بروید.
۱. در پنل کنار دیوار وارد شوید.
۲. یک برنامهٔ تستی بسازید.
۳. برای برنامه مورد نظرتان کلید API بسازید.
۴. در قسمت آگهی‌های تستی یک آگهی بسازید تا بتوانید راحت‌تر تست کنید.
۵. می‌توانید فهرست درخواست‌ها را ببینید و با استفاده از کلید API درخواست بفرستید.
ویدیوهای آموزشی
فهرست درخواست‌ها (Swagger)
ف هرست درخواست‌ها و اسکیما رکوئست و ریسپانس در این لینک موجود است.
احراز باز (OAuth2)
برخی قابلیت‌ها، مثل دریافت اطلاعات شخصی کاربران یا افزودن محتوا به آگهی، نیازمند دریافت اجازه از کاربر هستند. در کنار دیوار، این فرآیند بر مبنای استاندارد OAuth 2.0 انجام می‌شود. برای کار با این استاندارد، در زبان‌ها و فریم‌ورک‌های مختلف، ابزارهای متنوعی وجود دارند که برخی از آن‌ها را می‌توانید اینجا ببینید. برای اطلاعات بیشتر در این مورد، اینجا را بخوانید.
تعامل با سرویس‌های دیوار
برای استفاده از قابلیت‌های کنار دیوار باید درخواست‌های HTTP به آدرس مربوطه ارسال کنید. هر درخواست باید شامل یک کلید API متعلق به برنامهٔ شما باشد تا دیوار از طریق آن هویت شما را احراز کند. برای ایجاد کلید برای برنامهٔ خود به [صفحهٔ کلیدها در پنل کنار][پنل کنار » کلیدها] مراجعه کنید.
🔒 نکات امنیتی
🔑 کلید را در هدرx-api-keyقرار دهید. درخواست‌های بدون کلید رد خواهند شد.
🙈 در پنل کنار، کلید API را فقط در زمان ساخت می‌توانید ببینید. در نگهداری از آن دقت کنید.
🤹 یک اپلیکیشن می‌تواند کلیدهای مختلف با دسترسی‌های متفاوت داشته باشد.
🛂 مطمئن شوید که هر کلید کمینهٔ دسترسی‌های مورد نیاز را دارد.
🕰️ کلیدها را به شکل دوره‌ای و منظم پاک کرده و با کلیدهای جدید جایگزین کنید.
🔥 هر اپلیکیشن می‌تواند فقط یک کلید برای دریافت اجازه‌های مختلف از کاربر داشته باشد.
📖 برای اطلاعات بیشتر در مورد امنیت کلیدها اینجا را بخوانید.
پروژه‌های قدرت‌گرفته از کنار دیوار
| عنوان | لینک | زبان برنامه‌نویسی |
|---|---|---|
| مستر دیاگ | مستر دیاگ | Python |
| ریتینو | ریتینو | Python |
| مثال ساده | مثال ساده | Python |
| بازی ایکس او | بازی ایکس او | Python |
| طوطی فینگلیش | طوطی فینگلیش | PHP |
محیط تست
- برای توسعه و تست در کنار این مستندات را مطالعه کنید.
- برای اتصال یک آدرس عمومی و قابل دسترس در اینترنت به localhost خود، می‌توانید از سرویس‌هایی مثل ngrok یا Pinggy یا Loophole استفاده کنید.
کتابخانه‌های SDK (آزمایشی)
برای راحتی توسعه‌دهندگان، کتابخانه‌های SDK برای زبان‌های مختلف برنامه‌نویسی فراهم شده است. این کتابخانه‌ها در حال حاضر در مرحله آزمایشی هستند.
| زبان برنامه‌نویسی | لینک گیت‌هاب |
|---|---|
 Python | github.com/divar-ir/kenar-sdk-python |
 Go | github.com/divar-ir/kenar-sdk-go |
 JavaScript | github.com/divar-ir/kenar-sdk-javascript |
 PHP | github.com/divar-ir/kenar-sdk-php |
☎️ تماس با ما
- پاسخ سوالتان را در این مستندات پیدا نکرده‌اید؟ سوالات خود را اینجا بپرسید.
- برای افزونه‌ی خود درخواست تغییر یا انتشار دارید؟ در توسعه‌ی افزونه‌ی خود دچار مشکلی شده‌اید؟ درخواست خود را در پنل کنار دیوار ثبت کنید.
- برای طرح سایر مشکلات، موضوعات، نظرات، پیشنهادات، و ... با ما از طریق آدرس ایمیل kenar.support@divar.ir تماس بگیرید.
دسترسی سریع
