نسخه چاپی
API نظرات بازار
API نظرات بازار با هدف سهولت بیشتر در بررسی و پاسخ به نظرات به صورت خودکار پیادهسازی شده است. با کمک این قابلیت و با استفاده از این APIها میتوانید نظرات برنامهی خود را دریافت کرده و پاسخ مناسب برای هر نظر را ثبت کنید.
برای هدر احراز هویت:
توکن مربوط به ایپیآی پیشخان خود را همانطور که در مستندات پیشخان وجود دارد کسب کرده و در هدر درخواست خود بگذارید.
- Base URL: https://sandoghche.cafebazaar.ir
لیست درخواستها:
توسط API های ذکر شده در این سند، توسعهدهنده میتواند موارد زیر را انجام دهد:
- مشاهده لیست نظرات بازار
- ارسال پاسخ به نظر
اطلاعات درخواست:
Parameter | Value | Description |
URL | Base URL}}/api/v0/reviews}} | آدرس درخواست |
Method Type | GET | متد درخواست |
Authorization Type | API Key | نوع احراز هویت |
Authorization Key | Key | کلید احراز هویت (به مستندات پیشخان مراجعه شود) |
Authorization Value | Value | مقدار کلید احراز هویت (به مستندات پیشخان مراجعه شود) |
Authorization Add to | Header | محل قرارگیری پارامتر احراز هویت |
کرل درخواست:
curl --location --request GET 'https://sandoghche.cafebazaar.ir/api/v0/reviews/' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header '{{api_key}}: {{api_key_value}}'
اطلاعات رسپانس:
Key | Description | Type |
next | URL صفحه بعد برای مشاهده نظرات بعدی | string |
previous | URL صفحه قبل برای مشاهده نظرات قبلی | string |
results | آرایه نظرات (به جزئیات results مراجعه شود) | Json array |
جزئیات results:
Key | Description | Type |
id | شناسه منحصربفرد پیام کاربر | int |
user_account_id | شناسه منحصربفرد کاربر | string |
text | متن پیام کاربر | staring |
rate | امتیاز داده شده توسط کاربر | int |
developer_reply | آبجکت نظر توسعهدهنده: در صورتی که توسعهدهنده پاسخی را ثبت کرده باشد و این پاسخ در حالت انتشار باشد آبجکت زیر در پاسخ بر میگردد. (به جزئیات developer_reply مراجعه شود) | Json Object |
جزئیات developer_reply:
Key | Description | Type |
text | متن نظر توسعهدهنده | string |
ایمیل توسعهدهنده | string | |
publish_date | تاریخ منتشر شدن نظر توسعهدهنده | string (iso format) |
نمونه رسپانس:
{
"next": "https://sandoghche.cafebazaar.ir/api/v0/reviews/?cursor=cD0yMDIxLTA5LTA0KzA3JTNBNTIlM0E0Mi45NDIxNjQlMkIwMCUzQTAw",
"previous": null,
"results": [
{
"id": 122280901,
"user_account_id": "a343243a-6045-478f-b88b-0e4eb15e0c18",
"text": "عالی",
"rate": 5,
"developer_reply": {
"text": "بابت انتخابتون از شما ممنونیم.",
"email": "cafebazi@cafebazaar.ir",
"publish_date": "2021-11-29T17:40:28.184113+03:30"
}
}
]
}
وضعیت کدهای رسپانس:
Status Code | Description |
200 | عملیات موفقیت آمیز بود |
- ارسال پاسخ به نظر
نکته: لازم به ذکر است که پاسخ توسعهدهنده باید پس از ثبت به تایید بازار برسد تا نمایش داده شود. |
اطلاعات درخواست:
Parameter | Value | Description |
URL | /Base URL}}/api/v0/reviews/{{id}}}} | آدرس درخواست به جای {{id}}، id نظر کاربر که در درخواست قبل تحت فیلد id ارسال شده است، قرار گیرد. |
Method Type | POST | متد درخواست |
Header: Authorization Type | API Key | نوع احراز هویت |
Header: Authorization Key | Key | کلید احراز هویت (به مستندات پیشخان مراجعه شود) |
Header: Authorization Value | Value | مقدار کلید احراز هویت (به مستندات پیشخان مراجعه شود) |
Header: Authorization Add to | Header | محل قرارگیری پارامتر احراز هویت |
Body Type | JSON | نوع بدنه ارسالی درخواست |
Body | {"text":"Test","email":"Test@cafebazaar.ir"} | Text: String متن نظر توسعهدهنده /email: string – optional - ایمیل پاسخ دهنده که به کاربر نمایش داده میشود. به صورت پیشفرض ایمیل کارگزار احراز هویت شده است. |
کرل درخواست:
curl --location --request POST 'https://sandoghche.cafebazaar.ir/api/v0/reviews/122455833/' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header '{{api_key}}: {{api_key_value}}' \
--data-raw '{
"text": "Test",
"email": "Test@cafebazaar.ir"
}'
اطلاعات رسپانس:
Key | Description | Type |
text | متن نظر توسعهدهنده | string |
ایمیل پاسخ دهندهی نظر | (optional)string |
نمونه رسپانس:
{
"text": "بابت انتخابتون از شما ممنونیم.",
"email": "cafebazi@cafebazaar.ir"
}
وضعیت کدهای رسپانس:
Status Code | Description |
201 | عملیات موفقیت آمیز بود |
در هر درخواست در صورتی که پردازش آن با خطا مواجه شود، status code مربوطه همراه با پاسخ زیر ارسال می شود:
Key | Description | Type |
detail | جزئیات خطای به وجود آمده | string |
در نهایت میتواید با ثبت تیکت یا تماس با پشتیبانی توسعه دهندگان بازار به شماره ۰۲۱۹۱۰۰۹۷۹۸ نظرات و مشکلات خود در رابطه با پیادهسازی API نظرات بازار را با همکاران ما در میان بگذارید.
بیشتر بخوانید:
به مطالب ارائه شده چه امتیازی میدهید؟
محل نوشتن دیدگاه ...
اگر در مورد محتوا نظر یا پیشنهادی دارید لطفا برای ما بنویسید.
زمان انتشار: ۱۴۰۰-۰۹-۲۱ ۱۰:۱۹
آخرین بهروزرسانی: ۱۴۰۰-۱۰-۰۴ ۰۸:۳۹