Методы API по страховкам
Методы по страховым компаниям
Метод | URL | Описание |
---|---|---|
GET | /dicts/insurance-company | Получить список страховых компаний |
POST | /dicts/insurance-company | Создать страховую компанию |
GET | /dicts/insurance-company/ids | Получить список ID страховых компаний |
GET | /dicts/insurance-company/qty | Получить количество страховых компаний |
GET | /dicts/insurance-company/{id} | Получить программу страхования по ID |
PUT | /dicts/insurance-company/{id} | Обновить страховую компанию по ID |
DELETE | /dicts/insurance-company/{id} | Удалить страховую компанию |
GET | /dicts/insurance-company/{id}/programs | Получить все программы страхования по ID страховой компании |
Методы по программам страхования
Метод | URL | Описание |
---|---|---|
GET | /dicts/insurance-program | Получить список программ страхования |
POST | /dicts/insurance-program | Создать программу страхования |
GET | /dicts/insurance-program/ids | Получить список ID программ страхования |
GET | /dicts/insurance-program/qty | Получить количество программ страхования |
GET | /dicts/insurance-program/{id} | Получить программу страхования по ID |
PUT | /dicts/insurance-program/{id} | Обновить программу страхования по ID |
DELETE | /dicts/insurance-program/{id} | Удалить программу страхования по ID |
Методы по страховкам
Метод | URL | Описание |
---|---|---|
GET | /main/contracts/{id}/insurance | Получить объект страховки по ID контракта |
GET | /main/insurance | Получить список объектов страховки |
POST | /main/insurance | Создать объект страховки |
GET | /main/insurance/ids | Получить список ID объектов страховки |
GET | /main/insurance/qty | Получить количество объектов страховки |
GET | /main/insurance/{id} | Получить объект страховки по ID |
PUT | /main/insurance/{id} | Обновить объект страховки по ID |
DELETE | /main/insurance/{id} | Удалить объект страховки по ID |
GET | /main/loan-apps/{id}/insurance | Получить объект страховки по ID заявки |
Методы по кошельку
Метод | URL | Описание |
---|---|---|
GET | /main/insurance-accounts/find/{ids} | Найти кошельки страховки по ID |
GET | /main/insurance-accounts/qty | Получить количество кошельков страховки |
GET | /main/insurance-accounts/{id} | Получить кошелек страховки по ID |
PUT | /main/insurance-accounts/{id} | Изменить кошелек страховки по ID |
DELETE | /main/insurance-accounts/{id} | Удалить кошелек страховки по ID |
GET | /main/insurance/{id}/account | Получить кошелек страховки по ID страховки |
POST | /main/insurance/{id}/account | Создать кошелек страховки по ID страховки |
Пример добавления страховки в заявку к выданному контракту
Тестовый клиент:
- Клиент:
https://{{customerkey}}-saas.brainysoft.ru/3/main/clients/4
- Заявка:
https://{{customerkey}}-saas.brainysoft.ru/3/main/loan-apps/212
- Контракт:
https://{{customerkey}}-saas.brainysoft.ru/3/main/contracts/148
1. Создание страховки (POST)
curl --location 'https://{{customerkey}}-saas.brainysoft.ru/bs-core/main/insurance' \
--header 'Content-Type: application/json' \
--header 'customer-key: {{customerkey}}' \
--header 'bsauth: ==' \
--data '{
"loanApplicationId": 212,
"contractId": 148,
"insuranceProgramId": 2,
"amount": 350.0,
"cost": 20.0,
"creationDate": "2023-08-24T19:44:33.000Z",
"expirationDate": "2023-09-24T19:44:33.000Z",
"includeInLoanAmount": false,
"signed": false,
"type": "LifeInsurance"
}'
Далее после создания нужно задать НОМЕР (
code
) страховки. В брейнисофт номер генерируется только при создании контракта, поэтому генерацию номера на новую страховку выданному контракту нужно будет задавать самостоятельно на стороне ЛК.Так же нужно подцепить поле
contractId
, так как оно при создании страховки не заполняется (только при редактировании).
2. Обновление страховки (PUT)
curl --location 'https://{{customerkey}}-saas.brainysoft.ru/bs-core/main/insurance/67309' \
--header 'Content-Type: application/json' \
--header 'customer-key: {{customerkey}}' \
--header 'bsauth: ==' \
--data '{
"id": 67309,
"loanApplicationId": 212,
"insuranceAccountId": null,
"contractId": 148,
"insuranceProgramId": 2,
"amount": 350.0,
"cost": 20.0,
"creationDate": "2023-08-24T19:44:33.000Z",
"expirationDate": "2023-09-24T19:44:33.000Z",
"code": "123456",
"includeInLoanAmount": false,
"premium": 0.0,
"smsCode": "",
"signed": false,
"signDate": 1692819873000,
"newExpirationDate": null,
"terminationDate": null,
"type": "LifeInsurance"
}'
Параметры по сумме (
amount
), вознаграждению (cost
), типу страховки (type
) можно посмотреть по текущим страховкам соответствующей программы (insuranceProgramId
).Программ страхования (
insuranceProgram
) всего 5 в справочнике, посмотреть к какому типу (type
) должна относиться страховка, можно задав запросGET
'https://{{customerkey}}-saas.brainysoft.ru/bs-core/dicts/insurance-program'
.
3. Создание кошелька для страховки (POST)
Далее созданной страховке нужно создать КОШЕЛЁК – это аналог контракта, но только для страховки. По этому кошельку с нашей стороны будет привязываться ДДС с суммой и номером удачно списанного рекуррентного платежа.
curl --location 'https://{{customerkey}}-saas.brainysoft.ru/bs-core/main/insurance/67309/account' \
--header 'Content-Type: application/json' \
--header 'customer-key: {{customerkey}}' \
--header 'bsauth: =='''
Ответ
{
"status": "ok",
"timestamp": 1692883330826,
"data": {
"id": 90331,
"name": "",
"creationDate": "2023-08-24",
"issueDate": null,
"closeDate": null,
"branchId": 101301,
"subdivisionId": 101791,
"clientId": 4,
"contractLine": {
"id": 90331,
"lineLimit": null
},
"contractTypeId": 101916,
"createUserId": 1026,
"createSubdivisionId": 101791,
"relatedInsuranceId": 67309
}
}