پرش به مطلب اصلی

ساخت و بروزرسانی افزونه آگهی

افزونه تایید شده

اکثر برنامه‌ها برای منتشر شدن باید اجازه کاربر را جهت درج افزونه طبق فرایند احراز باز دریافت کنند. برای درج افزونه تایید شده می‌توانید با توجه به نیاز، از دو اسکوپ زیر استفاده کنید.

اسکوپ احراز بازتوضیحاتمثال
POST_ADDON_CREATE.{POST_TOKEN}درج افزونه بر روی یک اگهی کاربر با توکن gZ5ZolKkPOST_ADDON_CREATE.gZ5ZolKk
USER_POSTS_ADDON_CREATEدرج افزونه بر روی تمام آگهی های یک کاربرUSER_POSTS_ADDON_CREATE

  • در هنگام فراخوانی این اندپوینت صرفا اعتبار سنجی مقادیر و فرمت اطلاعات داده شده انجام می‌شود.
  • در صورت رد شدن هر یک از اعتبار سنجی ها در ریسپانس ارور پس‌داده خواهد شد.
  • بعد از اعتبار سنجی ریسپانس موفق یا علت رد درخواست الصاق افزونه پس داده میشود در حالی که الصاق افزونه هنوز انجام نشده است.
  • پس از مدتی افزونه برای آگهی تولید میشود و از ریسپانس کد ۲۰۰ میتوانید مطمئن باشید حتما افزونه شما ساخته خواهد شد.
  • از این اندپوینت برای بروزرسانی نیز میتوانید استفاده کنید.

نکته: تنها اعتبار سنجی که انجام نمی‌شود توکن آگهی می‌باشد در صورت اشتباه بودن این مقدار افزونه ساخته نمی‌شود و در ریسپانس قبول شده خواهید دید پس از صحت توکن اطمینان حاصل نمائید.

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

ریکوئست

لینک این درخواست در فهرست API-ها

POST https://api.divar.ir/v2/open-platform/addons/post/{{post_token}}
Content-Type: application/json
x-api-key: {{apikey}}

x-access-token: {{access_token}}

{
"widgets": [
{
"description_row": {
"text": "این یک دسکریپشن رو هست",
"has_divider": false,
"expandable": false
},
},
{
"event_row": {
"title": "یه تایتل مناسب",
"subtitle": "یه زیر تایتل مناسب تر",
"label": "یه لیبل زیبا",
"image_id": "someuuid.jpg",
"has_divider": true,
"icon_name": "ADD",
"action": {
"open_direct_link": "https://google.com"
}
},
}
],
"notes": "any notes you want to get back on list api"
}
  • فیلد widgets باید با ویجت های مورد نظر پر شود.
  • فیلد  notes برای یاداشت های مورد نظرتون روی افزونه می‌باشد می‌توانید با تابع لیست این اطلاعات رو پس بگیرید.
  • فیلد semantic برای اطلاعات معنایی می باشد که در اینجا بیشتر توضیح داده شده است.

ریسپانس

با توجه به status_code خروجی این API از موفقیت یا خطای مربوطه مطلع خواهید شد.

{}