API ПФП
Обмен данными осуществляется посредством POST-запросов вида https://budgetform.appspot.com/api/v1?doc=%DOC%&auth=%AUTH%&event=%EVENT%, где
- %DOC% и %AUTH% – авторизационные параметры, зависящие от базы, к которой происходит обращение;
- %EVENT% – вызываемый метод (см. ниже).
Обмен данными производится в JSON-формате.
Методы
Метод firstRun
Аргумент – объект Customer; результат – объект FirstRunResponse.
Customer
Параметр | Тип | Описание |
---|---|---|
key | String | Уникальный ключ клиента в базе Process Insight; назначается бекэндом при создании нового клиента |
lastName | String | Фамилия |
firstName | String | Имя |
secondName | String | Отчество |
birthDate | Date | Дата рождения |
gender | String | Пол (MALE, FEMALE) |
spouse | Customer | Супруг(а) |
children | List | дети |
monthlyIncome | Number | Месячный доход |
monthlyPayments | Number | Месячные платежи |
currentAccumulation | Number | Накопления |
riskProfile | String | Риск-профиль (CONSERVATIVE, BALANCED, AGGRESSIVE) |
Person
Параметр | Тип | Описание |
---|---|---|
key | String | Уникальный ключ клиента в базе Process Insight; назначается бекэндом при создании нового клиента |
lastName | String | Фамилия |
firstName | String | Имя |
secondName | String | Отчество |
birthDate | Date | Дата рождения |
FirstRunResponse
Параметр | Тип | Описание |
---|---|---|
customerKey | String | Присвоенный бекэндом уникальный ключ клиента |
targets | List | Цели |
Target
Параметр | Тип | Описание |
---|---|---|
key | String | Ключ (уникальный идентификатор) цели |
type | String | Тип (PENSION, EDUCATION, OTHER, HEALTH, REAL_ESTATE) |
name | String | Наименование |
months | Integer | Количество месяцев |
cost | Number | Стоимость |
initialCapital | Number | Начальный капитал |
initialReplenishment | Number | |
portfolio | Portfolio | |
potentialYield | Number | |
costWithInflation | Number | |
taxDeductionIIS | Number | Налоговый вычет ИИС |
taxDeductionNSG | Number | Налоговый вычет НСЖ |
costRaising | List | |
capitalRaising | List | |
loanRepayment | List | |
tool | Tool | |
tools | List |
Portfolio
Параметр | Тип | Описание |
---|---|---|
key | String | Ключ (уникальный идентификатор) |
targetYearsMin | Integer | |
targetYearsMax | Integer | |
conservativeLine | PortfolioLine | |
balancedLine | PortfolioLine | |
aggressiveLine | PortfolioLine |
PortfolioLine
Параметр | Тип | Описание |
---|---|---|
potentialYield | Number | |
toolsInitialCapital | Map<Long, Double> | |
toolsReplenishmentCapital | Map<Long, Double> |
Tool
Параметр | Тип | Описание |
---|---|---|
key | String | Ключ |
id | Integer | |
name | String | Наименование |
description | String | Описание |
maxTaxDeduction | Number |
Метод calcTarget
Аргумент – объект CalcTargetRequest; результат – объект Target.
CalcTargetRequest
Параметр | Тип | Описание |
---|---|---|
customerKey | String | ключ клиента |
target | Target | Цель для обсчёта |
riskProfile | String | Риск-профиль (CONSERVATIVE, BALANCED, AGGRESSIVE) |
Метод updatePortfolio
Обновление портфеля.
Аргумент – объект CreatePortfolioRequest; результат – объект Portfolio.
CreatePortfolioRequest
Параметр | Тип | Описание |
---|---|---|
name | String | Наименование |
className | String | |
portfolio | Portfolio |
Метод updateClient
Обновление информации о клиенте.
Аргумент – объект Customer; результат – объект Customer.
Метод updateTool
Создание / обновление инструмента. Если запрос не содержит параметр key, то создаётся новый инструмент; если запрос содержит key, то обновляется инструмент.
Аргумент – объект ToolRequest; результат – объект ToolRequest.
ToolRequest
Параметр | Тип | Описание |
---|---|---|
key | String | Ключ инструмента |
id | Integer | |
name | String | Наименование |
Метод getClient
Возвращает информацию по клиенту.
Аргумент – объект KeyRequest; результат – объект Customer.
KeyRequest
Параметр | Тип | Описание |
---|---|---|
key | String | ключ |
Метод getClients
Возвращает массив всех клиентов ArrayList
Метод getPortfolio
Возвращает информацию о портфеле.
Аргумент – объект KeyRequest; результат – объект Portfolio.
Метод getPortfolios
Возвращает массив всех портфелей List
Метод getTool
Возвращает информацию об инструменте.
Аргумент – KeyRequest; результат – объект Tool.
Метод getTools
Возвращает массив всех инструментов List
Метод getTargets
Возвращает массив всех целей клиента.
Аргумент – KeyRequest; результат – List
Метод deleteTarget
Удаление цели с пересчётом оставшихся целей клиента.
Аргумент – KeyRequest; результат – Сообщение “OK”.
Метод getAgents
Получение всех агентов
Результат – List
Объект Agent
Параметр | Тип | Описание |
---|---|---|
key | String | Ключ агента (идентификатор Process Insight |
id | String | Идентификатор агента во внешней системе |
fio | String | ФИО агента |
phone | String | Телефон |
String |
Метод getAgent
Возвращает информацию об агенте.
Аргумент – KeyRequest; результат – объект Agent.
Метод updateAgent
Создаёт нового агента (если key не указан) или изменяет информацию по существующему агенту (если указан key).
Аргумент – объект Agent; результат – объект Agent.