📄 مستندات وب سرویس ثبت بیمه
این API به فروشگاهها امکان میدهد سفارش بیمه برای محصولات فروختهشده به مشتریان خود را بهصورت آنلاین در بیمه کالا ثبت کنند. با ثبت بیمهنامه پیامک تکمیل اطلاعات برای مشتری ارسال خواهد شد. پس از ثبت بیمه، اطلاعات بیمهنامه در پنل فروشگاه قابل مشاهده و پیگیری است.
لطفاً توجه داشته باشید:
برای ثبت بیمهنامه، پنل فروشگاه باید دارای اعتبار مالی کافی باشد. با ثبت هر درخواست، هزینه بیمهنامه از اعتبار کیف پول فروشگاه کسر میشود.
توصیه میشود از این API تنها در مرحله “پردازش سفارش” در پنل ادمین خود استفاده کنید تا از ثبت اشتباه جلوگیری شود.
- در صورت نیاز به لغو بیمهنامه، لطفاً موضوع را از طریق پشتیبانی بیمهکالا پیگیری و اعلام نمایید. توجه داشته باشید که امکان لغو مستقیم از طریق API وجود ندارد و بررسی لغو تنها از طریق تیم پشتیبانی قابل انجام است.
ثبت بیمه نامه
🛠️ ساختار URL
POST https://api.bimekala.com/store/plugin/order
پارامتر های ورودی
پارامتر |
نوع |
اجباری / اختیاری |
توضیح |
---|---|---|---|
phoneNumber |
string |
اجباری |
شماره موبایل مشتری باید بهصورت کامل و با صفر ابتدایی (مثال: 09121234567) ثبت شود. از ارسال شماره با پیششماره بینالمللی (+98) یا بدون صفر ابتدایی خودداری نمایید |
fullName |
string |
اجباری |
نام و نام خانوادگی مشتری باید به فارسی ارسال گردد. از ارسال نام و نام خانوادگی به زبان انگلیسی یا با کاراکترهای لاتین خودداری نمایید |
items |
array |
اجباری |
لیست کالاها (items) باید حداقل شامل یک کالا باشد. همچنین میتوانید برای یک شماره موبایل، چندین کالا را بهصورت همزمان در یک درخواست ثبت و ارسال کنید تا همه بیمهنامهها بهصورت یکجا برای مشتری ثبت شوند. |
insuranceType |
integer |
اجباری |
نوع بیمه
|
productName |
string |
اجباری |
نام محصول بصورت کامل ارسال شود (مثال:گوشی موبایل سامسونگ مدل A26 ظرفیت 128 گیگابایت رم 6 گیگابایت ) |
brand |
string |
اجباری |
برند محصول |
category |
string |
اجباری |
|
devicePrice |
long (int64) |
اجباری |
قیمت کالا به ریال |
🔐 احراز هویت (Authorization)
درخواستها باید شامل هدر زیر باشند:
Header |
Value |
---|---|
x_token |
{توکن فروشگاه شما} |
Content-Type |
application/json |
📤 نمونه درخواست
curl --location 'https://api.bimekala.com/store/plugin/order' \
--header 'x_token: your_token_here' \
--header 'Content-Type: application/json' \
--data '{
"phoneNumber": "09121234567",
"fullName": "علی علوی",
"items": [
{
"insuranceType": 2,
"productName": "گوشی موبایل سامسونگ مدل A26 ظرفیت 128 گیگابایت رم 6 گیگابایت ",
"brand": "سامسونگ",
"category": "موبایل",
"devicePrice": 750000000
}
]
}'
ساختار Body
{
"phoneNumber": "شماره موبایل مشتری",
"fullName": "نام و نام خانوادگی مشتری",
"items": [
{
"insuranceType": عدد نوع بیمه,
"productName": "نام محصول",
"brand": "برند محصول",
"category": "دستهبندی محصول",
"devicePrice": مبلغ کالا به ریال
}
]
📦 پاسخ موفق 200 (Response)
{
"success": true,
"message": "درخواست شما با موفقیت ثبت و پیامک تکمیل بیمهنامه به مشتری شما ارسال شد.",
"errorType": 0
}
⚠️ جدول خطاها
HTTP Code |
توضیح |
---|---|
400 |
ورودی نامعتبر (فیلد ناقص یا نامعتبر) - نام محصول، برند و دستهبندی نمیتواند خالی باشد |
402 |
اعتبار کیف پول فروشگاه کافی نیست - شما برای ثبت این درخواست به 628,579 تومان اعتبار بیشتر در کیف پول بیمهکالا نیاز دارید. |
403 |
عدم دسترسی - شما مجاز به انجام این عملیات نیستید. |
406 |
اعتبار کیف پول فروشگاه کافی نیست - شما برای ثبت این درخواست به 628,579 تومان اعتبار بیشتر در کیف پول بیمهکالا نیاز دارید. |
500 |
خطای سرور |
🚀 نکات تکمیلی:
✅ پیامک فعالسازی بیمه پس از ثبت سفارش بهصورت خودکار برای مشتری ارسال میشود.
✅ قبل از استفاده، مطمئن شوید موجودی کیف پول فروشگاه شما کافی است.
✅ در صورت نیاز به گزارشگیری سفارشات بیمه صادرشده، از پنل فروشگاه خود استفاده نمایید.
✅ برای API تستی یا محیط sandbox با پشتیبانی هماهنگ کنید.