Руководство прикладного разработчика#

      # Протокол передачи данных HTTP/HTTPS
      nsi.cloud.server.protocol=HTTP
      # Имя хоста, на котором предоставляется API
      nsi.cloud.server.host=nsi-ift.no-ingress.apps.dev-gen.maindomain.mycompany.ru
      # Порт
      nsi.cloud.server.port=80
      # Timeout подключения, мс
      nsi.cloud.server.connectTimeout=5000
      # Timeout обмена данными, мс
      nsi.cloud.server.readTimeout=5000

      @Configuration
      @Import(sbp.com.sbt.nsi.cloud.client.config.WebClientConfiguration.class)
      public class MyConfig {
      }

<dependency>
  <groupId>sbp.com.sbt.nsi.cloud</groupId>
  <artifactId>nsi-cloud-api</artifactId>
  <version>{nsi-cloud-version}</version>
</dependency>

<dependency>
  <groupId>sbp.com.sbt.cdm.ora</groupId>
  <artifactId>ekpit-model</artifactId>
  <version>{ekpit-model-version}</version>
</dependency>

<dependency>
      <groupId>sbp.com.sbt.nsi.cloud</groupId>
      <artifactId>nsi-cloud-client</artifactId>
      <version>{nsi-cloud-version}</version>
</dependency>

# Протокол передачи данных HTTP/HTTPS
nsi.cloud.server.protocol=HTTP
# Имя хоста, на котором предоставляется API
nsi.cloud.server.host={NSI_HOST} 
# Порт
nsi.cloud.server.port=80
# Тайм-аут подключения, мс
nsi.cloud.server.connectTimeout=5000
# Тайм-аут обмена данными, мс
nsi.cloud.server.readTimeout=5000

@Configuration
@Import(sbp.com.sbt.nsi.cloud.client.config.WebClientConfiguration.class)
public class MyConfig {
}

--add-opens=java.base/java.util=ALL-UNNAMED
--add-opens=java.base/java.lang=ALL-UNNAMED

import com.sbt.cdm.domain.ora.ekpit.RspitVersionDictionary
import sbp.com.sbt.nsi.cloud.api.DictionaryService;

// ...

@Autowired
DictionaryService dictService;

// ...

List<RspitVersionDictionary> dicts = dictService.getDictionaryRecords(RspitVersionDictionary.class, null, 0);
dicts.stream().map(RspitVersionDictionary::getDictionaryName).forEach(log::info);

import sbp.com.sbt.nsi.cloud.api.DictionaryService;
import sbp.com.sbt.nsi.cloud.dto.Field;
import sbp.com.sbt.nsi.cloud.dto.Fields;


import com.sbt.cdm.domain.ora.ekpit.Currency;  // класс справочника в модели ЕКПиТ

// ...

@Autowired
DictionaryService dictService;

// ...

Currency currency = dictService.getRecordById(Currency.class, "666");
log.info(currency == null ? "Такой валюты нет" : ("Код валюты: " + currency.getCode()));

import sbp.com.sbt.nsi.cloud.api.DictionaryService;
import sbp.com.sbt.nsi.cloud.dto.Field;
import sbp.com.sbt.nsi.cloud.dto.Fields;


import com.sbt.cdm.domain.ora.ekpit.Currency;  // класс справочника в модели ЕКПиТ

// ...

@Autowired
DictionaryService dictService;

// ...

String hql = "select c.digitalCode as code, c.nameRus as name from Currency c where c.digitalCode between '800' and '899'";
List<Currency> currencies = dictService.getRecordsByHql(Currency.class, hql, 10, 0);
currencies.stream().forEach(f -> log.info("Code: {}, Name: {}", c.getCode(), c.getName()));

import sbp.com.sbt.nsi.cloud.api.DictionaryService;
import sbp.com.sbt.nsi.cloud.dto.Field;
import sbp.com.sbt.nsi.cloud.dto.Fields;

// ...

@Autowired
DictionaryService dictService;

// ...

String hql = "select c.digitalCode as code, c.nameRus as name from Currency c where c.digitalCode between '800' and '899'";
List<Fields> fieldsList = dictService.getFieldsByHql(hql, 10, 0);
fieldsList.stream().forEach(f -> log.info("Code: {}, Name: {}", f.get("code"), f.get("name()));

try {
// вызываем API фасада
} catch (RestClientException e) {
logger.error("Не удалось вызвать API фасада", e);
} catch (NsiApiCallException e) {
logger.error("API фасада вернул ошибку", e);
logger.error(e.getApiError());
}

curl -i -X POST -H 'Content-Type: application/json' -d '{"configuredLevel": "DEBUG"}' http://localhost:8081/actuator/loggers/org.springframework.web

# Включение внутреннего кеширования (по умолчанию false)
nsi.cloud.client.cache.enabled=true
# Спецификация групп кешей
nsi.cloud.client.cache.specification=maximumWeight=20000000
# Периодичность опроса об обновлении справочников, мс (по умолчанию 60000)
nsi.cloud.client.cache.update.delay=60000

Content-Type=text/plain;charset=UTF-8
Content-Type=application/json;charset=UTF-8

GET /sbp.com.sbt.nsi.cloud.api.DictionaryService/{dictionary}?offset={offset}&limit={limit}

[
  {
    "type": null,
    "kind": null,
    "shortCode": "017",
    "fullCode": "544229017",
    "tbCode": "54",
    "osbCode": "4229",
    "vspCode": "017",
    "statReportCode": "0544229017",
    "casNsiCode": "544229017",
    "headDivision": [
      {
        "__dictionary": "Division",
        "objectId": "16017"
      }
    ],
    "fullName": "Доп.офис №4229/017",
    "individualName": null,
    "openDate": null,
    "closeDate": "2012-10-11T00:00:00",
    "status": null,
    "changePlanDate": "2012-10-11T00:00:00",
    "modificationAttributes": null,
    "addInformation": null,
    "requisites": null,
    "contacts": [],
    "format": [],
    "reformats": [],
    "addresses": [
      {
        "__dictionary": "SFSLegalAddress",
        "objectId": "33910000"
      }
    ],
    "temporaryLocations": [],
    "serving": null,
    "servingWindows": [],
    "operationModes": [],
    "selfServiceDevices": [],
    "facilities": [],
    "overallCount": null,
    "headcount": [],
    "workplaces": [],
    "businessCharacteristicValues": [],
    "successors": [],
    "resubordination": null,
    "multimediaInformation": [],
    "recordId": "33910",
    "objectId": "33910",
    "lastChangeDate": "2019-07-16T12:48:02.674",
    "ownerId": "cdm-ora-ekpit",
    "recModelVersion": null,
    "isDeleted": false,
    "sourceId": null,
    "sourceSystemId": null
  },
  {
    "type": null,
    "kind": null,
    "shortCode": "01760",
    "fullCode": "55663701760",
    "tbCode": "55",
    "osbCode": "6637",
    "vspCode": "01760",
    "statReportCode": "055663701760",
    "casNsiCode": "55663701760",
    "headDivision": [
      {
        "__dictionary": "Division",
        "objectId": "18640",
      }
    ],
    "fullName": "Доп.офис №6637/01760",
    "individualName": null,
    "openDate": "2008-12-25T00:00:00",
    "closeDate": "2010-12-29T00:00:00",
    "status": null,
    "changePlanDate": "2010-12-29T00:00:00",
    "modificationAttributes": null,
    "addInformation": null,
    "requisites": null,
    "contacts": [],
    "format": [],
    "reformats": [],
    "addresses": [
      {
        "__dictionary": "SFSLegalAddress",
        "objectId": "33936000",
      }
    ],
    "temporaryLocations": [],
    "serving": null,
    "servingWindows": [],
    "operationModes": [],
    "selfServiceDevices": [],
    "facilities": [],
    "overallCount": null,
    "headcount": [],
    "workplaces": [],
    "businessCharacteristicValues": [],
    "successors": [],
    "resubordination": null,
    "multimediaInformation": [],
    "recordId": "33936",
    "objectId": "33936",
    "lastChangeDate": "2019-07-16T12:48:02.596",
    "ownerId": "cdm-ora-ekpit",
    "recModelVersion": null,
    "isDeleted": false,
    "sourceId": null,
    "sourceSystemId": null
  }
]

GET /sbp.com.sbt.nsi.cloud.api.DictionaryService/{dictionary}/byCode/{code}
GET /sbp.com.sbt.nsi.cloud.api.DictionaryService/{dictionary}/byId/{objectId}

{
  "type": null,
  "kind": null,
  "shortCode": "4229",
  "fullCode": "544229",
  "tbCode": "54",
  "osbCode": "4229",
  "vspCode": null,
  "statReportCode": "0544229",
  "casNsiCode": "544229",
  "headDivision": [
    {
      "__dictionary": "Division",
      "objectId": "14807"
    }
  ],
  "fullName": "Кваркенское отделение №4229",
  "individualName": null,
  "openDate": null,
  "closeDate": "2012-10-11T00:00:00",
  "status": null,
  "changePlanDate": "2012-10-11T00:00:00",
  "modificationAttributes": null,
  "addInformation": null,
  "requisites": null,
  "contacts": [],
  "format": [],
  "reformats": [],
  "addresses": [
    {
      "__dictionary": "SFSLegalAddress",
      "objectId": "16017000"
    }
  ],
  "temporaryLocations": [],
  "serving": null,
  "servingWindows": [],
  "operationModes": [],
  "selfServiceDevices": [],
  "facilities": [],
  "overallCount": null,
  "headcount": [],
  "workplaces": [],
  "businessCharacteristicValues": [],
  "successors": [],
  "resubordination": null,
  "multimediaInformation": [],
  "recordId": "16017",
  "objectId": "16017",
  "lastChangeDate": "2019-07-16T12:47:14.371",
  "ownerId": "cdm-ora-ekpit",
  "recModelVersion": null,
  "isDeleted": false,
  "sourceId": null,
  "sourceSystemId": null
}

POST /sbp.com.sbt.nsi.cloud.api.DictionaryService/{dictionary}/hql?offset={offset}&limit={limit}

Content-Type: text/plain;charset=UTF-8
select d 
from Division d where d.fullCode = '99'

Content-Type: application/json;charset=UTF-8
 
{
  "hql": "select d from Division d where d.fullCode = '99'",
  "limit": 10,
  "offset": 0
}

POST /sbp.com.sbt.nsi.cloud.api.DictionaryService/{dictionary}/hql/fields?offset={offset}&limit={limit}

Content-Type: text/plain;charset=UTF-8
 
select
    d.fullCode as code,
    d.fullName,
    d.openDate,
    h as head_division
from Division d join d.headDivision h
where h.fullCode = '99'

Content-Type: application/json;charset=UTF-8
 
{
  "hql": "select p.code as code1, p.name as name1 from OrganizationBadge p",
  "limit": 10,
  "offset": 0
}

[
  [
    {
      "alias": "code",
      "type": "java.lang.String",
      "value": "38"
    },
    {
      "type": "java.lang.String",
      "value": "Московский банк"
    },
    {
      "type": "java.util.Date",
      "value": null
    },
    {
      "alias": "head_division",
      "type": "Division",
      "value": "137"
    }
  ],
  [
    {
      "alias": "code",
      "type": "java.lang.String",
      "value": "99909901"
    },
    {
      "type": "java.lang.String",
      "value": "Опер.офис №9099/01"
    },
    {
      "type": "java.util.Date",
      "value": "2010-06-01T00:00:00"
    },
    {
      "alias": "head_division",
      "type": "Division",
      "value": "137"
    }
  ]
]

$ curl -s --request POST --url $TURL'/sbp.com.sbt.nsi.cloud.api.DictionaryService/ClientInvestProfile/hql/fields?offset=0&limit=1' --header 'Content-Type: application/json;charset=UTF-8' --data-raw '{"hql":"select name, recordId, description, code from ClientInvestProfile cip where cip.profileId like '\''%15%'\''"}' | json_pp

{
"jsonrpc": "2.0",
"id": "123",                                   <- ID запроса, генерируется фабрикой
"method": "getProductsByName",    
"params": {
"name": "Депозит Классический Онлайн",       <- наименование продукта
"parametersTypeCodes" : [                    <- коды типов параметров, которые нужно получить (опционально)
"crashRateDUL", "durationDUL", "summaDUL"
],
"servicesTypeCodes": [                       <- коды типов шаблонов (опционально)
"DulRecallDepositContractService",
"DulAdjunctionDepositContractService"
]
}
}

{
"jsonrpc": "2.0",
"id": "123",
"result": [
{
"objectId": "6100000",
"name": "Депозит Классический Онлайн",
"code": "CLASSIC_DEPOSIT_ONLINE",
"beginDate": "2017-01-01T00:00:00",
"endDate": null,
"productDescription": {
"description": "Депозит Классический Онлайн"
},
"parameters": [
{
"name": null,
"paramType": {
"code": "summaDUL"
},
"value": null,
"accessValues": [
{
"itemNum": 643,
"startValue": null,
"endValue": "99999999.99",
"value": null
},
{
"itemNum": 840,
"startValue": null,
"endValue": "9999999.99",
"value": null
}
]
},
{
"name": null,
"paramType": {
"code": "durationDUL"
},
"value": null,
"accessValues": [
{
"itemNum": 1,
"startValue": "7",
"endValue": "1096",
"value": null
}
]
}
],
"services": [
{
"type": {
"code": "DulAdjunctionDepositContractService"
}
},
{
"type": {
"code": "DulRecallDepositContractService"
}
}
]
}
]
}

{
"jsonrpc": "2.0",
"id": 1,
"method": "getProductsByCodes",
"params": {
"productCodes": [
"RECALLABLE_DEPOSIT_ONLINE_PLUS_IP"
]
}
}

select OT.code, count(PR.object_Id)
      from d_ekpit_product PR
      join d_ekpit_objecttype OT On PR.type_id = OT.object_id
      where OT.code in ('LegalDeposit', 'LegalNso') -- коды типов продуктов
      and COALESCE(PR.SYS_ISDELETED,0) = 0
      group by OT.code;

select OT.code, count(RV.object_Id)
from d_ekpit_ratevalue RV
join d_ekpit_templaterate RT On RV.rate_id = RT.object_id
join d_ekpit_objecttype OT On RT.type_id = OT.object_id
where OT.code in ('LegalEntityTransferFeeRateType', 'LoroProductInterimStatementProvidingFeeRate', 'LoroCommission', 'LoroProductProcessingFeeRate', 'LoroProductOpeningFeeRate', 'LoroProductAccountCertificateProvidingFeeRate', 'LoroProductAccountTurnoverReportProvidingFeeRate', 'LoroProductPaperTransferFeeRate', 'LoroProductStatementDeliveryFeeRate', 'PaymentDetailsClarificationFeeRateType', 'LoroProductDocumentDuplicateIssueFeeRate', 'TransactionsReportCompilationFeeRateType', 'SupportingDocumentCopyPreparingAttestingFeeRate', 'LoroProductAccountDebitConfirmationFeeRate', 'LegalEntityTransferCancellationFeeRate', 'SignatureAndSealCardRegistrationFeeRateType', 'LoroProductInterestRate') -- коды типов ставок
and COALESCE(RV.SYS_ISDELETED,0) = 0
group by OT.code;

select OT.code, count(RV.object_Id)
from d_ekpit_ratevalue RV
join d_ekpit_templaterate RT On RV.rate_id = RT.object_id
join d_ekpit_objecttype OT On RT.type_id = OT.object_id
where OT.code in ('PublicRateDul', 'DulCeilingRate') -- коды типов ставок
and COALESCE(RV.SYS_ISDELETED,0) = 0
group by OT.code;

select OT.code, count(PR.object_Id)
from d_ekpit_product PR
join d_ekpit_objecttype OT On PR.type_id = OT.object_id
where OT.code in ('LegalDeposit', 'LegalNso') -- коды типов продуктов
and COALESCE(PR.SYS_ISDELETED,0) = 0
group by OT.code;

select OT.code, count(RV.object_Id)
from d_ekpit_ratevalue RV
join d_ekpit_templaterate RT On RV.rate_id = RT.object_id
join d_ekpit_objecttype OT On RT.type_id = OT.object_id
where OT.code in ('PublicRateDul', 'DulCeilingRate') -- коды типов ставок
and COALESCE(RV.SYS_ISDELETED,0) = 0
group by OT.code;

select OT.code, count(RV.object_Id)
from d_ekpit_ratevalue RV
join d_ekpit_templaterate RT On RV.rate_id = RT.object_id
join d_ekpit_objecttype OT On RT.type_id = OT.object_id
where OT.code in ('LegalEntityTransferFeeRateType', 'LoroProductInterimStatementProvidingFeeRate', 'LoroCommission', 'LoroProductProcessingFeeRate', 'LoroProductOpeningFeeRate', 'LoroProductAccountCertificateProvidingFe eRate', 'LoroProductAccountTurnoverReportProvidingFeeRate', 'LoroProductPaperTransferFeeRate', 'LoroProductStatementDeliveryFeeRate', 'PaymentDetailsClarificationFeeRateType', 'LoroProductDocumentDuplicateIssueFeeRate', 'TransactionsReportCompilationFeeRateType', 'SupportingDocumentCopyPreparingAttestingFeeRate', 'LoroProductAccountDebitConfirmationFeeRate', 'LegalEntityTransferCancellationFeeRate', 'SignatureAndSealCardRegistrationFeeRateType', 'LoroProductInterestRate') -- коды типов ставок
and COALESCE(RV.SYS_ISDELETED,0) = 0
group by OT.code;

GET {{SERVICE}}/health/sayOk


GET {{SERVICE}}/health/sayOk

HTTP/1.1 200
Content-Length: 0
Keep-Alive: timeout=60
Connection: keep-alive

<Response body is empty>

Response code: 200; Time: 17ms; Content length: 0 bytes

GET {{SERVICE}}/health/readiness

HTTP/1.1 200
timeBeforeLogout: 7196
timeoutValue: 7200
Content-Length: 0
Keep-Alive: timeout=60
Connection: keep-alive

<Response body is empty>

Response code: 200; Time: 22ms; Content length: 0 bytes

HTTP/1.1 500
Content-Length: 0
Connection: close

<Response body is empty>

Response code: 500; Time: 11076ms; Content length: 0 bytes

@ApiLib
public interface DepartmentsApiService {

    /**
     * Получение подразделения по objectId
     * @param objectId objectId подразделения
     * @return подразделение, если найдено и единственно
     */
    @ApiMethod(name = "getByObjectId", major = 1, minor = 0)
    Departments getByObjectId(@JsonRpcParam("objectId") @NotNull String objectId);

    /**
     * Получение подразделений по списку objectId
     * @param objectIds список objectId подразделений
     * @return список подразделений
     */
    @ApiMethod(name = "getByObjectIds", major = 1, minor = 0)
    List<Departments> getByObjectIds(@JsonRpcParam("objectIds") @NotNull List<String> objectIds);

    /**
     * Получение подразделения по полному коду
     * @param subdivisionCode полный код подразделения
     * @return подразделение, если найдено и единственно
     */
    @ApiMethod(name = "getBySubdivisionCode", major = 1, minor = 0)
    Departments getBySubdivisionCode(@JsonRpcParam("subdivisionCode") @NotNull String subdivisionCode);

    /**
     * Получение подразделения по branch
     * @param branch branch подразделения
     * @return подразделение с максимальной датой закрытия
     */
    @ApiMethod(name = "getByBranch", major = 1, minor = 0)
    Departments getByBranch(@JsonRpcParam("branch") @NotNull String branch);

    /**
     * Ищет подразделения, не закрытые на дату закрытия по полным кодам.
     * @param vdate версионная дата
     * @param subdivisionCode код подразделения
     * @param operDay операционный день. Если null, то ставится последняя полночь
     * @return открытые на операционный день подразделения
     */
    @ApiMethod(name = "getDepartmentBySubdivisionCode", major = 1, minor = 0)
    List<Department> getDepartmentBySubdivisionCode(@JsonRpcParam("vdate") @Nullable Date vdate,
                                                    @JsonRpcParam("subdivisionCode") @NotNull String subdivisionCode,
                                                    @JsonRpcParam("operDay") @Nullable Date operDay);

    /**
     * Ищет подразделения, не закрытые на дату закрытия по полным кодам.
     * @param vdate версионная дата
     * @param subdivisionCodes список кодов подразделений
     * @param dtClose дата, после которой может быть закрыто подразделение
     * @return открытые на дата закрытия подразделения
     */
    @ApiMethod(name = "getDepartmentsIdsBySubdivisionCodeAndDtClosed", major = 1, minor = 0)
    Set<String> getDepartmentsIdsBySubdivisionCodeAndDtClosed(@JsonRpcParam("vdate") @Nullable Date vdate,
                                                              @JsonRpcParam("subdivisionCodes") @NotNull Set<String> subdivisionCodes,
                                                              @JsonRpcParam("dtClose") @NotNull Date dtClose);

    /**
     * Ищет открытые на операционный день подразделения по полному коду.
     * Если для данного полного кода подразделение закрыто, то поиск продолжается по кодам подразделений правопреемников.
     * @param subdivisionCode код подразделения
     * @param operDay операционный день. Если null, то ставится последняя полночь
     * @return открытые на операционный день подразделения
     */
    @ApiMethod(name = "getDepartmentOrSuccessorBySubdivisionCode", major = 1, minor = 0)
    List<Department> getDepartmentOrSuccessorBySubdivisionCode(@JsonRpcParam("subdivisionCode") @NotNull String subdivisionCode,
                                                               @JsonRpcParam("operDay") @Nullable Date operDay);
}

// ...
@Autowired
DepartmentsApiService departmentsApiService;

// ...
Departments departments = departmentsApiService.getBySubdivisionCode("38");

@ApiLib
public interface ProductionCalendarService {

    /**
     * Метод получения производственного календаря, по коду региона
     * @param regionCode код региона
     */
    @ApiMethod(name = "findProductionCalendarByRegionCode", major = 1, minor = 0)
    List<ProductionCalendar> findProductionCalendarByRegionCode(@JsonRpcParam("regionCode") @NotNull String regionCode);

    /**
     * Метод получения производственного календаря, по коду календаря
     * @param code полный код календаряs
     */
    @ApiMethod(name = "findProductionCalendarByCode", major = 1, minor = 0)
    List<ProductionCalendar> findProductionCalendarByCode(@JsonRpcParam("code") @NotNull String code);

    /**
     * Метод получения дат производственного календаря по его коду
     * @param code код календаря
     */
    @ApiMethod(name = "findProductionCalendarDateByCode", major = 1, minor = 0)
    List<ProductionCalendarDate> findProductionCalendarDateByCode(@JsonRpcParam("code") @NotNull String code);

    /**
     * Возвращает Holidays по iso2country
     * @param iso2country
     */
    @ApiMethod(name = "getHolidaysByIso2country", major = 1, minor = 0)
    List<Holidays> getHolidaysByIso2country(@JsonRpcParam("iso2country") @NotNull String iso2country);

    /**
     * Метод возвращает список iso2country по всем Holidays
     */
    @ApiMethod(name = "getHolidaysIso2countries", major = 1, minor = 0)
    List<String> getHolidaysIso2countries();
}

POST {{SERVICE}}/sbp.com.sbt.nsi.cloud.api.DictionaryService/RspitVersionDictionary/hql/fields
Accept: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8

{
  "hql": "select r.dictionaryName as dictionaryName, r.version as version from RspitVersionDictionary r where r.dictionaryName in ('ClientType', 'Departments')",
  "limit": 2,
  "offset": 0
}