Auth API — это протокол авторизации клиента, который использует сервер чата для авторизации клиента во внешней системе (CRM/ДБО).
Процесс авторизации
- Получение токена. Браузер или мобильное приложение получают или генерируют токен клиента для авторизации в чате. Токен — это любая строка. Например, это может быть токен текущей сессии.
- Передача токена в SDK. При инициализации SDK чата (виджета, мобильных SDK) браузер или мобильное приложение передает в него токен клиента.
- Запрос авторизации по токену. SDK чата отправляет запрос на авторизацию клиента на сервер чата.
- Запрос карточки клиента. Сервер чата получает токен и отправляет этот токен в сервис авторизации для авторизации клиента и получение его карточки. Сервисом авторизации может выступать CRM, ДБО и т.д.
- Возврат карточки клиента. Сервис авторизации проверяет токен клиента и возвращает карточку клиента или ошибку.
- Сохранение информации о клиенте. Сервер чата сохраняет карточку клиента локально.
- Возврат сессии авторизации в чате. Сервер чата создает сессию авторизации клиента в чате и возвращает ее в SDK.
- Авторизация клиента в SDK завершена.
Протокол сервиса авторизации
Все запросы отправляются с помощью HTTP GET запросов к REST-сервису.
Пример пути
http://[host]:[port]/rest/chat/client/id/{token}
Входные параметры в URL
Параметр | Обязательность | Описание |
token | да | Токен клиента |
Выходные параметры
В случае успешного ответа сервер возвращает статус 200 с ответом в формате 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 | нет | Полная ссылка, по которой клиента можно открыть в CRM. | |||||||||||||||||||||||||||||||||||||||||||||
| fields | map<String, String> | нет | Поля с любой дополнительной информацией о клиенте в виде название поле → значение. | |||||||||||||||||||||||||||||||||||||||||||||
companyList
| Массив объектов | нет | блок полей списка организаций (блок внутри основного элемента) |
В случае ошибки сервер возвращает статус не 200, а также может дополнительно возвращаеть описание ошибки в формате application/json в теле ответа:
Параметр | Тип | Обязательность | Описание |
errorCode | String | да | Код ошибки |
errorText | String | нет | Текст ошибки |
Примеры
Запрос:
GET http://127.0.0.1:8080/rest/chat/client/id/a57974242d0146c28056
Успешный ответ:
{
"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": "ЗАО КБ \"ГЛОБАЛЬНЫЙ РАСЧЕТНЫЙ ЦЕНТР\""
},
"fields": {
"ИНН": "1234567890"
"Город": "Москва"
}
}
}
Ответ с ошибкой:
{"errorCode":"1001","errorText":"Client not found"}
Успешный ответ со списком компаний:
{
"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": ""
}
]
}