Описание сервиса iSimpleBank для авторизации клиентов
Сервис без авторизации, работающий только внутри банка и предназначен для получения информации о клиенте iSimpleBank 2.0, который инициализировал канал в чате.
Сервис доступен с версий iSimpleBank 2.0.14.632
Передача сообщения
GET запрос на сервер, вида:
[http://[host]:[port]](http://127.0.0.1:8080/internetbank/rest/personal/notify/sms)*/rest/chat/client/id/{token}
Входные параметры в URL
| Параметр | Обязательность | Описание |
| token | да | Токен клиента, зашифроанный 1024-х битным RSA ключом |
Выходные параметры
В теле ответа application/json, который в случае успеха содержит набор полей:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| client | Блок полей | да | Блок полей клиента физического лица (внутри основного элемента) |
| id | Long | да | Идентификатор клиента в iSimpleBank 2.0 |
| name | String | да | ФИО клиента |
| surname | String | да | Фамилия |
| firstname | String | да | Имя |
| patronymic | String | да | Отчество |
| type | Long | да | Код типа клиента |
| enabled | Boolean | да | Обслуживание клиента разрешено |
| birthDate | Date | нет | Дата рождения |
| extRef | String | нет | Идентификатор клиента в АБС |
| cardRef | String | нет | Идентификатор клиента в карточном бэк |
| bankBranch | Блок полей | нет | Блок полей подразделения банка клиента (внутри блока client) |
| id | Long | нет | Идентификатор подразделения банка в iSimpleBank 2.0 |
| extRef | String | нет | Идентификатор в АБС подразделения банка |
| bik | String | нет | БИК подразделения банка |
| name | String | нет | Наименование подразделения банка |
| crmURL | String | нет | URL CRM (URL чата для клиента) |
| accountList | Массив объектов AccountInfo | нет | Список счетов |
| companyList | Массив объектов | нет | Блок полей списка организаций (внутри основного элемента). Реализовано в рамках IS-9609 — Сервис ЧАТа для сотрудников юр. лица. Не возвращается информация о клиенте по токену. |
Объект companyList
| Параметр | Тип | Описание |
|---|---|---|
| id | Long | Идентификатор организации в iSimpleBank 2.0 |
| name | String | Наименование организации |
| type | Long | Код типа организации |
| enabled | Boolean | Обслуживание организации разрешено |
| extRef | String | Код клиента в АБС |
| inn | String | ИНН |
| kpp | String | КПП |
| resident | Boolean | Признак "Нерезидент" |
| phone | String | Телефоны |
| shortName | String | Сокращенное наименование |
| internationalName | String | Международное наименование |
| ogrn | String | ОГРН |
| ogrnDate | Date | Дата ОГРН |
| internationalAddress | String | Итоговый полный международный адрес |
| accountList | Массив объектов AccountInfo | Список связанных счетов |
Объект AccountInfo
| Параметр | Тип | Описание |
| accountTypeCode | String | Код типа счета |
| accountTypeCaption | String | Наименование типа счета |
| currCode | String | Код валюты |
| currCodeIso | String | ISO-код валюты |
| account | String | Номер счета |
| contract | String | Договор |
| branchName | String | Филиал банка |
а в случае ошибки содержит набор полей
| Параметр | Тип | Обязательность | Описание |
| errorCode | String | да | Код ошибки |
| errorText | String | нет | Текст ошибки |
| stackTrace | String[] | нет | Стектрейс внутренней ошибки |
Возможные коды ошибок (errorCode)
| Код | Описание |
|---|---|
| 1000 | Невалидный токен |
| 1001 | Пользователь не найден |
| 1002 | Не настроено подключение к БД (настраивается в файле config.json) |
| 1003 | Истек срок действия токена (с версииiSimpleChatService-0.1.0) |
Пример 1 успешного вызова сервиса
**REQUEST** GET [http://127.0.0.1:8080/rest/chat/client/id/v0201a57974242d0146c280560ab0693f7550b2dbff1e33776f7505180eb4c9d7d2938de42bb49c2b9adec4dea68c5af0f037b3a0a433cafdb6542103b9093a39a7c3561f3a2a56627f74fb7893f4f03a3bee494bc98dbebe38459c68beb9eb43f2288c1203c3c861ab79bc90399e6ebbd8ce8bc5aace84bff09df0c316e5225486](http://127.0.0.1:8090/rest/chat/client/id/v0201a57974242d0146c280560ab0693f7550b2dbff1e33776f7505180eb4c9d7d2938de42bb49c2b9adec4dea68c5af0f037b3a0a433cafdb6542103b9093a39a7c3561f3a2a56627f74fb7893f4f03a3bee494bc98dbebe38459c68beb9eb43f2288c1203c3c861ab79bc90399e6ebbd8ce8bc5aace84bff09df0c316e5225486) **RESPONSE** HTTP/1.1 200 OK Answer data: {"client":{ "id":"1064775", "name":"Давыдов Юрий Викторович", "surname":"Давыдов", "firstname":"Юрий", "patronymic":"Викторович", "birthDate":"1976-03-31", "type":"0", "enabled":"true", "extRef":"1", "bankBranch":{"id":"720987","extRef":"1","bik":"042809888","name":"ЗАО КБ \"ГЛОБАЛЬНЫЙ РАСЧЕТНЫЙ ЦЕНТР\""} }}
Пример 2 ошибки вызова сервиса
**REQUEST** GET [http://127.0.0.1:8080/rest/chat/client/id/1234567890](http://127.0.0.1:8090/rest/chat/client/id/v0201a57974242d0146c280560ab0693f7550b2dbff1e33776f7505180eb4c9d7d2938de42bb49c2b9adec4dea68c5af0f037b3a0a433cafdb6542103b9093a39a7c3561f3a2a56627f74fb7893f4f03a3bee494bc98dbebe38459c68beb9eb43f2288c1203c3c861ab79bc90399e6ebbd8ce8bc5aace84bff09df0c316e5225486) **RESPONSE** HTTP/1.1 200 OK Answer data: {"errorCode":"1001","errorText":"Client not found"}
Пример 3 ошибки вызова сервиса
**REQUEST** GET [http://127.0.0.1:8080/rest/chat/client/id/1234567890](http://127.0.0.1:8090/rest/chat/client/id/v0201a57974242d0146c280560ab0693f7550b2dbff1e33776f7505180eb4c9d7d2938de42bb49c2b9adec4dea68c5af0f037b3a0a433cafdb6542103b9093a39a7c3561f3a2a56627f74fb7893f4f03a3bee494bc98dbebe38459c68beb9eb43f2288c1203c3c861ab79bc90399e6ebbd8ce8bc5aace84bff09df0c316e5225486) **RESPONSE** HTTP/1.1 400 BAD\_REQUEST Answer data: {"errorCode":"1000","errorText":"Bad client token"}
Пример 4 успешного вызова сервиса с возвратом списка из 2х компаний
**REQUEST** GET [http://127.0.0.1:8080/rest/chat/client/id/v0201a57974242d0146...f09df0c316e5225486](http://127.0.0.1:8090/rest/chat/client/id/v0201a57974242d0146c280560ab0693f7550b2dbff1e33776f7505180eb4c9d7d2938de42bb49c2b9adec4dea68c5af0f037b3a0a433cafdb6542103b9093a39a7c3561f3a2a56627f74fb7893f4f03a3bee494bc98dbebe38459c68beb9eb43f2288c1203c3c861ab79bc90399e6ebbd8ce8bc5aace84bff09df0c316e5225486) **RESPONSE** HTTP/1.1 200 OK Answer data: { "client": { "id": "124625", "name": "Царев Алексей Юрьевич", "surname": "Царев", "firstname": "Алексей", "patronymic": "Юрьевич", "birthDate": "1973-09-02", "type": "2", "enabled": "false" }, "companyList": [{ "id": "225760", "name": "ООО "УралСтройМаш"", "extRef": "561", "inn": "7701028744", "kpp": "770001001", "resident": "true", "phone": "+79093342334", "shortName": "ОАО "ЛИГА"", "internationalName": "LIGA JSC", "ogrn": "1057703026633", "ogrnDate": "2005-02-11" }, { "id": "124612", "name": "ОАО "Капитолий"", "extRef": "560", "inn": "7701058541", "kpp": "770001001", "resident": "true", "phone": "123-34-45", "shortName": "ОАО "Капитолий"", "internationalName": "CAPITOLIY JSC", "ogrn": "2801283419468", "internationalAddress": "", "regAddress": "" }], }
Пример 5 успешного вызова сервиса с возвратом списка из 1ой компании
**REQUEST** GET [http://127.0.0.1:8080/rest/chat/client/id/v0201a57974242d0146...f09df0c316e5225486](http://127.0.0.1:8090/rest/chat/client/id/v0201a57974242d0146c280560ab0693f7550b2dbff1e33776f7505180eb4c9d7d2938de42bb49c2b9adec4dea68c5af0f037b3a0a433cafdb6542103b9093a39a7c3561f3a2a56627f74fb7893f4f03a3bee494bc98dbebe38459c68beb9eb43f2288c1203c3c861ab79bc90399e6ebbd8ce8bc5aace84bff09df0c316e5225486) **RESPONSE** HTTP/1.1 200 OK Answer data: { "client": { "id": "124625", "name": "Царев Алексей Юрьевич", "surname": "Царев", "firstname": "Алексей", "patronymic": "Юрьевич", "birthDate": "1973-09-02", "type": "2", "enabled": "false" }, "companyList": [{ "id": "124612", "name": "ОАО "Капитолий"", "extRef": "560", "inn": "7701058541", "kpp": "770001001", "resident": "true", "phone": "123-34-45", "shortName": "ОАО "Капитолий"", "internationalName": "CAPITOLIY JSC", "ogrn": "2801283419468", "internationalAddress": "", "regAddress": "" }], }
Пример 6 ошибки вызова сервиса
**REQUEST** GET [http://127.0.0.1:8080/rest/chat/client/id/v0201a57974242d0146...f09df0c316e5225486](http://127.0.0.1:8090/rest/chat/client/id/v0201a57974242d0146c280560ab0693f7550b2dbff1e33776f7505180eb4c9d7d2938de42bb49c2b9adec4dea68c5af0f037b3a0a433cafdb6542103b9093a39a7c3561f3a2a56627f74fb7893f4f03a3bee494bc98dbebe38459c68beb9eb43f2288c1203c3c861ab79bc90399e6ebbd8ce8bc5aace84bff09df0c316e5225486) **RESPONSE** HTTP/1.1 401 UNAUTHORIZED Answer data: {"errorCode":"1003","errorText":"Client token expired"}