Kenar 0.6.0

facilitate using kenar divar APIs

kenar-api

درباره

این کتابخانه برای استفاده ی راحت‌تر و سریع‌تر از سرویس های کنار دیوار توسعه داده شده است.

توجه: برای استفاده از این کتابخانه باید نیازمند نسخه ی پایتون بالاتر از 3.10 هستید.

ویژگی های اصلی

• تولید آدرس ریدایرکت به احراز باز برای دریافت دسترسی ها از کاربر
• امکان ارسال پیام در چت دیوار و ثبت درخواست برای مطلع شدن از پیام های چت دیوار روی یک آگهی
• امکان درج/حذف/دریافت افزونه در آگهی های دیوار
• امکان درج/حذف/دریافت افزونه روی دسته ای از آگهی های یک کاربر (بر اساس دسته بندی آگهی)

نحوه ی نصب

برای این منظور میتوانید از پکیج منیجر pip استفاده کنید

pip install Kenar

راهنمای استفاده

پس از ساخت برنامه در پنل کنار و گرفتن کلید API و کلید محرمانه OAuth مربوط به آن ، با قرار دادن این فیلد ها در environment variable های پروژه ی خود ، میتوانید از این SDK استفاده کنید.

• نمونه ساخت اپ
• نمونه ساخت ریدایرکت احراز باز و گرفتن اکسس توکن احراز
• نمونه ساخت افزونه آگهی و کاربر
• نمونه سرچ آگهی با فیلتر، دریافت اطلاعات یک آگهی، آگهی های کاربر و اطلاعات شماره تلفن کاربر
• نمونه ارسال پیام در چت و اجازه دریافت پیام ها روی یک آگهی

به عنوان نمونه ، برای ساخت کلاینت کنار، نیاز است متغیر های محیطی KENAR_APP_SLUG (با مقدار برابر با شناسه یکتای برنامه) و KENAR_API_KEY(برابر با کلید محرمانه دریافت شده برای برنامه) ، KENAR_OAUTH_SECRET (برابر با کلید محرمانه ی OAuth) و KENAR_OAUTH_REDIRECT_URL (برابر با لینک بازگشت احراز باز) ست شوند و از طریق نمونه کد زیر کلاینت ساخته شود.

import os
from kenar import ClientConfig, Client

client_conf = ClientConfig(
    app_slug=os.environ.get("KENAR_APP_SLUG"),
    api_key=os.environ.get("KENAR_API_KEY"),
    oauth_secret=os.environ.get("KENAR_OAUTH_SECRET"),
    oauth_redirect_url=os.environ.get("KENAR_OAUTH_REDIRECT_URL"),
)

kenar_client = Client(client_conf)

پس از ساخت کلاینت میتوان از تمام سرویس های نام برده ، با فراخوانی property مربوطه ، استفاده کرد. به عنوان مثال برای آپلود عکس میتوان از کد زیر بهره گرفت:

rsp = kenar_client.addon.upload_image("PATH_TO_FILE")

پیشنهادات برای بهبود

پذیرای هر گونه پیشنهادات شما برای بهتر کردن این کتاب‌خانه هستیم. در قسمت issues پروژه میتوانید مسائل خود را با ما مطرح کنید.

ادرس پنل توسعه دهندگان

کنار دیوار

مستندات کنار دیوار

در صورتی که از زبان پایتون برای توسعه ی برنامه خود استفاده نمیکنید ، میتوانید با بهره گیری از مستندات کنار دیوار مستقیما اندپوینت های سرویس را فراخوانی کند.