All URIs are relative to https://open-api.divar.ir
| Method | HTTP request | Description |
|---|---|---|
| postCanUserSubmitPost | GET /experimental/open-platform/user-posts/can-submit | بررسی اینکه آیا کاربر میتواند آگهی ارسال کند |
| postCreateBusinessCustomizedButton | POST /experimental/open-platform/business/{business_token}/customized-button | ایجاد دکمه اختصاصی برای آگهیهای کسبوکار |
| postDeleteBusinessCustomizedButton | DELETE /experimental/open-platform/business/{business_token}/customized-button | حذف دکمه اختصاصی از آگهیهای کسبوکار |
| postDeletePostCustomizedButton | DELETE /experimental/open-platform/posts/{post_token}/customized-button | حذف دکمه اختصاصی از آگهی |
| postDeleteUserPost | DELETE /v1/open-platform/post/{post_token} | حذف آگهی |
| postEditPost | PUT /v1/open-platform/post/{post_token} | ویرایش آگهی |
| postEditPostV2 | PUT /v2/open-platform/post/{post_token} | ویرایش آگهی (پیشرفته) |
| postGetImageUploadURL | GET /v1/open-platform/post/image-upload-url | دریافت آدرس اپلود تصاویر آگهی (منسوخ شده) |
| postGetPostStats | GET /experimental/open-platform/posts/{post_token}/stats | دریافت آمارهای آگهی |
| postGetUploadURLsV2 | GET /v2/open-platform/post/upload-urls | دریافت آدرس آپلود تصاویر و ویدیو |
| postGetUserPost | GET /v1/open-platform/user-post/{token} | دریافت آگهی با توکن |
| postSetPostCustomizedButton | POST /experimental/open-platform/posts/{post_token}/customized-button | تنظیم دکمه اختصاصی روی آگهی |
| postSubmitPostV2 | POST /experimental/open-platform/posts/new-v2 | ثبت آگهی |
| postSubmitUserPost | POST /experimental/open-platform/user-posts/new | ثبت آگهی به عنوان کاربر |
PostCanUserSubmitPostResponse postCanUserSubmitPost()
بررسی اینکه آیا کاربر میتواند آگهی ارسال کند
این API بررسی میکند که آیا کاربر واجد شرایط ثبت آگهی است. تایید میکند که کاربر در لیست سیاه نیست، متخلف نیست و احراز هویت شده است. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `CAN_USER_SUBMIT_POST` ##### OAuth اسکوپ موردنیاز: - `SUBMIT_USER_POST`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
apiInstance.postCanUserSubmitPost().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
Object postCreateBusinessCustomizedButton(businessToken, postCreateBusinessCustomizedButtonBody)
ایجاد دکمه اختصاصی برای آگهیهای کسبوکار
این API تنظیمات دکمه اختصاصی را برای تمام آگهیهای کسبوکار ایجاد میکند. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `BUSINESS_CUSTOMIZED_BUTTON_CREATE` ##### OAuth اسکوپ موردنیاز: - `BUSINESS_CREATE_CUSTOMIZED_BUTTON.business_token`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let businessToken = "businessToken_example"; // String |
let postCreateBusinessCustomizedButtonBody = new KenarApiClient.PostCreateBusinessCustomizedButtonBody(); // PostCreateBusinessCustomizedButtonBody |
apiInstance.postCreateBusinessCustomizedButton(businessToken, postCreateBusinessCustomizedButtonBody).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| businessToken | String | ||
| postCreateBusinessCustomizedButtonBody | PostCreateBusinessCustomizedButtonBody |
Object
- Content-Type: application/json
- Accept: application/json
Object postDeleteBusinessCustomizedButton(businessToken)
حذف دکمه اختصاصی از آگهیهای کسبوکار
این API تنظیمات دکمه اختصاصی را از تمام آگهیهای کسبوکار حذف میکند. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `BUSINESS_CUSTOMIZED_BUTTON_CREATE`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
let apiInstance = new KenarApiClient.PostApi();
let businessToken = "businessToken_example"; // String |
apiInstance.postDeleteBusinessCustomizedButton(businessToken).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| businessToken | String |
Object
- Content-Type: Not defined
- Accept: application/json
Object postDeletePostCustomizedButton(postToken)
حذف دکمه اختصاصی از آگهی
این API تنظیمات دکمه اختصاصی را از یک آگهی حذف میکند. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `SET_CUSTOMIZED_BUTTON` ##### OAuth اسکوپ موردنیاز: - `USER_SET_CUSTOMIZED_BUTTON`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let postToken = "postToken_example"; // String |
apiInstance.postDeletePostCustomizedButton(postToken).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postToken | String |
Object
- Content-Type: Not defined
- Accept: application/json
Object postDeleteUserPost(postToken)
حذف آگهی
این API امکان حذف آگهی را فراهم میکند. فقط آگهیهای متعلق به کاربر احراز هویت شده قابل حذف هستند. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `DELETE_USER_POST` ##### OAuth اسکوپ موردنیاز: - `DELETE_USER_POST`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let postToken = "postToken_example"; // String | توکن آگهی برای حذف
apiInstance.postDeleteUserPost(postToken).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postToken | String | توکن آگهی برای حذف |
Object
- Content-Type: Not defined
- Accept: application/json
Object postEditPost(postToken, postEditPostBody)
ویرایش آگهی
این API امکان ویرایش آگهی را فراهم میکند. میتوانید عنوان، توضیحات و تصاویر آگهی را بهروزرسانی کنید. نکات مهم: - عنوان باید بین 3 تا 50 کاراکتر باشد - آگهی نباید منقضی شده باشد #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `EDIT_POST` ##### OAuth اسکوپ موردنیاز: - `POST_EDIT.post_token`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let postToken = "postToken_example"; // String |
let postEditPostBody = new KenarApiClient.PostEditPostBody(); // PostEditPostBody |
apiInstance.postEditPost(postToken, postEditPostBody).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postToken | String | ||
| postEditPostBody | PostEditPostBody |
Object
- Content-Type: application/json
- Accept: application/json
Object postEditPostV2(postToken, postEditPostV2Body)
ویرایش آگهی (پیشرفته)
این API امکان ویرایش آگهی با پشتیبانی از field mask را فراهم میکند. میتوانید عنوان، توضیحات، تصاویر، موقعیت، فیلدهای ویژه دستهبندی و سایر ویژگیها را بهروزرسانی کنید. نکات مهم: - فیلدهای ویژه دستهبندی باید از قالب پیروی کنند - از `update_mask` برای مشخص کردن فیلدهای مورد بهروزرسانی استفاده کنید - هنگام استفاده از اسکوپ `EDIT_USER_POST`، آگهی باید متعلق به کاربر احراز هویت شده باشد - آگهی نباید منقضی شده باشد #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `EDIT_POST` ##### OAuth اسکوپ موردنیاز: - `EDIT_USER_POST` یا `POST_EDIT.post_token`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let postToken = "postToken_example"; // String | توکن آگهی
let postEditPostV2Body = new KenarApiClient.PostEditPostV2Body(); // PostEditPostV2Body |
apiInstance.postEditPostV2(postToken, postEditPostV2Body).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postToken | String | توکن آگهی | |
| postEditPostV2Body | PostEditPostV2Body |
Object
- Content-Type: application/json
- Accept: application/json
PostGetImageUploadURLResponse postGetImageUploadURL()
دریافت آدرس اپلود تصاویر آگهی (منسوخ شده)
این API آدرس آپلود برای بارگذاری تصاویر آگهی را برمیگرداند. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `UPLOAD_POST_IMAGE`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
let apiInstance = new KenarApiClient.PostApi();
apiInstance.postGetImageUploadURL().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
PostGetPostStatsResponse postGetPostStats(postToken)
دریافت آمارهای آگهی
این API امکان دریافت آمار یک آگهی شامل بازدیدها، نمایشها و چتها را فراهم میکند. آمار روزانه برای 7 روز اخیر و تعداد کل برمیگردد. نکات مهم: - فقط آمار آگهیهای متعلق به کاربر احراز هویت شده برگردانده میشود #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `POST_STATS_RETRIEVE` ##### OAuth اسکوپ موردنیاز: - `USER_POSTS_STATS_READ`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let postToken = "postToken_example"; // String | توکن آگهی
apiInstance.postGetPostStats(postToken).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postToken | String | توکن آگهی |
- Content-Type: Not defined
- Accept: application/json
PostGetUploadURLsV2Response postGetUploadURLsV2()
دریافت آدرس آپلود تصاویر و ویدیو
این API امکان دریافت آدرسهای آپلود برای بارگذاری تصاویر و ویدیوهای آگهی را فراهم میکند. میتوانید تصاویر/ویدیوها را با درخواست POST یا PUT با کدگذاری باینری به آدرس برگشتی آپلود کنید. نکات مهم: - آدرس برگشتی برای آپلود نیاز به api-key شما دارد #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `UPLOAD_POST_IMAGE`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
let apiInstance = new KenarApiClient.PostApi();
apiInstance.postGetUploadURLsV2().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
PostGetUserPostResponse postGetUserPost(token)
دریافت آگهی با توکن
این API امکان دریافت اطلاعات دقیق یک آگهی شامل دادههای عمومی، دادههای دستهبندی، دادههای کسبوکار، وضعیت و دلیل رد را فراهم میکند. فقط آگهیهای متعلق به کاربر احراز هویت شده قابل دریافت هستند. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `GET_USER_POST` ##### OAuth اسکوپ موردنیاز: - `USER_POSTS_GET`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let token = "token_example"; // String |
apiInstance.postGetUserPost(token).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| token | String |
- Content-Type: Not defined
- Accept: application/json
Object postSetPostCustomizedButton(postToken, postSetPostCustomizedButtonBody)
تنظیم دکمه اختصاصی روی آگهی
این API تنظیمات دکمه اختصاصی را برای یک آگهی تعیین میکند. اگر دکمه وجود نداشته باشد، ایجاد میشود. اگر از قبل وجود داشته باشد، دادههای آن بهروزرسانی میشوند. #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `SET_CUSTOMIZED_BUTTON` ##### OAuth اسکوپ موردنیاز: - `USER_SET_CUSTOMIZED_BUTTON`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let postToken = "postToken_example"; // String |
let postSetPostCustomizedButtonBody = new KenarApiClient.PostSetPostCustomizedButtonBody(); // PostSetPostCustomizedButtonBody |
apiInstance.postSetPostCustomizedButton(postToken, postSetPostCustomizedButtonBody).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postToken | String | ||
| postSetPostCustomizedButtonBody | PostSetPostCustomizedButtonBody |
Object
- Content-Type: application/json
- Accept: application/json
PostSubmitPostResponse postSubmitPostV2(postSubmitPostV2Request)
ثبت آگهی
این API امکان ثبت آگهی با استفاده از اعتبارسنجی JSON schema را فراهم میکند. دادههای آگهی در برابر قالب دستهبندی مشخص شده اعتبارسنجی میشوند. نکات مهم: - فیلدهای ویژه دستهبندی باید از قالب پیروی کنند - تمام فیلدهای اجباری ذکر شده در قالب باید ارسال شوند، در غیر این صورت ثبت ناموفق خواهد بود - این برای ثبت در سطح اپلیکیشن است (آگهیهای ارائهدهنده) - آگهیهای ثبت شده توسط ارائهدهندگان باید آگهیهای کسبوکار باشند، بنابراین توکن کسبوکار الزامی است - کاربر احراز هویت شده باید به کسبوکار دسترسی داشته باشد #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `SUBMIT_POST`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
let apiInstance = new KenarApiClient.PostApi();
let postSubmitPostV2Request = new KenarApiClient.PostSubmitPostV2Request(); // PostSubmitPostV2Request |
apiInstance.postSubmitPostV2(postSubmitPostV2Request).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postSubmitPostV2Request | PostSubmitPostV2Request |
- Content-Type: application/json
- Accept: application/json
PostSubmitPostResponse postSubmitUserPost(postSubmitUserPostRequest)
ثبت آگهی به عنوان کاربر
این API امکان ثبت آگهی از طرف کاربر احراز هویت شده با استفاده از اعتبارسنجی JSON schema را فراهم میکند. آگهی متعلق به کاربر احراز هویت شده خواهد بود و میتوان از طریق APIهای مختص کاربر مدیریت کرد. نکات مهم: - فیلدهای ویژه دستهبندی باید از قالب پیروی کنند - تمام فیلدهای اجباری ذکر شده در قالب باید ارسال شوند، در غیر این صورت ثبت ناموفق خواهد بود - آگهیهای ثبت شده توسط ارائهدهندگان باید آگهیهای کسبوکار باشند، بنابراین توکن کسبوکار الزامی است - کاربر احراز هویت شده باید به کسبوکار دسترسی داشته باشد #### دسترسیها: ##### مجوزهای API Key مورد نیاز: - `SUBMIT_USER_POST` ##### OAuth اسکوپ موردنیاز: - `SUBMIT_USER_POST`
import KenarApiClient from 'kenar-api-client';
let defaultClient = KenarApiClient.ApiClient.instance;
// Configure API key authorization: APIKey
let APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: OAuth
let OAuth = defaultClient.authentications['OAuth'];
OAuth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new KenarApiClient.PostApi();
let postSubmitUserPostRequest = new KenarApiClient.PostSubmitUserPostRequest(); // PostSubmitUserPostRequest |
apiInstance.postSubmitUserPost(postSubmitUserPostRequest).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| postSubmitUserPostRequest | PostSubmitUserPostRequest |
- Content-Type: application/json
- Accept: application/json