Skip to content

divar-ir/kenar-sdk-python

BranchesTags

Repository files navigation

kenar-api-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 0.1.0
  • Generator version: 7.13.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/divar-ir/kenar-sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/divar-ir/kenar-sdk-python.git)

Then import the package:

import kenar_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import kenar_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import kenar_api_client
from kenar_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://open-api.divar.ir
# See configuration.py for a list of all supported configuration parameters.
configuration = kenar_api_client.Configuration(
    host = "https://open-api.divar.ir"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'


# Enter a context with an instance of the API client
with kenar_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kenar_api_client.AddonsApi(api_client)
    business_token = 'business_token_example' # str | 
    addons_create_business_addon_body = kenar_api_client.AddonsCreateBusinessAddonBody() # AddonsCreateBusinessAddonBody | 

    try:
        # افزودن افزونه جدید به آگهی‌های کسب‌و‌کار
        api_response = api_instance.addons_create_business_addon(business_token, addons_create_business_addon_body)
        print("The response of AddonsApi->addons_create_business_addon:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AddonsApi->addons_create_business_addon: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://open-api.divar.ir

Class Method HTTP request Description
AddonsApi addons_create_business_addon POST /v1/open-platform/addons/business/{business_token} افزودن افزونه جدید به آگهی‌های کسب‌و‌کار
AddonsApi addons_create_post_addon_v2 POST /v2/open-platform/addons/post/{token} افزودن افزونه جدید به آگهی
AddonsApi addons_create_user_addon_v2 POST /v2/open-platform/addons/user/{phone} افزودن افزونه جدید به کاربر
AddonsApi addons_create_user_addon_v22 POST /v2/open-platform/addons/users/{divar_user_id} افزودن افزونه جدید به کاربر
AddonsApi addons_delete_post_addon DELETE /v1/open-platform/add-ons/post/{token} حذف افزونه از آگهی
AddonsApi addons_delete_post_addon2 DELETE /v1/open-platform/addons/post/{token} حذف افزونه از آگهی
AddonsApi addons_delete_user_addon DELETE /v1/open-platform/addons/user/{id} حذف افزونه کاربر
AssetsApi assets_get_body_statuses GET /v1/open-platform/assets/body-status دریافت گزینه‌های وضعیت بدنه موجود در دسته‌بندی‌های خودرو دیوار
AssetsApi assets_get_brand_models GET /v1/open-platform/assets/brand-model/{category} دریافت مدل‌های برند در دسته‌بندی دیوار
AssetsApi assets_get_categories GET /v1/open-platform/assets/category دریافت دسته‌بندی‌های دیوار
AssetsApi assets_get_cities GET /v1/open-platform/assets/city دریافت شهرهای دیوار
AssetsApi assets_get_colors GET /v1/open-platform/assets/color/{category} دریافت رنگ‌ها در دسته‌بندی دیوار
AssetsApi assets_get_districts GET /v1/open-platform/assets/district دریافت مناطق دیوار
AssetsApi assets_get_districts2 GET /v1/open-platform/assets/district/{city_slug} دریافت مناطق دیوار
AssetsApi assets_get_internal_storages GET /v1/open-platform/assets/internal-storage دریافت گزینه‌های حافظه داخلی موجود در دسته‌بندی‌های موبایل/تبلت/لپ‌تاپ دیوار
AssetsApi assets_get_o_auth_scopes GET /v1/open-platform/assets/oauth-scope دریافت دامنه‌های OAuth کنار دیوار
AssetsApi assets_get_permissions GET /v1/open-platform/assets/permission دریافت مجوزهای کنار دیوار
AssetsApi assets_get_ram_memories GET /v1/open-platform/assets/ram-memory دریافت گزینه‌های حافظه رم موجود در دسته‌بندی‌های موبایل/تبلت/لپ‌تاپ دیوار
AssetsApi assets_get_service_types GET /v1/open-platform/assets/service-type دریافت انواع سرویس موجود در کنار دیوار
AssetsApi assets_get_submit_schema GET /v1/open-platform/assets/submit-schema/{category_slug} دریافت قالب ثبت
ChatAPIApi chat_api_chat_bot_send_message POST /v1/open-platform/chat/bot/conversations/{conversation_id}/messages ارسال پیام به مکالمه ChatBot
ChatAPIApi chat_api_chat_bot_send_message2 POST /v1/open-platform/chat/bot/users/{user_id}/messages ارسال پیام به مکالمه ChatBot
ChatAPIApi chat_api_chat_bot_send_message3 POST /experimental/open-platform/chatbot-conversations/{conversation_id}/messages ارسال پیام به مکالمه ChatBot
ChatAPIApi chat_api_chat_bot_send_message4 POST /experimental/open-platform/chat/bot/users/{user_id}/messages ارسال پیام به مکالمه ChatBot
ChatAPIApi chat_api_chat_bot_send_message5 POST /experimental/open-platform/chat/bot/conversations/{conversation_id}/messages ارسال پیام به مکالمه ChatBot
ChatAPIApi chat_api_conversation_send_message POST /v2/open-platform/conversations/{conversation_id}/messages ارسال پیام به مکالمه
ChatAPIApi chat_api_generate_upload_token POST /experimental/open-platform/chat/upload تولید توکن آپلود
ChatAPIApi chat_api_get_conversation GET /v1/open-platform/chat/conversations/{conversation_id} دریافت مکالمه با شناسه آن
EventsApi events_register_event_subscription POST /v1/open-platform/events/subscriptions اشتراک در رویداد
EventsApi events_send_event POST /experimental/open-platform/events/send ارسال رویداد به کاربر با استفاده از API
FinderApi finder_get_post GET /v1/open-platform/finder/post/{token} دریافت آگهی دیوار
FinderApi finder_get_user POST /v1/open-platform/users دریافت اطلاعات کاربر
FinderApi finder_get_user2 GET /v1/open-platform/users دریافت اطلاعات کاربر
FinderApi finder_get_user_idby_phone POST /v1/open-platform/get-user-id-by-phone دریافت شناسه دیوار کاربر با شماره تلفن
FinderApi finder_get_user_posts GET /v1/open-platform/finder/user-posts دریافت آگهی‌های کاربر
FinderApi finder_search_post_v2 POST /v2/open-platform/finder/post جستجو آگهی‌های دیوار با فیلترهایی
PaymentApi payment_commit_wallet_transaction POST /experimental/open-platform/wallet/payments/commit تایید تراکنش کیف پول
PaymentApi payment_create_wallet_payment POST /experimental/open-platform/wallet/payments/create ایجاد پرداخت کیف پول
PaymentApi payment_get_balance GET /experimental/open-platform/balance دریافت موجودی اپلیکیشن
PaymentApi payment_get_post_pricing GET /v1/open-platform/post/{post_token}/pricing دریافت هزینه سرویس
PaymentApi payment_get_transaction GET /experimental/open-platform/transactions/{id} دریافت جزئیات تراکنش
PaymentApi payment_list_transactions GET /experimental/open-platform/transactions لیست تراکنش‌ها
PaymentApi payment_publish_user_post POST /experimental/open-platform/post/{post_token}/publish پرداخت هزینه ثبت آگهی کاربر از طرف ارائه‌دهنده
PaymentApi payment_renew_post POST /experimental/open-platform/post/{post_token}/renew تمدید آگهی
PaymentApi payment_reorder_post POST /experimental/open-platform/post/{post_token}/reorder نردبان آگهی
PaymentApi payment_retrieve_wallet_transaction GET /experimental/open-platform/wallet/payments/{token} بازیابی تراکنش کیف پول
PaymentApi payment_submit_user_payment POST /v1/open-platform/user-payments ثبت پرداخت کاربر
PaymentTicketApi payment_ticket_validate POST /v1/open-platform/payment-ticket/validate اعتبارسنجی بلیط پرداخت
PostApi post_can_user_submit_post GET /experimental/open-platform/user-posts/can-submit بررسی اینکه آیا کاربر می‌تواند آگهی ارسال کند
PostApi post_create_business_customized_button POST /experimental/open-platform/business/{business_token}/customized-button ایجاد دکمه اختصاصی برای آگهی‌های کسب‌و‌کار
PostApi post_delete_business_customized_button DELETE /experimental/open-platform/business/{business_token}/customized-button حذف دکمه اختصاصی از آگهی‌های کسب‌و‌کار
PostApi post_delete_post_customized_button DELETE /experimental/open-platform/posts/{post_token}/customized-button حذف دکمه اختصاصی از آگهی
PostApi post_delete_user_post DELETE /v1/open-platform/post/{post_token} حذف آگهی
PostApi post_edit_post PUT /v1/open-platform/post/{post_token} ویرایش آگهی
PostApi post_edit_post_v2 PUT /v2/open-platform/post/{post_token} ویرایش آگهی با پشتیبانی از فیلد ماسک
PostApi post_get_image_upload_url GET /v1/open-platform/post/image-upload-url دریافت آدرس اپلود تصاویر آگهی (منسوخ شده)
PostApi post_get_post_stats GET /experimental/open-platform/posts/{post_token}/stats دریافت آمارهای آگهی
PostApi post_get_upload_urls_v2 GET /v2/open-platform/post/upload-urls دریافت آدرس آپلود برای تصاویر و ویدیو‌ی آگهی‌ها
PostApi post_get_user_post GET /v1/open-platform/user-post/{token} دریافت آگهی با توکن
PostApi post_set_post_customized_button POST /experimental/open-platform/posts/{post_token}/customized-button تنظیم دکمه اختصاصی بر روی آگهی ثبت شده
PostApi post_submit_post POST /experimental/open-platform/posts/new ثبت آگهی
PostApi post_submit_post_v2 POST /experimental/open-platform/posts/new-v2 ثبت آگهی با استفاده از اعتبارسنجی قالب JSON
PostApi post_submit_user_post POST /experimental/open-platform/user-posts/new ثبت آگهی به عنوان کاربر
SemanticApi semantic_create_post_semantic POST /experimental/open-platform/semantic/post/{token} ایجاد اطلاعات معنایی آگهی
SemanticApi semantic_create_user_semantic POST /v1/open-platform/semantic/user/{phone} ایجاد اطلاعات معنایی کاربر
SemanticApi semantic_create_user_semantic2 POST /v1/open-platform/semantic/users/{divar_user_id} ایجاد اطلاعات معنایی کاربر
SemanticApi semantic_delete_user_semantic DELETE /v1/open-platform/semantic/user/{phone} حذف اطلاعات معنایی کاربر
SemanticApi semantic_delete_user_semantic2 DELETE /v1/open-platform/semantic/users/{divar_user_id} حذف اطلاعات معنایی کاربر

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

APIKey

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

OAuth

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: oauth.divar.ir/oauth2/auth
  • Scopes:
  • BUSINESS_ADDON_CREATE.resource_id: BUSINESS_ADDON_CREATE.resource_id
  • BUSINESS_CREATE_CUSTOMIZED_BUTTON.resource_id: BUSINESS_CREATE_CUSTOMIZED_BUTTON.resource_id
  • CHAT_BOT_USER_MESSAGE_SEND: CHAT_BOT_USER_MESSAGE_SEND
  • CHAT_CONVERSATION_READ.resource_id: CHAT_CONVERSATION_READ.resource_id
  • CHAT_MESSAGE_SEND.resource_id: CHAT_MESSAGE_SEND.resource_id
  • CHAT_POST_CONVERSATIONS_MESSAGE_SEND.resource_id: CHAT_POST_CONVERSATIONS_MESSAGE_SEND.resource_id
  • CHAT_POST_CONVERSATIONS_READ.resource_id: CHAT_POST_CONVERSATIONS_READ.resource_id
  • CHAT_SUPPLIER_ALL_CONVERSATIONS_MESSAGE_SEND: CHAT_SUPPLIER_ALL_CONVERSATIONS_MESSAGE_SEND
  • CHAT_SUPPLIER_ALL_CONVERSATIONS_READ: CHAT_SUPPLIER_ALL_CONVERSATIONS_READ
  • CONVERSATION_SEND_MESSAGE.resource_id: CONVERSATION_SEND_MESSAGE.resource_id
  • CREATE_WALLET_PAYMENT: CREATE_WALLET_PAYMENT
  • DELETE_USER_POST: DELETE_USER_POST
  • EDIT_USER_POST: EDIT_USER_POST
  • MANAGEMENT_APPS_READ.resource_id: MANAGEMENT_APPS_READ.resource_id
  • MANAGEMENT_APPS_WRITE.resource_id: MANAGEMENT_APPS_WRITE.resource_id
  • NOTIFICATION_ACCESS_REVOCATION: NOTIFICATION_ACCESS_REVOCATION
  • PAYMENT_ALL_POSTS_PRICING_READ: PAYMENT_ALL_POSTS_PRICING_READ
  • PAYMENT_ALL_POSTS_RENEW: PAYMENT_ALL_POSTS_RENEW
  • PAYMENT_ALL_POSTS_REORDER: PAYMENT_ALL_POSTS_REORDER
  • POST_ADDON_CREATE.resource_id: POST_ADDON_CREATE.resource_id
  • POST_EDIT.resource_id: POST_EDIT.resource_id
  • POST_ONGOING_IMAGES_GET.resource_id: POST_ONGOING_IMAGES_GET.resource_id
  • POST_SEMANTIC_CREATE.resource_id: POST_SEMANTIC_CREATE.resource_id
  • SEND_EVENT: SEND_EVENT
  • SUBMIT_USER_PAYMENT: SUBMIT_USER_PAYMENT
  • SUBMIT_USER_POST: SUBMIT_USER_POST
  • USER_ADDON_CREATE: USER_ADDON_CREATE
  • USER_ID: USER_ID
  • USER_PHONE: USER_PHONE
  • USER_POSTS_ADDON_CREATE: USER_POSTS_ADDON_CREATE
  • USER_POSTS_GET: USER_POSTS_GET
  • USER_POSTS_STATS_READ: USER_POSTS_STATS_READ
  • USER_SET_CUSTOMIZED_BUTTON: USER_SET_CUSTOMIZED_BUTTON
  • USER_VERIFICATION_CREATE: USER_VERIFICATION_CREATE
  • offline_access: offline_access
  • openid: openid

Author

About

Kenar Python SDK

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

3 watching

Forks

0 forks
Report repository

Releases

81 tags

Packages

No packages published

Languages