...
- Получение токена. Браузер или мобильное приложение получают или генерируют токен клиента для авторизации в чате. Токен — это любая строка. Например, это может быть токен текущей сессии.
- Передача токена в SDK. При инициализации SDK чата (виджета, мобильных SDK) браузер или мобильное приложение передает в него токен клиента.
- Запрос авторизации по токену. SDK чата отправляет запрос на авторизацию клиента на сервер чата.
- Запрос карточки клиента. Сервер чата получает токен и отправляет этот токен в сервис авторизации для авторизации клиента и получение его карточки. Сервисом авторизации может выступать CRM, ДБО и т.д.
- Возврат карточки клиента. Сервис авторизации проверяет токен клиента и возвращает карточку клиента или ошибку.
- Сохранение информации о клиенте. Сервер чата сохраняет карточку клиента локально.
- Возврат сессии авторизации в чате. Сервер чата создает сессию авторизации клиента в чате и возвращает ее в SDK.
- Авторизация клиента в SDK завершена.
Запрос
Все запросы отправляются Запросы можно отправлять с помощью одного из HTTP GET запросов методов к REST-сервису: GET или POST.
При этом в случае с методом GET - токен содержится в URL-запроса, при использовании метода POST - токен передается в параметре header.
Пример запроса GET
http://[host]:[port]/rest/chat/client/id/{token}Входные параметры в URL
Параметр | Обязательность | Описание |
token | да | Токен клиента |
Пример запроса POST
http://[host]:[port]/rest/chat/client/id/Элемент | Обязательность | Где передается | Описание |
token | да | header | Токен клиента |
Ответ
Response
В случае успешного ответа сервер возвращает статус 200 с ответом в формате application/json.
...
Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
id | LongString | да | Идентификатор клиента в CRM (Master ID) |
name | String | да | ФИО клиента |
surname | String | да | Фамилия |
firstname | String | да | Имя |
patronymic | String | да | Отчество |
type | String ("0", "1") | да | Код типа клиента |
enabled | Boolean | да | Обслуживание клиента разрешено |
birthDate | String ("YYYY-MM-DD") | нет | Дата рождения |
extRef | String | нет | Идентификатор клиента в АБС |
cardRef | String | нет | Идентификатор клиента в карточный системе (ДКБО ID) |
bankBranch | Branch | нет | Информация о подразделении клиента |
crmURL | String | нет | Полная ссылка, по которой клиента можно открыть в CRM. |
inn | String | нет | ИНН клиента. |
shortName | String | нет | Краткое наименование клиента. |
| accountNumbers | String | да | Номера счета клиента. Данное поле не сохраняется в карточке клиента и храниться только в рамках открытого обращения |
| positionStream | Boolean | да | Новый портфель, значение для PositionStream (true/false) |
| betaUser | Boolean | да | Флаг "бета пользователь" (true/false) |
| lvlClient | String | да | Сервисный уровень клиента, приоритет обслуживания |
| timezone | String | да | Часовой пояс на устройстве клиента |
| osVersion | String | да | Версия ОС устройства |
| device | String | да | Тип устройства |
| deviceVersion | String | да | Версия приложения |
fields | Map<String, String> | нет | Deprecated, нужно использовать fieldList Поля с дополнительной информацией о клиенте в виде название поле → значение. |
fieldList | List<Field> | нет | Поля с дополнительной информацией о клиенте, при отображении в интерфейсе оператора учитывается порядок полей. |
| contacts | Contacts | нет | Информация о контактах клиента для информирования оператора и выстраивания омниканальных связей |
| secretWord | String | нет | Кодовое слово, которое операторы или бот используют для ручной идентификации клиента |
| group | List<Group> | нет | Информация о группах клиентов для версии iQPro. |
Branch
Информация о филиале обслуживания клиента..
...
Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
id | LongInteger | да | Идентификатор организации во внешней системе |
name | String | нет | Наименование организации |
type | LongString | нет | Код типа организации |
enabled | Boolean | нет | Обслуживание организации разрешено |
extRef | String | нет | Код организации в главной учетной системе (например АБС) |
inn | String | ИНН | |
kpp | String | КПП | |
resident | Boolean | Признак "Нерезидент" | |
phone | String | Телефоны | |
shortName | String | Сокращенное наименование | |
internationalName | String | Международное наименование | |
ogrn | String | ОГРН | |
ogrnDateDate | String ("YYYY-MM-DD") | Дата ОГРН | |
internationalAddress | String |
...
- В типе Client добавлено поле contacts.
- В типе Client добавлено поле secretWord.
- В типе Client добавлено поле group.
- Добавлен тип Contacts.
- Добавлен тип Group.
Версия 1.3
- Добавлена возможность использовать протокол AUTH с методом POST.
- В типе Client добавлено поле accountNumbers.
- В типе Client добавлено поле positionStream.
- В типе Client добавлено поле betaUser.
В типе Client добавлено поле lvlClient.
- В типе Client добавлено поле timezone.
- В типе Client добавлено поле osVersion.
- В типе Client добавлено поле device.
- В типе Client добавлено поле deviceVersion.