Перейти к содержанию

Авторизация

Общие положения

Endpoint: /api/Accounts/login

Для авторизации агента используется стандарт JWT (rfc7519).

Агент обращается к сервису авторизации для получения JWT-токена.

JWT-токен ограничен по сроку жизни и действует 24 часа, по истечении которых JWT-токен запрашивается повторно.

Примечание:

Срок жизни JWT-токен может быть фактически меньше регламентного времени в случае отзыва (блокировки) токена.

Получение токена

Для получения токена используется метод Auth, описанный в XSD-схеме Mixvel_Auth.xsd (входит в комплект документации)

В запросе передаются параметры:

  • Login

  • Password

  • StructureUnitId (Идентификатор структурного подразделения, задается в Личном Кабинете) на основании которых осуществляется идентификация агента.

Допускается работа агента одновременно с несколькими разными Login одновременно.

StructureUnitId получается из Кабинета агентства MixVel из настроек Подразделения с вкладки «Данные» и имеет следующий формат:

%Код агента Mixvel%_%Уникальный идентификатор Подразделения%, где:

Код агента: порядковый номер агента в MixVel в диапазоне: [1..99999] (от 1 до 99999 включительно).

Уникальный идентификатор Подразделения: набор латинских букв от A до Z, без буквы O, может содержать цифры от 0-9.

Пример:

12345_MNPQR

Порядок получения и управления логина приложения описан в разделе 

Аутентификация по JWT токену

Для работы со всеми методами веб-сервиса MixVel агент передает в заголовке HTTP-запроса полученный через метод Auth JWT-токен.

Веб-сервис осуществляет валидацию JWT-токена и либо авторизует операцию, либо возвращает соответствующую ошибку.

Пример сообщения

Запрос

<?xml version="1.0" encoding="UTF-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
 <Header/>
  <Body id="ID1">
   <MessageInfo MessageId="0d92db5d-e830-46ff-8af0-9eb4bae192a9" TimeSent="2025-01-01T00:00:01Z"/>
    <AppData>
     <a:Auth xmlns:a="https://www.mixvel.com/API/XSD/mixvel_auth/1_01">
       <Login>testUser.auth@mixvel.com</Login>
       <Password>passWord1!</Password>
       <StructureUnitID>12036_ALPHA</StructureUnitID>
     </a:Auth>
    </AppData>
  </Body>
</MixEnv:Envelope>

Ответ

<?xml version="1.0" encoding="UTF-8"?>
<MixEnv:Envelope xmlns:MixEnv="https://www.mixvel.com/API/XSD/mixvel_envelope/1_06">
 <Header/>
  <Body id="ID1">
    <MessageInfo MessageId="703423d1-595c-49f5-98c2-5dcabe950276" ReplyTo="79b67a26-6fc3-41e3-8ac4-14e0ac0245c8" TimeSent="2025-01-01T00:00:01Z"/>
    <AppData>
      <auth:AuthResponse xmlns:auth="https://www.mixvel.com/API/XSD/mixvel_auth/1_01">
      <Token>eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlRlc3QgQWdlbnQiLCJleHAiOjE2MDYzMTI4MDAsImlhdCI6MTYwNjMwOTIwMH0.xTPifj6i5Bf_Wl6sw6nOLL3jHDk-DeRozjv3YeuMFUphbkA9-NVqiPEs_7frD_ZVPEoXnoBNgBEc9sr8S53o5w</Token>
      </auth:AuthResponse>
    </AppData>
  </Body>
</MixEnv:Envelope>