Аутентификация - Сценарии ExtSdk2

Для получения доступа к методам API требуется аутентифицироваться. Количество активных сессий у пользователя и аккаунта ограничено, поэтому Вам нужно аккуратно подойти к вопросу аутентификации. Например, не нужно аутентифицироваться перед каждым запросом.

СБИС поддерживает несколько способов аутентификации (по логину паролю, по сертификату), все они равнозначные и Вы можете воспользоваться любым из них. В результате успешной аутентификации Вы получите строку с идентификатором сессии, которую нужно сохранить и использовать при работе с API до тех пор пока не получите ошибку аутентификации.

Общая стратегия аутентификации следующая – Если у Вас есть сохраненный идентификатор сессии, то начинаете работу – делаете вызовы. Методы аутентификации Вы вызываете, если у Вас нет идентификатора сессии или если вы получили ошибку аутентификации.

В некоторых случаях, например при первом запуске или перед отправкой большого количества документов иногда возникает желание (для упрощения алгоритма) проверить действителен ли идентификатор сессии, для этого можно использовать метод ReadCurrentUserInfo. Который в случае если сессии не действительна, так же как и остальные методы вернет ошибку аутентификации

После получения COM-объекта и подключения к модулю ExtSdk2 мы можем перейти к методам авторизации. Более детальное описание находится в сценарии Подключение к ExtSdk2 через OLE. Для любой авторизации стоит использовать методы COM-объекта CallMethodWithoutAuth или CallMethodWithoutAuthXML, если параметры передаются в формате xml.

Аутентификация по логину паролю

Авторизация по логину паролю выполняется с использованием метода AuthByPassword, принимающего логин и пароль в качестве параметров.

Пример кода для авторизации по логину паролю

    ole = win32com.client.Dispatch("Tensor.SbisPluginClientCOM")

    query_id = str(uuid.uuid4())
    module_method = "ExtSdk2.AuthByPassword"
    parameters_module_method = json.dumps({"Login": "login", "Password": "password"}, ensure_ascii=True)
    host = online.sbis.ru

    ole.CallMethodWithoutAuth( query_id, guid_module, module_method, parameters_module_method, host )

    xml_string = ole.ReadAllXml2()
    events = XmlJsonSerializer.decode(xml_string)

Пример успешной авторизации по логину паролю

Параметры запроса в CallMethodWithoutAuth

{
   "Login": "Иванов",
   "Password": "123"
}

Ответ

{
  'Result': '********@plugin.sbis.ru',
  'Stat': {
    'ExtSdk2': {
      'ExtSdk2.AuthByPassword': {
        'count': 2,
        'time': 0
      }
    }
  }
}

где '********@plugin.sbis.ru' в Result это идентификатор сессии, с которым в последующем необходимо вызывать остальные методы модуля ExtSdk2 через методы COM-объекта CallMethod и CallMethodXML

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

Для аутентификации по сертификату пользователю сначала нужно показать список сертификатов подходящих для аутентификации. Получить такой список можно при помощи метода ReadCertListForAuth.

После того как пользователь выбрал сертификат для аутентификации вызывается метод AuthByCert, принимающий отпечаток сертификата, по которому хотим авторизоваться.

Пример кода для авторизации по сертификату

    ole = win32com.client.Dispatch("Tensor.SbisPluginClientCOM")

    query_id = str(uuid.uuid4())
    module_method = "ExtSdk2.AuthByCert"
    parameters_module_method = json.dumps({"Imprint": "Отпечаток сертификата"}, ensure_ascii=True)
    host = online.sbis.ru

    ole.CallMethodWithoutAuth( query_id, guid_module, module_method, parameters_module_method, host )

    xml_string = ole.ReadAllXml2()
    events = XmlJsonSerializer.decode(xml_string)

Пример успешной авторизации по сертификату

Параметры запроса в CallMethodWithoutAuth

{
   "Imprint": "Строка в 40 знаков",
}

Ответ

{
  'Result': '********@plugin.sbis.ru',
  'Stat': {
    'CryptoPlugin': {
      'CryptoPlugin.ParseCertificate': {
        'count': 1,
        'time': 5
      },
      'CryptoPlugin.StoreCertificate': {
        'count': 1,
        'time': 1
      }
    },
    'ExtSdk2': {
      'ExtSdk2.AuthByCert': {
        'count': 2,
        'time': 3732
      }
    }
  }
}

где '********@plugin.sbis.ru' в Result это идентификатор сессии, с которым в последующем необходимо вызывать остальные методы модуля ExtSdk2 через методы COM-объекта CallMethod и CallMethodXML

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

Для авторизации по токену необходимо сначала получить токен от администратора интересующего аккаунта.

После получения токена вызывается метод AuthByToken.

Пример кода для авторизации по токену

    ole = win32com.client.Dispatch("Tensor.SbisPluginClientCOM")

    query_id = str(uuid.uuid4())
    module_method = "ExtSdk2.AuthByToken"
    parameters_module_method = json.dumps({"Token": "токен"}, ensure_ascii=True)
    host = online.sbis.ru

    ole.CallMethodWithoutAuth( query_id, guid_module, module_method, parameters_module_method, host )

    xml_string = ole.ReadAllXml2()
    events = XmlJsonSerializer.decode(xml_string)

Пример успешной авторизации по токену

Параметры запроса в CallMethodWithoutAuth

{
   "Token": "taMjS16IMM3RMWg0STDD0UBRDc0CN5TVnjQbIoZT6NdtUbAtkLZ4lTVYhJYRx5IMzR3wlNEYEMSm1M5sMNjWjfuA3QpZjMkht57DWqntTNj2UkMTpSuE4FEF",
}

Ответ

{
  'Result': '********@plugin.sbis.ru',
  'Stat': {
    'ExtSdk2': {
      'ExtSdk2.AuthByToken': {
        'count': 2,
        'time': 0
      }
    }
  }
}

где '********@plugin.sbis.ru' в Result это идентификатор сессии, с которым в последующем необходимо вызывать остальные методы модуля ExtSdk2 через методы COM-объекта CallMethod и CallMethodXML

Двухфакторная аутентификация

Если у пользователя настроена двухфакторная аутентификация вы получите ошибку вида ExtException

{
  'code': 303,
  'detail': 'Требуется подтверждение действия',
  'dump': {
    'MethodToValidate': 'САП.AuthenticateExPart2',
    'ResourceID': '3a23a986-3b0f-4763-89a5-519f7da8a271',
    'SessionID': '00610413-006104f7-eeba-fbd5a09730f7eaba'
  },
  'message': 'Требуется подтверждение действия',
  'method_name': 'AuthByPassword',
  'stack': [
    {
      'dump': {
        'MethodToValidate': 'САП.AuthenticateExPart2',
        'ResourceID': '3a23a986-3b0f-4763-89a5-519f7da8a271',
        'SessionID': '00610413-006104f7-eeba-fbd5a09730f7eaba'
      },
      'method_name': 'AuthByPassword'
    }
  ]
}

Нас интересует dump ошибки, из которого нужно взять все три поля.

Далее следует вызвать метод AuthSendCode, принимающий на вход ResourceID и SessionID и возвращающий ResourceID, который следует сравнить с имеющимся.

Пример кода для AuthSendCode

     def test_auth_send_code(self):
        query_id = self.plugin.call_method("CallMethodWithoutAuth", "ExtSdk2.AuthSendCode", json.dumps(
            {"ResourceID": "3a23a986-3b0f-4763-89a5-519f7da8a271", "SessionID": 00610413-006104f7-eeba-fbd5a09730f7eaba}, ensure_ascii=True))
        result2 = self.plugin.read_all_xml([query_id])

Пример успешного вызова AuthSendCode

{
   "ResourceID": "3a23a986-3b0f-4763-89a5-519f7da8a271",
   "SessionID": "00610413-006104f7-eeba-fbd5a09730f7eaba"
}

Ответ

{
  'Result': '3a23a986-3b0f-4763-89a5-519f7da8a271',
  'Stat': {
    'ExtSdk2': {
      'ExtSdk2.AuthByToken': {
        'count': 2,
        'time': 0
      }
    }
  }
}

В Result лежит исходный ResourceID

При успешном выполнении AuthSendCode и получении кода аутентификации по SMS необходимо вызвать метод AuthConfirmCode, принимающий json-объект с кодом, ResourceID и MethodToValidate, который будет вызван в последствии.

Пример кода для AuthConfirmCode

     def test_auth_confirm_code(self):
        """Авторизация с правильным сертификатом"""
        query_id = self.plugin.call_method("CallMethodWithoutAuth", "ExtSdk2.AuthConfirmCode", json.dumps(
            {"Param": { "Код": "пришедший код", "Идентификатор": "3a23a986-3b0f-4763-89a5-519f7da8a271", "ВызываемыйМетод": "САП.AuthenticateExPart2" } }, ensure_ascii=True))
        result2 = self.plugin.read_all_xml([query_id])

Пример успешного вызова AuthConfirmCode

{
   "Param": {
      "Код": "пришедший код",
      "Идентификатор": "3a23a986-3b0f-4763-89a5-519f7da8a271",
      "ВызываемыйМетод": "САП.AuthenticateExPart2"
   }
}

Ответ

{
  'Result': '********@plugin.sbis.ru',
  'Stat': {
    'ExtSdk2': {
      'ExtSdk2.AuthConfirmCode': {
        'count': 2,
        'time': 0
      }
    }
  }
}

где '********@plugin.sbis.ru' в Result это идентификатор сессии, с которым в последующем необходимо вызывать остальные методы модуля ExtSdk2 через методы COM-объекта CallMethod и CallMethodXML