| Statustoc |
|---|
| Info |
|---|
...
|
...
| |
API доступно только при наличии модуля "IQChannels – API. Auth.C" или "IQChannels – API. Auth.B" или "IQChannels – iSimpleCorporate" или "IQChannels – iSimpleRetail" |
Auth API — это протокол авторизации клиента, который использует сервер чата для авторизации клиента во внешней системе (CRM/ДБО или другой учетной системе).toc
Для авторизации юридических и физических лиц используется единое API, при этом минимальный атрибутный состав API будет обрабатываться только при наличие соответствующего модуля (например companyList обрабатывается только при наличии модуля "IQChannels – API. Auth.B" или "IQChannels – iSimpleCorporate").
Протокол авторизации
- Получение токена. Браузер или мобильное приложение получают или генерируют токен клиента для авторизации в чате. Токен — это любая строка. Например, это может быть токен текущей сессии.
- Передача токена в SDK. При инициализации SDK чата (виджета, мобильных SDK) браузер или мобильное приложение передает в него токен клиента.
- Запрос авторизации по токену. SDK чата отправляет запрос на авторизацию клиента на сервер чата.
- Запрос карточки клиента. Сервер чата получает токен и отправляет этот токен в сервис авторизации для авторизации клиента и получение его карточки. Сервисом авторизации может выступать CRM, ДБО и т.д.
- Возврат карточки клиента. Сервис авторизации проверяет токен клиента и возвращает карточку клиента или ошибку.
- Сохранение информации о клиенте. Сервер чата сохраняет карточку клиента локально.
- Возврат сессии авторизации в чате. Сервер чата создает сессию авторизации клиента в чате и возвращает ее в SDK.
- Авторизация клиента в SDK завершена.
...
Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
client | Client | нет | Информация о клиенте |
companyList | List<Company> | нет | Список организаций, к которым относится текущий клиент. (Только для модулей "IQChannels – API. Auth.B" и "IQChannels – iSimpleCorporate") |
errorCode | String | нет | Код ошибки |
errorText | String | нет | Текст ошибки |
...
Поле | Тип | Обязательное | Комментарий |
|---|---|---|---|
id | String | да | Идентификатор клиента в CRM (Master ID) |
| contract | String | да | Номер генерального соглашения, соглашений может быть несколько, передавать через запятую |
| telSysClientId | String | нет | Идентификатор клиента в системе телефонии |
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. |
...