Skip to content

PostApi.md

Latest commit

 

History

History
1404 lines (932 loc) · 48.3 KB

PostApi.md

File metadata and controls

1404 lines (932 loc) · 48.3 KB

kenar_api_client.PostApi

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

Method HTTP request Description
post_can_user_submit_post GET /experimental/open-platform/user-posts/can-submit بررسی اینکه آیا کاربر می‌تواند آگهی ارسال کند
post_create_business_customized_button POST /experimental/open-platform/business/{business_token}/customized-button ایجاد دکمه اختصاصی برای آگهی‌های کسب‌وکار
post_delete_business_customized_button DELETE /experimental/open-platform/business/{business_token}/customized-button حذف دکمه اختصاصی از آگهی‌های کسب‌و‌کار
post_delete_post_customized_button DELETE /experimental/open-platform/posts/{post_token}/customized-button حذف دکمه اختصاصی از آگهی
post_delete_user_post DELETE /v1/open-platform/post/{post_token} حذف آگهی
post_edit_post PUT /v1/open-platform/post/{post_token} ویرایش آگهی
post_edit_post_v2 PUT /v2/open-platform/post/{post_token} ویرایش آگهی (پیشرفته)
post_get_image_upload_url GET /v1/open-platform/post/image-upload-url دریافت آدرس اپلود تصاویر آگهی (منسوخ شده)
post_get_post_stats GET /experimental/open-platform/posts/{post_token}/stats دریافت آمارهای آگهی
post_get_upload_urls_v2 GET /v2/open-platform/post/upload-urls دریافت آدرس آپلود تصاویر و ویدیو
post_get_user_post GET /v1/open-platform/user-post/{token} دریافت آگهی با توکن
post_set_post_customized_button POST /experimental/open-platform/posts/{post_token}/customized-button تنظیم دکمه اختصاصی روی آگهی
post_submit_post POST /experimental/open-platform/posts/new ثبت آگهی (منسوخ شده)
post_submit_post_v2 POST /experimental/open-platform/posts/new-v2 ثبت آگهی
post_submit_user_post POST /experimental/open-platform/user-posts/new ثبت آگهی به عنوان کاربر

post_can_user_submit_post

PostCanUserSubmitPostResponse post_can_user_submit_post()

بررسی اینکه آیا کاربر می‌تواند آگهی ارسال کند

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

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • CAN_USER_SUBMIT_POST
OAuth اسکوپ موردنیاز:
  • SUBMIT_USER_POST

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_can_user_submit_post_response import PostCanUserSubmitPostResponse
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)

    try:
        # بررسی اینکه آیا کاربر می‌تواند آگهی ارسال کند
        api_response = api_instance.post_can_user_submit_post()
        print("The response of PostApi->post_can_user_submit_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_can_user_submit_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PostCanUserSubmitPostResponse

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_create_business_customized_button

object post_create_business_customized_button(business_token, post_create_business_customized_button_body)

ایجاد دکمه اختصاصی برای آگهی‌های کسب‌وکار

این API تنظیمات دکمه اختصاصی را برای تمام آگهی‌های کسب‌وکار ایجاد می‌کند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • BUSINESS_CUSTOMIZED_BUTTON_CREATE
OAuth اسکوپ موردنیاز:
  • BUSINESS_CREATE_CUSTOMIZED_BUTTON.business_token

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_create_business_customized_button_body import PostCreateBusinessCustomizedButtonBody
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    business_token = 'business_token_example' # str | 
    post_create_business_customized_button_body = kenar_api_client.PostCreateBusinessCustomizedButtonBody() # PostCreateBusinessCustomizedButtonBody | 

    try:
        # ایجاد دکمه اختصاصی برای آگهی‌های کسب‌وکار
        api_response = api_instance.post_create_business_customized_button(business_token, post_create_business_customized_button_body)
        print("The response of PostApi->post_create_business_customized_button:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_create_business_customized_button: %s\n" % e)

Parameters

Name Type Description Notes
business_token str
post_create_business_customized_button_body PostCreateBusinessCustomizedButtonBody

Return type

object

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_delete_business_customized_button

object post_delete_business_customized_button(business_token)

حذف دکمه اختصاصی از آگهی‌های کسب‌و‌کار

این API تنظیمات دکمه اختصاصی را از تمام آگهی‌های کسب‌وکار حذف می‌کند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • BUSINESS_CUSTOMIZED_BUTTON_CREATE

Example

  • Api Key Authentication (APIKey):
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.PostApi(api_client)
    business_token = 'business_token_example' # str | 

    try:
        # حذف دکمه اختصاصی از آگهی‌های کسب‌و‌کار
        api_response = api_instance.post_delete_business_customized_button(business_token)
        print("The response of PostApi->post_delete_business_customized_button:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_delete_business_customized_button: %s\n" % e)

Parameters

Name Type Description Notes
business_token str

Return type

object

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_delete_post_customized_button

object post_delete_post_customized_button(post_token)

حذف دکمه اختصاصی از آگهی

این API تنظیمات دکمه اختصاصی را از یک آگهی حذف می‌کند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • SET_CUSTOMIZED_BUTTON
OAuth اسکوپ موردنیاز:
  • USER_SET_CUSTOMIZED_BUTTON

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    post_token = 'post_token_example' # str | 

    try:
        # حذف دکمه اختصاصی از آگهی
        api_response = api_instance.post_delete_post_customized_button(post_token)
        print("The response of PostApi->post_delete_post_customized_button:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_delete_post_customized_button: %s\n" % e)

Parameters

Name Type Description Notes
post_token str

Return type

object

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_delete_user_post

object post_delete_user_post(post_token)

حذف آگهی

این API امکان حذف آگهی را فراهم می‌کند. فقط آگهی‌های متعلق به کاربر احراز هویت شده قابل حذف هستند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • DELETE_USER_POST
OAuth اسکوپ موردنیاز:
  • DELETE_USER_POST

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    post_token = 'post_token_example' # str | توکن آگهی برای حذف

    try:
        # حذف آگهی
        api_response = api_instance.post_delete_user_post(post_token)
        print("The response of PostApi->post_delete_user_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_delete_user_post: %s\n" % e)

Parameters

Name Type Description Notes
post_token str توکن آگهی برای حذف

Return type

object

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_edit_post

object post_edit_post(post_token, post_edit_post_body)

ویرایش آگهی

این API امکان ویرایش آگهی را فراهم می‌کند. می‌توانید عنوان، توضیحات و تصاویر آگهی را به‌روزرسانی کنید.

نکات مهم:

  • عنوان باید بین 3 تا 50 کاراکتر باشد
  • آگهی نباید منقضی شده باشد

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • EDIT_POST
OAuth اسکوپ موردنیاز:
  • POST_EDIT.post_token

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_edit_post_body import PostEditPostBody
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    post_token = 'post_token_example' # str | 
    post_edit_post_body = kenar_api_client.PostEditPostBody() # PostEditPostBody | 

    try:
        # ویرایش آگهی
        api_response = api_instance.post_edit_post(post_token, post_edit_post_body)
        print("The response of PostApi->post_edit_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_edit_post: %s\n" % e)

Parameters

Name Type Description Notes
post_token str
post_edit_post_body PostEditPostBody

Return type

object

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_edit_post_v2

object post_edit_post_v2(post_token, post_edit_post_v2_body)

ویرایش آگهی (پیشرفته)

این API امکان ویرایش آگهی با پشتیبانی از field mask را فراهم می‌کند. می‌توانید عنوان، توضیحات، تصاویر، موقعیت، فیلدهای ویژه دسته‌بندی و سایر ویژگی‌ها را به‌روزرسانی کنید.

نکات مهم:

  • فیلدهای ویژه دسته‌بندی باید از قالب پیروی کنند
  • از update_mask برای مشخص کردن فیلدهای مورد به‌روزرسانی استفاده کنید
  • هنگام استفاده از اسکوپ EDIT_USER_POST، آگهی باید متعلق به کاربر احراز هویت شده باشد
  • آگهی نباید منقضی شده باشد

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • EDIT_POST
OAuth اسکوپ موردنیاز:
  • EDIT_USER_POST یا POST_EDIT.post_token

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_edit_post_v2_body import PostEditPostV2Body
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    post_token = 'post_token_example' # str | توکن آگهی
    post_edit_post_v2_body = kenar_api_client.PostEditPostV2Body() # PostEditPostV2Body | 

    try:
        # ویرایش آگهی (پیشرفته)
        api_response = api_instance.post_edit_post_v2(post_token, post_edit_post_v2_body)
        print("The response of PostApi->post_edit_post_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_edit_post_v2: %s\n" % e)

Parameters

Name Type Description Notes
post_token str توکن آگهی
post_edit_post_v2_body PostEditPostV2Body

Return type

object

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_get_image_upload_url

PostGetImageUploadURLResponse post_get_image_upload_url()

دریافت آدرس اپلود تصاویر آگهی (منسوخ شده)

این API آدرس آپلود برای بارگذاری تصاویر آگهی را برمی‌گرداند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • UPLOAD_POST_IMAGE

Example

  • Api Key Authentication (APIKey):
import kenar_api_client
from kenar_api_client.models.post_get_image_upload_url_response import PostGetImageUploadURLResponse
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.PostApi(api_client)

    try:
        # دریافت آدرس اپلود تصاویر آگهی (منسوخ شده)
        api_response = api_instance.post_get_image_upload_url()
        print("The response of PostApi->post_get_image_upload_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_get_image_upload_url: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PostGetImageUploadURLResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_get_post_stats

PostGetPostStatsResponse post_get_post_stats(post_token)

دریافت آمارهای آگهی

این API امکان دریافت آمار یک آگهی شامل بازدیدها، نمایش‌ها و چت‌ها را فراهم می‌کند. آمار روزانه برای 7 روز اخیر و تعداد کل برمی‌گردد.

نکات مهم:

  • فقط آمار آگهی‌های متعلق به کاربر احراز هویت شده برگردانده می‌شود

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • POST_STATS_RETRIEVE
OAuth اسکوپ موردنیاز:
  • USER_POSTS_STATS_READ

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_get_post_stats_response import PostGetPostStatsResponse
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    post_token = 'post_token_example' # str | توکن آگهی

    try:
        # دریافت آمارهای آگهی
        api_response = api_instance.post_get_post_stats(post_token)
        print("The response of PostApi->post_get_post_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_get_post_stats: %s\n" % e)

Parameters

Name Type Description Notes
post_token str توکن آگهی

Return type

PostGetPostStatsResponse

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_get_upload_urls_v2

PostGetUploadURLsV2Response post_get_upload_urls_v2()

دریافت آدرس آپلود تصاویر و ویدیو

این API امکان دریافت آدرس‌های آپلود برای بارگذاری تصاویر و ویدیوهای آگهی را فراهم می‌کند. می‌توانید تصاویر/ویدیوها را با درخواست POST یا PUT با کدگذاری باینری به آدرس برگشتی آپلود کنید.

نکات مهم:

  • آدرس برگشتی برای آپلود نیاز به api-key شما دارد

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • UPLOAD_POST_IMAGE

Example

  • Api Key Authentication (APIKey):
import kenar_api_client
from kenar_api_client.models.post_get_upload_urls_v2_response import PostGetUploadURLsV2Response
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.PostApi(api_client)

    try:
        # دریافت آدرس آپلود تصاویر و ویدیو
        api_response = api_instance.post_get_upload_urls_v2()
        print("The response of PostApi->post_get_upload_urls_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_get_upload_urls_v2: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

PostGetUploadURLsV2Response

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_get_user_post

PostGetUserPostResponse post_get_user_post(token)

دریافت آگهی با توکن

این API امکان دریافت اطلاعات دقیق یک آگهی شامل داده‌های عمومی، داده‌های دسته‌بندی، داده‌های کسب‌وکار، وضعیت و دلیل رد را فراهم می‌کند. فقط آگهی‌های متعلق به کاربر احراز هویت شده قابل دریافت هستند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • GET_USER_POST
OAuth اسکوپ موردنیاز:
  • USER_POSTS_GET

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_get_user_post_response import PostGetUserPostResponse
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    token = 'token_example' # str | 

    try:
        # دریافت آگهی با توکن
        api_response = api_instance.post_get_user_post(token)
        print("The response of PostApi->post_get_user_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_get_user_post: %s\n" % e)

Parameters

Name Type Description Notes
token str

Return type

PostGetUserPostResponse

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_set_post_customized_button

object post_set_post_customized_button(post_token, post_set_post_customized_button_body)

تنظیم دکمه اختصاصی روی آگهی

این API تنظیمات دکمه اختصاصی را برای یک آگهی تعیین می‌کند. اگر دکمه وجود نداشته باشد، ایجاد می‌شود. اگر از قبل وجود داشته باشد، داده‌های آن به‌روزرسانی می‌شوند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • SET_CUSTOMIZED_BUTTON
OAuth اسکوپ موردنیاز:
  • USER_SET_CUSTOMIZED_BUTTON

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_set_post_customized_button_body import PostSetPostCustomizedButtonBody
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    post_token = 'post_token_example' # str | 
    post_set_post_customized_button_body = kenar_api_client.PostSetPostCustomizedButtonBody() # PostSetPostCustomizedButtonBody | 

    try:
        # تنظیم دکمه اختصاصی روی آگهی
        api_response = api_instance.post_set_post_customized_button(post_token, post_set_post_customized_button_body)
        print("The response of PostApi->post_set_post_customized_button:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_set_post_customized_button: %s\n" % e)

Parameters

Name Type Description Notes
post_token str
post_set_post_customized_button_body PostSetPostCustomizedButtonBody

Return type

object

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_submit_post

PostSubmitPostResponse post_submit_post(post_submit_post_request)

ثبت آگهی (منسوخ شده)

این API امکان ثبت آگهی با فیلدهای پایه برای دسته‌بندی‌های خاص را فراهم می‌کند.

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • SUBMIT_POST

Example

  • Api Key Authentication (APIKey):
import kenar_api_client
from kenar_api_client.models.post_submit_post_request import PostSubmitPostRequest
from kenar_api_client.models.post_submit_post_response import PostSubmitPostResponse
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.PostApi(api_client)
    post_submit_post_request = kenar_api_client.PostSubmitPostRequest() # PostSubmitPostRequest | 

    try:
        # ثبت آگهی (منسوخ شده)
        api_response = api_instance.post_submit_post(post_submit_post_request)
        print("The response of PostApi->post_submit_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_submit_post: %s\n" % e)

Parameters

Name Type Description Notes
post_submit_post_request PostSubmitPostRequest

Return type

PostSubmitPostResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_submit_post_v2

PostSubmitPostResponse post_submit_post_v2(post_submit_post_v2_request)

ثبت آگهی

این API امکان ثبت آگهی با استفاده از اعتبارسنجی JSON schema را فراهم می‌کند. داده‌های آگهی در برابر قالب دسته‌بندی مشخص شده اعتبارسنجی می‌شوند.

نکات مهم:

  • فیلدهای ویژه دسته‌بندی باید از قالب پیروی کنند
  • تمام فیلدهای اجباری ذکر شده در قالب باید ارسال شوند، در غیر این صورت ثبت ناموفق خواهد بود
  • این برای ثبت در سطح اپلیکیشن است (آگهی‌های ارائه‌دهنده)

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • SUBMIT_POST

Example

  • Api Key Authentication (APIKey):
import kenar_api_client
from kenar_api_client.models.post_submit_post_response import PostSubmitPostResponse
from kenar_api_client.models.post_submit_post_v2_request import PostSubmitPostV2Request
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.PostApi(api_client)
    post_submit_post_v2_request = kenar_api_client.PostSubmitPostV2Request() # PostSubmitPostV2Request | 

    try:
        # ثبت آگهی
        api_response = api_instance.post_submit_post_v2(post_submit_post_v2_request)
        print("The response of PostApi->post_submit_post_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_submit_post_v2: %s\n" % e)

Parameters

Name Type Description Notes
post_submit_post_v2_request PostSubmitPostV2Request

Return type

PostSubmitPostResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_submit_user_post

PostSubmitPostResponse post_submit_user_post(post_submit_user_post_request)

ثبت آگهی به عنوان کاربر

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

نکات مهم:

  • فیلدهای ویژه دسته‌بندی باید از قالب پیروی کنند
  • تمام فیلدهای اجباری ذکر شده در قالب باید ارسال شوند، در غیر این صورت ثبت ناموفق خواهد بود

دسترسی‌ها:

مجوزهای API Key مورد نیاز:
  • SUBMIT_USER_POST
OAuth اسکوپ موردنیاز:
  • SUBMIT_USER_POST

Example

  • Api Key Authentication (APIKey):
  • OAuth Authentication (OAuth):
import kenar_api_client
from kenar_api_client.models.post_submit_post_response import PostSubmitPostResponse
from kenar_api_client.models.post_submit_user_post_request import PostSubmitUserPostRequest
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'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.PostApi(api_client)
    post_submit_user_post_request = kenar_api_client.PostSubmitUserPostRequest() # PostSubmitUserPostRequest | 

    try:
        # ثبت آگهی به عنوان کاربر
        api_response = api_instance.post_submit_user_post(post_submit_user_post_request)
        print("The response of PostApi->post_submit_user_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PostApi->post_submit_user_post: %s\n" % e)

Parameters

Name Type Description Notes
post_submit_user_post_request PostSubmitUserPostRequest

Return type

PostSubmitPostResponse

Authorization

APIKey, OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 پاسخ موفقیت‌آمیز. -
0 پاسخ خطای غیرمنتظره. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]