Импорт пользователя (реализация на стороне TQM)

Авторизация

Тип авторизации — Basic (API Key).

При вызове методов интеграционного API через хедер Authorization передается значение Basic {credentials}, где credentials — это ключ доступа к TQM, полученный в личном кабинете.

Пример значения, которое нужно передать — Basic UuMlW1BUJzVsUM7Q.

Описание метода

Метод позволяет загружать новых пользователей.

• URL запроса — https://tqm-cloud.tbank.ru/integration
• Метод запроса — POST /import/user

Запрос

Параметр	Тип	Обязательность	Описание
id	string	true	ID пользователя, не больше 100 символов.
firstName	string	false	Имя пользователя, не больше 256 символов.
middleName	string	false	Отчество пользователя, не больше 256 символов.
lastName	string	true	Фамилия пользователя, не больше 256 символов.
email	string	true	Почтовый электронный адрес пользователя, не больше 256 символов.
organizationalUnitId	string	false	ID орг. юнита (отдел или группа) пользователя, не больше 100 символов.
roleId	string	true	ID роли пользователя. Передавайте цифру, которая соответствует роли: 2 — агент; 3 — супервайзер; 4 — менеджер; 10 — контролер качества; 17 — помощник администратора.
apiVersion	string	false	Версия используемого API.

Ответ

Код ответа	Значение	Описание
200	OK	Варианты ответа: created — создан; updated — обновлен; error — ошибка при создании или обновлении данных пользователя.
400	Bad Request	Ошибка валидации.
401	Unauthorized	Ошибка авторизации.
403	Forbidden	Ошибка доступа к материалу.
500	Internal Server Error	Внутренняя ошибка сервера. Означает, что при выполнении метода произошел внутренний сбой. Обратитесь в техническую поддержку — чтобы упростить поиск причины ошибки, в обращении укажите заголовок ответа x-correlation-id.