روند پیشنهادی آیتول بیز برای پیادهسازی وبسرویسها را میتوانید در اینجا مشاهده کنید.
وبسرویس استعلام قیمت شرکتهای بیمه براساس اطلاعات بیمهای و مدل خودرو
Address:
{{base_url}}/api/insurance/body/price-query
HTTP Method:
GET
Headers:
| Header | Value |
| Accept | application/json |
| Authorization | Bearer {{token}} |
Query Parameters:
| Required | Parameter | Value | type |
| yes | car_model | شناسه مدل خودرو |
int |
| yes | build_year | سال ساخت به جلالی |
string |
| yes | car_value | قیمت تخمینی خودرو |
int |
| yes | is_imported | خودرو وارداتی است یا خیر؟ |
bool |
| no | accessory_price | قیمت لوازم غیر فابریک |
string |
| yes | glass_break | پوشش های اضافه: شکستن شیشه |
bool |
| yes | acidic_spray | پوشش های اضافه:اسیدپاشی |
bool |
| yes | robbery | پوشش های اضافه: سرقت خودرو |
bool |
| no | carbill_accessory_robbery_coverage_id | پوشش های اضافه: درصد پوشش اضافه |
int |
| yes | market_flactuation | پوشش های اضافه: نوسانات قیمت |
bool |
| no | carbill_market_fluctuation_coverage_id | پوشش های اضافه: درصد پوشش اضافه |
int |
| yes | natural_disaster | پوشش های اضافه: بلایای طبیعی |
bool |
| yes | transportation | پوشش های اضافه: ایاب و ذهاب |
bool |
| yes | is_zero_kilometer | صفر کیلومتر |
bool |
| no | current_insurance_deadline | تاریخ اتمام بیمه‌نامه |
date |
| no | third_party_discount | شناسه درصد تخفیف شخص ثالث |
int |
| no | third_party_company | شناسه شرکت بیمه گر شخص ثالث |
int |
| no | body_discount | شناسه درصد تخفیف بیمه بدنه |
int |
| no | current_body_insurance_company | شناسه شرکت فعلی بیمه‌گر بدنه خودرو |
int |
| no | license |
پلاک طبق استاندارد پیوست 1 - ساختار پلاک |
string |
Headers:
| Header | Value |
| Content-Type | application/json |
Body:
{
"error": false,
"data": [
{
"insurance_company": {
"id": 8,
"name": "بیمه سینا",
"logo_url": "http://localhost/images/insurance-companies/8.png",
"slug": "sina",
"issuable": true
},
"price": {
"total": 3450960,
"discounted_price": null
}
},
{
"insurance_company": {
"id": 13,
"name": "بیمه تعاون",
"logo_url": "http://localhost/images/insurance-companies/18.png",
"slug": "taavon",
"issuable": true
},
"price": {
"total": 4165980,
"discounted_price": null
}
}
]
}
این وبسرویس برای ثبت موقت اطلاعات وارد شده توسط کاربر در سامانه کاربیل استفاده میشود. این ثبت به معنی ثبت نهایی نمیباشد و صرفا پیشنویس پرداخت است و باید با استفاده از order_id ثبت شده، آن سفارش تایید پرداخت شود تا مبلغ آن در کیف پول الکترونیکی اعمال شود.
Address:
{{base_url}}/api/insurance/body/order
HTTP Method:
POST
Headers:
| Header | Value |
| Accept | application/json |
| Authorization | Bearer {{token}} |
Body: raw JSON
| Parameter | Value | description |
| birthday | تاریخ تولد (Y-m-d) | required |
| birth_year | سال تولد به جلالی |
optional |
| build_year | سال تولید به جلالی |
required |
| insurance_company | شناسه شرکت بیمه گر |
required |
| previous_insurance_company | شناسه شرکت بیمه گر قبلی |
optional |
| previous_insurance_number | شماره بیمه نامه قبلی |
optional |
| current_insurance_deadline | تاریخ اتمام بیمه‌نامه |
required |
| third_party_discount | شناسه درصد تخفیف شخص ثالث |
optional |
| body_discount | شناسه درصد تخفیف بیمه بدنه |
optional |
| settlement_address | آدرس محل سکونت |
required |
| visiting_address | آدرس محل بازدید خودرو |
optional |
| policy_address | آدرس ارسال بیمه‌نامه |
optional |
| unique_code | کد یکتا |
optional |
| real_user_id | با پشتیبانی itoll در تماس باشید. | Integer, Optional |
| estimated_price | قیمت تخمینی خودرو |
required |
| insurer_info | Json of insurer info:
|
optional |
| accessory_price | قیمت تخمینی لوازم غیر فابریک |
optional |
| is_zero_kilometer | صفر کیلومتر |
required |
| is_imported | آیا خودرو وارداتی است یا خیر؟ |
required |
| car_glass_break | پوشش های اضافی: شکستن شیشه |
required |
| acid_spray | پوشش های اضافی: پاشیدن اسید |
required |
| robbery | پوشش های اضافه: سرقت خودرو |
required |
| carbill_accessory_robbery_coverage_id | پوشش های اضافه: درصد پوشش |
optional |
| market_fluctuation | پوشش های اضافه: نوسانات قیمت |
required |
| carbill_market_fluctuation_coverage_id | پوشش های اضافه: درصد پوشش |
optional |
| natural_disaster | پوشش های اضافه: بلایای طبیعی |
required |
| transportation | پوشش های اضافه: ایاب و ذهاب |
required |
| bank_account | شناسه بانک |
optional |
| vin | VIN خودرو | optional |
| license |
پلاک طبق استاندارد پیوست 1 - ساختار پلاک |
required |
| car_model_id | شناسه مدل خودرو |
required |
| property_damage_risk_id | شناسه درصد تخفیفات مالی |
required |
| car_usage | شناسه car usage |
required |
| buyer_id | شناسه ی رشته‌ای یا عددی دلخواه از سمت سرویس‌گیرنده که کاربیل به وسیله آن، موارد دارای مشکل را از سمت سرویس گیرنده پیگیری می‌کند. |
required |
| mobile | optional | |
| city_id | optional |
Body (Success):
{
"order_id": 4,
"price": 5066660,
"discounted_price": 5066660,
"without_discount_price": 5066660
}
با استفاده از این وبسرویس عکسهای مربوط به کارشناسی خودرو آپلود میشود.
Address:
{{base_url}}/api/insurance/{{insuranceOrder}}/body/images
HTTP Method:
POST
Headers:
| Header | Value |
| Accept | application/json |
| Authorization | Bearer {{token}} |
Body: form-data
| Parameter | Type | Description |
| car_front_image | file/image | |
| car_right_diagonal_front_image | file/image | |
| car_left_diagonal_front_image | file/image | |
| car_back_image | file/image | |
| car_right_diagonal_back_image | file/image | |
| car_left_diagonal_back_image | file/image | |
| car_right_side_image | file/image | |
| car_left_side_image | file/image | |
| car_front_glass_image | file/image | |
| car_back_glass_image | file/image | |
| car_wheels_right_front_image | file/image | |
| car_wheels_left_front_image | file/image | |
| car_wheels_right_back_image | file/image | |
| car_wheels_left_back_image | file/image | |
| car_roof_image | file/image | |
| car_engine_image | file/image | |
| car_trunk_image | file/image | |
| car_spare_wheel_image | file/image | |
| car_mileage_image | file/image | |
| car_dashboard_image | file/image | |
| car_chassis_number_image | file/image |
Body (Success):
{
"message": "Images successfully uploaded."
}
با استفاده از این وبسرویس، سفارش بیمه ثبت شده پرداخت میشود و مبلغ سفارش از کیف پول شما کم خواهد شد.
Address:
{{base_url}}/api/insurance/order/{{insuranceOrder}}/confirm
HTTP Method:
POST
Headers:
| Header | Value |
| Accept | application/json |
| Authorization | Bearer {{token}} |
URL Parameters:
| Parameter | Value |
| insuranceOrder | شناسه سفارش ثبت شده |
Body:
| Parameter | Value |
| reference_code | شناسه‌ی رشته‌ای یا عددی دلخواه از سمت سرویس‌گیرنده که کاربیل به وسیله آن، موارد دارای مشکل را از سمت سرویس گیرنده پیگیری می‌کند. |
Body (Success):
{
"error": false,
"order_id": ****,
"price": 15786810
}
پس از پرداخت، برای اطلاع از وضعیت سفارش، چنانچه تغییری در وضعیت سفارش به وجود آید، کاربیل یک وب هوک از سمت سرویس‌گیرنده را صدا میزند و در قالب form-data کل اطلاعات بیمه را برای سرویس‌گیرنده ارسال می‌کند و سرویس‌گیرنده بسته به پارامتر status میتواند عملیات مورد نیاز خود را انجام دهد.
در صورتی که status یکی از مقادیر زیر باشد، اکشن مربوطه می بایست انجام گردد.
ISSUED:
این وضعیت به معنای صادر شدن بیمه‌نامه میباشد. در این حالت باید api دانلود فایل بیمه‌نامه از سمت سرویس‌گیرنده صدا زده شود.
CANCELLED:
این وضعیت به معنای کنسل شدن سفارش و عودت مبلغ به کاربر میباشد.
INCOMPLETE:
این وضعیت به معنای اعلام مغایرت مدرک و اطلاعات توسط کارگزار بیمه میباشد. هنگام خواندن این وضعیت، جهت دریافت اطلاعات بیشتر، باید فیلد status_updates را از وب هوک بخوانید. معمولا اعلام مغایرت مدرک از طرف کارگزار بیمه به ۲ صورت است:
۱ - نقص مدارک
۲ - عدم ارسال مدارک توسط کاربر
برای تکمیل مدارک کاربر، ابتدا سرویس‌گیرنده مدارک را از کاربر خود دریافت می‌کند، سپس api ارسال مدارک که در بخش آپلود مدارک توضیح دادهشده را صدا میزند.
PRICE_CONFLICT:
این وضعیت به معنای اعلام مغایرت قیمت توسط کارگزار بیمه میباشد. در این حالت پارامتر conflict_price موجود در form-data مبلغ مغایرت را مشخص می‌کند. سرویس‌گیرنده پس از دریافت مبلغ از کاربر یا عودت مبلغ به کاربر، باید api رفع مغایرت را صدا بزند.
https://6el7j.mocklab.io/mock
Address:
{{base_url}}/insurance/file/{{fileName}}
HTTP Method:
GET
Address:
{{base_url}}/api/insurance/order/{{insuranceOrder}}/resolve
HTTP Method:
PUT
Headers:
| Header | Value |
| Accept | application/json |
| Authorization | Bearer {{token}} |
URL Parameters:
| Parameter | Value |
| insuranceOrder | شناسه سفارش ثبت شده |
Body (Success):
{
"message": "عملیات با موفقیت انجام شد"
}