Getting started

EasyBimehConnect

یک ساب برند از ایزی بیمه است که وظیفه ارائه خدمات

B2B و B2B2C

را برپایه وب سرویس و وایت لیبل بر عهده دارد. اگر اپلیکیشن و یا سایت غیر بیمه‌ای دارید و تمایل به فروش بیمه نامه دارید از امروز میتوانید با کمترین هزینه و کمترین زمان به زنجیره نوآوری در صنعت بیمه متصل شوید و تجارت جدیدی بسازید

به دلیل گستردگی پروژه و برای دسترسی بهتر، این پروژه به بخش های مختلف تقسیم شده است

و هر بخش در 10 پلتفرم مختلف، ارایه شده است

در این بخش، به وب سرویس های مربوط به صفحه ی لندینگ مرکز بیمه، دسترسی خواهید داشت که

اطلاعات هر پلتفرم را میتوانید بصورت تجمیعی در آدرس زیر مشاهده نمایید

https://www.apimatic.io/apidocs/easybimehlanding

و یا بصورت مجزا در آدرس های زیر قابل درسترس می باشند

1- Android: https://github.com/kmelodi/EasyBimehLanding_Android

2- .Net: https://github.com/kmelodi/EasyBimehLanding_.NET

3- Ios: https://github.com/kmelodi/EasyBimehLanding_IOS

4- Java: https://github.com/kmelodi/EasyBimehLanding_JAVA

5- Php: https://github.com/kmelodi/EasyBimehLanding_PHP

6- Python: https://github.com/kmelodi/EasyBimehLanding_Python

7- Ruby: https://github.com/kmelodi/EasyBimehLanding_Ruby

8- Angular: https://github.com/kmelodi/EasyBimehLanding_Angular

9- NodeJs: https://github.com/kmelodi/EasyBimehLanding_NodeJs

10- Go: https://github.com/kmelodi/EasyBimehLanding_Go

برای اطلاعات بیشتر به آدرس زیر مراجعه نمایید

https://easybimeh.com/ebconnect

How to Build

The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the composer.json file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system. Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system. Open command prompt and type composer --version. This should display the current version of the Composer installed if the installation was successful.

Using command line, navigate to the directory containing the generated files (including composer.json) for the SDK.
Run the command composer install. This should install all the required dependencies and create the vendor directory in your project directory.

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

[curl]
; A default value for the CURLOPT_CAINFO option. This is required to be an
; absolute path.
;curl.cainfo =

How to Use

The following section explains how to use the EasyBimehLanding library in a new project.

1. Open Project in an IDE

Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on Open in PhpStorm to browse to your generated SDK directory and then click OK.

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test"

Add a PHP file to this project

Name it "testSDK"

Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.

require_once "../vendor/autoload.php";

It is important that the path inside require_once correctly points to the file autoload.php inside the vendor directory created during dependency installations.

After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

3. Run the Test Project

To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.

Open Settings from File menu.

Select PHP from within Languages & Frameworks

Browse for Interpreters near the Interpreter option and choose your interpreter.

Once the interpreter is selected, click OK

To run your project, right click on your PHP file inside your Test project and click on Run

How to Test

Unit tests in this SDK can be run using PHPUnit.

First install the dependencies using composer including the require-dev dependencies.
Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialization

API client can be initialized as following.

$client = new EasyBimehLandingLib\EasyBimehLandingClient();

Class Reference

List of Controllers

FileManagerController
LiabilityDoctorInsuranceController
CarBodyController
ElectronicEquipmentInsuranceController
OtherInsuranceTypesController
ThirdPartyInsuranceController
MotorcycleInsuranceController
FireInsuranceController
EarthquakeInsuranceController
TravelInsuranceController
ElevatorInsuranceController
MainController
ComboDataController
TrackingDamageController
FooterController
InsurancePolicyPlanController

FileManagerController

Get singleton instance

The singleton instance of the FileManagerController class can be accessed from the API Client.

$fileManager = $client->getFileManager();

upload

آپلود فایل در ایزی بیمه بعد از آپلود، ادرس فایل باید در api های بعدی ارسال شود.

function upload(
        $subDomain,
        $xApiKey,
        $file)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور
file	`Required`	فایل ارسالی

Example Usage

$subDomain = 'hfz1';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';
$file = 'file';

$result = $fileManager->upload($subDomain, $xApiKey, $file);

Back to List of Controllers

LiabilityDoctorInsuranceController

Get singleton instance

The singleton instance of the LiabilityDoctorInsuranceController class can be accessed from the API Client.

$liabilityDoctorInsurance = $client->getLiabilityDoctorInsurance();

getLiabilityDoctorInsurance

در یافت اطلاعات اولیه برای استعلام بیمه مسئولیت پزشکان

function getLiabilityDoctorInsurance(
        $subDomain,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $liabilityDoctorInsurance->getLiabilityDoctorInsurance($subDomain, $xApiKey);

getMedicalSpecialties

دریافت لیست تخصص های پزشکی

function getMedicalSpecialties(
        $id,
        $xApiKey)

Parameters

Parameter	Tags	Description
id	`Required`	نوع تخصص => ParamedicalExpertise => پیراپزشکی MedicalExpertise => پزشکی
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$id = 'ParamedicalExpertise';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $liabilityDoctorInsurance->getMedicalSpecialties($id, $xApiKey);

Back to List of Controllers

CarBodyController

Get singleton instance

The singleton instance of the CarBodyController class can be accessed from the API Client.

$carBody = $client->getCarBody();

getCarBrand

دریافت برند خودرو

function getCarBrand($xApiKey)

Parameters

Parameter	Tags	Description
xApiKey	`Required`	شناسه ی اختصاصی ارتباط با سرور

Example Usage

$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $carBody->getCarBrand($xApiKey);

getCarBrandTips

دریافت لیست تیپ خودرو

function getCarBrandTips(
        $carBrandId,
        $xApiKey)

Parameters

Parameter	Tags	Description
carBrandId	`Required`	شناسه ی برند خودرو
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$carBrandId = 190;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $carBody->getCarBrandTips($carBrandId, $xApiKey);

getHasPlan

آیا این نوع بیمه نامه، طرح بیمه ای دارد؟

function getHasPlan(
        $subDomain,
        $insurancePolicyType,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insurancePolicyType	`Required`	شناسه ی نوع بیمه نامه => بیمه بدنه=2
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insurancePolicyType = 2;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $carBody->getHasPlan($subDomain, $insurancePolicyType, $xApiKey);

Back to List of Controllers

ElectronicEquipmentInsuranceController

Get singleton instance

The singleton instance of the ElectronicEquipmentInsuranceController class can be accessed from the API Client.

$electronicEquipmentInsurance = $client->getElectronicEquipmentInsurance();

getElectronicEquipmentInsurance

دریافت اطلاعات اولیه استعلام بیمه نامه ی تجهیزات الکترونیک

function getElectronicEquipmentInsurance(
        $subDomain,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'subDomain';
$xApiKey = 'x-api-key';

$result = $electronicEquipmentInsurance->getElectronicEquipmentInsurance($subDomain, $xApiKey);

getDeviceBrandTypes

دریافت لیست نوع برند دستگاه

function getDeviceBrandTypes(
        $deviceGroup,
        $deviceTypeId,
        $xApiKey)

Parameters

Parameter	Tags	Description
deviceGroup	`Required`	شناسه ی گروه دستگاه
deviceTypeId	`Required`	شناسه ی نوع دستگاه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$deviceGroup = 1;
$deviceTypeId = 1;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $electronicEquipmentInsurance->getDeviceBrandTypes($deviceGroup, $deviceTypeId, $xApiKey);

getDiviceFranchisee

دریافت لیست فرانشیر استعلام بیمه نامه ی تجهیزات الکترونیک

function getDiviceFranchisee(
        $deviceModelId,
        $xApiKey)

Parameters

Parameter	Tags	Description
deviceModelId	`Required`	شناسه ی مدل دستگاه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$deviceModelId = 1340;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $electronicEquipmentInsurance->getDiviceFranchisee($deviceModelId, $xApiKey);

Back to List of Controllers

OtherInsuranceTypesController

Get singleton instance

The singleton instance of the OtherInsuranceTypesController class can be accessed from the API Client.

$otherInsuranceTypes = $client->getOtherInsuranceTypes();

getOtherInsuranceTypes

دریافت لیست سایر بیمه نامه ها

function getOtherInsuranceTypes(
        $subDomain,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $otherInsuranceTypes->getOtherInsuranceTypes($subDomain, $xApiKey);

getSendSmsToken

ارسال توکن تایید شماره تماس، برای احراز هویت کاربر

function getSendSmsToken(
        $mobile,
        $insuranceCentreSubDomain,
        $xApiKey)

Parameters

Parameter	Tags	Description
mobile	`Required`	شماره موبایل
insuranceCentreSubDomain	`Required`	دامنه یا زیردامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$mobile = '09018318086';
$insuranceCentreSubDomain = 'hfz1';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $otherInsuranceTypes->getSendSmsToken($mobile, $insuranceCentreSubDomain, $xApiKey);

getVerifySmsToken

تایید توکن پیامک شده به کاربر، برای احراز هویت

function getVerifySmsToken(
        $mobile,
        $token,
        $insuranceCentreSubDomain,
        $aliasName,
        $resource,
        $xApiKey)

Parameters

Parameter	Tags	Description
mobile	`Required`	شماره موبایل
token	`Required`	توکن دریافتی کاربر از پیامک
insuranceCentreSubDomain	`Required`	دامنه یا زیر دامنه ی اختصاصی مرکز بیمه
aliasName	`Required`	نام و نام خانوادگی کاربر
resource	`Required`	دامنه ی درخواست دهنده
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$mobile = '09018318086';
$token = 27763;
$insuranceCentreSubDomain = 'hfz1';
$aliasName = 'علی موسوی';
$resource = 'https://hfz1.easybimeh.com';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $otherInsuranceTypes->getVerifySmsToken($mobile, $token, $insuranceCentreSubDomain, $aliasName, $resource, $xApiKey);

Errors

Error Code	Error Description
400	Bad Request

Back to List of Controllers

ThirdPartyInsuranceController

Get singleton instance

The singleton instance of the ThirdPartyInsuranceController class can be accessed from the API Client.

$thirdPartyInsurance = $client->getThirdPartyInsurance();

getCarBrands

دریافت لیست برند خودرو ها

function getCarBrands(
        $carTypeGroup,
        $xApiKey)

Parameters

Parameter	Tags	Description
carTypeGroup	`Required`	شناسه ی گروه خودرو
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$carTypeGroup = 1;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $thirdPartyInsurance->getCarBrands($carTypeGroup, $xApiKey);

getRiskLevel

دریافت لیست تخفیف های بیمه

function getRiskLevel(
        $insurancePolicyType,
        $xApiKey)

Parameters

Parameter	Tags	Description
insurancePolicyType	`Required`	شناسه ی نوع بیمه نامه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$insurancePolicyType = 0;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $thirdPartyInsurance->getRiskLevel($insurancePolicyType, $xApiKey);

getCarBrandTips

دریافت لیست تیپ خودرو

function getCarBrandTips(
        $carBrandId,
        $xApiKey)

Parameters

Parameter	Tags	Description
carBrandId	`Required`	شناسه ی برند خودرو
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$carBrandId = 190;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $thirdPartyInsurance->getCarBrandTips($carBrandId, $xApiKey);

getCarUses

دریافت لیست نوع کاربری خودرو

function getCarUses(
        $carTypeId,
        $xApiKey)

Parameters

Parameter	Tags	Description
carTypeId	`Required`	شناسه ی نوع خودرو
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$carTypeId = 103;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $thirdPartyInsurance->getCarUses($carTypeId, $xApiKey);

getHasPlan

آیا این نوع بیمه نامه، طرح بیمه ای دارد؟

function getHasPlan(
        $subDomain,
        $insurancePolicyType,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insurancePolicyType	`Required`	شناسه ی نوع بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insurancePolicyType = 0;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $thirdPartyInsurance->getHasPlan($subDomain, $insurancePolicyType, $xApiKey);

Back to List of Controllers

MotorcycleInsuranceController

Get singleton instance

The singleton instance of the MotorcycleInsuranceController class can be accessed from the API Client.

$motorcycleInsurance = $client->getMotorcycleInsurance();

getCarBrands

دریافت لیست برند موتور سیکلت

function getCarBrands(
        $carTypeGroup,
        $xApiKey)

Parameters

Parameter	Tags	Description
carTypeGroup	`Required`	شناسه ی گروه خودرویی، موتور سیکلت =>0
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$carTypeGroup = 0;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $motorcycleInsurance->getCarBrands($carTypeGroup, $xApiKey);

getCarBrandTips

دریافت لیست تیپ موتور سیکلت

function getCarBrandTips(
        $carBrandId,
        $xApiKey)

Parameters

Parameter	Tags	Description
carBrandId	`Required`	شناسه ی برند موتور سیکلت
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$carBrandId = 472;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $motorcycleInsurance->getCarBrandTips($carBrandId, $xApiKey);

getHasPlan

آیا این نوع بیمه نامه، طرح بیمه ای دارد؟

function getHasPlan(
        $subDomain,
        $insurancePolicyType,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insurancePolicyType	`Required`	شناسه ی نوع بیمه نامه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insurancePolicyType = 7;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $motorcycleInsurance->getHasPlan($subDomain, $insurancePolicyType, $xApiKey);

Back to List of Controllers

FireInsuranceController

Get singleton instance

The singleton instance of the FireInsuranceController class can be accessed from the API Client.

$fireInsurance = $client->getFireInsurance();

getFireInsurance

دریافت اطلاعات پایه بیمه ی آتش سوزی

function getFireInsurance(
        $subDomain,
        $insurancePolicyId,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insurancePolicyId	`Required`	شناسه ی بیمه نامه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insurancePolicyId = 0;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $fireInsurance->getFireInsurance($subDomain, $insurancePolicyId, $xApiKey);

Back to List of Controllers

EarthquakeInsuranceController

Get singleton instance

The singleton instance of the EarthquakeInsuranceController class can be accessed from the API Client.

$earthquakeInsurance = $client->getEarthquakeInsurance();

getEarthquake

دریافت اطلاعات پایه ی بیمه ی زلزله

function getEarthquake(
        $subDomain,
        $insurancePolicyId,
        $insurancePolicyType,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insurancePolicyId	`Required`	شناسه ی بیمه نامه
insurancePolicyType	`Required`	شناسه ی نوع بیمه نامه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insurancePolicyId = 0;
$insurancePolicyType = 6;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $earthquakeInsurance->getEarthquake($subDomain, $insurancePolicyId, $insurancePolicyType, $xApiKey);

Back to List of Controllers

TravelInsuranceController

Get singleton instance

The singleton instance of the TravelInsuranceController class can be accessed from the API Client.

$travelInsurance = $client->getTravelInsurance();

getTravelInsurance

TODO: Add Description

function getTravelInsurance(
        $subDomain,
        $insurancePolicyId,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insurancePolicyId	`Required`	شناسه ی بیمه نامه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insurancePolicyId = 0;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $travelInsurance->getTravelInsurance($subDomain, $insurancePolicyId, $xApiKey);

Back to List of Controllers

ElevatorInsuranceController

Get singleton instance

The singleton instance of the ElevatorInsuranceController class can be accessed from the API Client.

$elevatorInsurance = $client->getElevatorInsurance();

getElevatorInsurance

دریافت اطلاعات پایه ی بیمه نامه ی آسانسور

function getElevatorInsurance(
        $subDomain,
        $insurancePolicyId,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insurancePolicyId	`Required`	شناسه ی بیمه نامه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insurancePolicyId = 0;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $elevatorInsurance->getElevatorInsurance($subDomain, $insurancePolicyId, $xApiKey);

Back to List of Controllers

MainController

Get singleton instance

The singleton instance of the MainController class can be accessed from the API Client.

$main = $client->getMain();

getPortalLandingPage

در یافت اطلاعات لندینگ مراکز بیمه

function getPortalLandingPage(
        $id,
        $xApiKey)

Parameters

Parameter	Tags	Description
id	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$id = 'hfz1';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $main->getPortalLandingPage($id, $xApiKey);

getInsuranceCentrePolicyTypes

دریافت لیست بیمه ی های ارائه شده توسط مرکز بیمه

function getInsuranceCentrePolicyTypes(
        $subDomain,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $main->getInsuranceCentrePolicyTypes($subDomain, $xApiKey);

Back to List of Controllers

ComboDataController

Get singleton instance

The singleton instance of the ComboDataController class can be accessed from the API Client.

$comboData = $client->getComboData();

getDamageType

دریافت لیست نوع خسارت

function getDamageType($xApiKey)

Parameters

Parameter	Tags	Description
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $comboData->getDamageType($xApiKey);

getInsuranceTypes

دریافت لیست نوع بیمه نامه

function getInsuranceTypes(
        $subDomain,
        $issueInsurance,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
issueInsurance	`Required`	دریافت بیمه نامه های قابل صدور
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$issueInsurance = false;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $comboData->getInsuranceTypes($subDomain, $issueInsurance, $xApiKey);

getInsuranceCompanies

دریافت لیست شرکت های بیمه

function getInsuranceCompanies(
        $subDomain,
        $insuranceTypeId,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
insuranceTypeId	`Required`	شناسه ی نوع بیمه نامه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$insuranceTypeId = 1;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $comboData->getInsuranceCompanies($subDomain, $insuranceTypeId, $xApiKey);

Back to List of Controllers

TrackingDamageController

Get singleton instance

The singleton instance of the TrackingDamageController class can be accessed from the API Client.

$trackingDamage = $client->getTrackingDamage();

getTrackingCode

استعلام وضعیت خسارت

function getTrackingCode(
        $mTrackingCode,
        $xApiKey)

Parameters

Parameter	Tags	Description
mTrackingCode	`Required`	کد پیگیری خسارت
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$mTrackingCode = '/{TrackingCode}';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $trackingDamage->getTrackingCode($mTrackingCode, $xApiKey);

Errors

Error Code	Error Description
400	Bad Request

createTrackingDamage

ثبت خسارت بیمه

function createTrackingDamage(
        $body,
        $xApiKey,
        $contentType)

Parameters

Parameter	Tags	Description
body	`Required`	اطلاعات خسارت
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور
contentType	`Required`	TODO: Add a parameter description

Example Usage

$bodyValue = "{\r\n  \"personalityType\": 0,\r\n  \"trackingDamageStatus\": [\r\n    {\r\n      \"trackingDamageFile\": [\r\n        {\r\n          \"id\": 162747,\r\n          \"url\": \"https://media.easybimeh.com//Easybimeh/FileManager/InsuranceCentre/hfz1/637089119345134776.jpeg\",\r\n          \"title\": \"کارت شناسایی\"\r\n        }\r\n      ]\r\n    }\r\n  ],\r\n  \"description\": \"بدنه ی خودرو خسارت دیده\",\r\n  \"insuranceTypeId\": 1,\r\n  \"insuranceCompanyId\": 34,\r\n  \"insurancePolicyNumber\": \"123456\",\r\n  \"damageType\": \"مالی\",\r\n  \"name\": \"کاظم\",\r\n  \"nationalCode\": \"3080118383\",\r\n  \"mobile\": \"09018318086\",\r\n  \"insuredProfile\": \"پژو 405\",\r\n  \"subDomain\": \"hfz1\"\r\n}";
$body = APIHelper::deserialize($bodyValue);
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';
$contentType = 'application/json';

$result = $trackingDamage->createTrackingDamage($body, $xApiKey, $contentType);

getStatusStatusCollections

دریافت لیست وضعیت های خسارت

function getStatusStatusCollections(
        $statusType,
        $xApiKey)

Parameters

Parameter	Tags	Description
statusType	`Required`	نوع وضعیت ها ی خسارت => 0
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$statusType = 0;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $trackingDamage->getStatusStatusCollections($statusType, $xApiKey);

getStatus

دریافت اطلاعات وضعیت

function getStatus(
        $entityId,
        $xApiKey)

Parameters

Parameter	Tags	Description
entityId	`Required`	شناسه ی وضعیت
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$entityId = 1129;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $trackingDamage->getStatus($entityId, $xApiKey);

Back to List of Controllers

FooterController

Get singleton instance

The singleton instance of the FooterController class can be accessed from the API Client.

$footer = $client->getFooter();

getPortalLandingContactAbout

دریافت اطلاعات درباره ی ما

function getPortalLandingContactAbout($xApiKey)

Parameters

Parameter	Tags	Description
xApiKey	`Required`	TODO: Add a parameter description

Example Usage

$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $footer->getPortalLandingContactAbout($xApiKey);

getFaqInsuranceCentre

دریافت لیست سوالات متداول

function getFaqInsuranceCentre($xApiKey)

Parameters

Parameter	Tags	Description
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $footer->getFaqInsuranceCentre($xApiKey);

getInsurancePolicyTracking

پیگیری وضعیت بیمه نامه

function getInsurancePolicyTracking(
        $trackingCode,
        $nationalCode,
        $xApiKey)

Parameters

Parameter	Tags	Description
trackingCode	`Required`	شماره ی پیگیری بیمه نامه
nationalCode	`Required`	کد ملی کاربر
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$trackingCode = 213981083;
$nationalCode = 3080115309;
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $footer->getInsurancePolicyTracking($trackingCode, $nationalCode, $xApiKey);

Errors

Error Code	Error Description
500	Internal Server Error

Back to List of Controllers

InsurancePolicyPlanController

Get singleton instance

The singleton instance of the InsurancePolicyPlanController class can be accessed from the API Client.

$insurancePolicyPlan = $client->getInsurancePolicyPlan();

getSpecialPlan

دریافت لیست طرح های بیمه ای

function getSpecialPlan(
        $subDomain,
        $xApiKey)

Parameters

Parameter	Tags	Description
subDomain	`Required`	دامنه یا زیر دامنه ی مرکز بیمه
xApiKey	`Required`	کلید اختصاصی ارتباط با سرور

Example Usage

$subDomain = 'hfz1';
$xApiKey = 'd6dfd932-75d8-e911-811a-000c294ecf01';

$result = $insurancePolicyPlan->getSpecialPlan($subDomain, $xApiKey);

Back to List of Controllers

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
src		src
tests		tests
LICENSE		LICENSE
README.md		README.md
composer.json		composer.json
phpunit.xml		phpunit.xml

License

kmelodi/EasyBimehLanding_PHP

Folders and files

Latest commit

History

Repository files navigation

Getting started

How to Build

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

How to Use

1. Open Project in an IDE

2. Add a new Test Project

3. Run the Test Project

How to Test

Initialization

Class Reference

List of Controllers

FileManagerController

Get singleton instance

upload

Parameters

Example Usage

LiabilityDoctorInsuranceController

Get singleton instance

getLiabilityDoctorInsurance

Parameters

Example Usage

getMedicalSpecialties

Parameters

Example Usage

CarBodyController

Get singleton instance

getCarBrand

Parameters

Example Usage

getCarBrandTips

Parameters

Example Usage

getHasPlan

Parameters

Example Usage

ElectronicEquipmentInsuranceController

Get singleton instance

getElectronicEquipmentInsurance

Parameters

Example Usage

getDeviceBrandTypes

Parameters

Example Usage

getDiviceFranchisee

Parameters

Example Usage

OtherInsuranceTypesController

Get singleton instance

getOtherInsuranceTypes

Parameters

Example Usage

getSendSmsToken

Parameters

Example Usage

getVerifySmsToken

Parameters

Example Usage

Errors

ThirdPartyInsuranceController

Get singleton instance

getCarBrands

Parameters

Example Usage

getRiskLevel

Parameters

Example Usage

getCarBrandTips

Parameters

Example Usage

getCarUses

Parameters

Example Usage

getHasPlan

Parameters