Запрос R1: Авторизация

Адрес: https://www.tws.by/tws/api/r1

Приложение дописывает к токену, полученному в R0, API Key (доступный в Виртуальном Офисе при наличии действующей подписки), и считает хэш SHA256 от полученной строки. В ответ приложение получает или Session Key, используемый во всех остальных запросах, или ошибку, если авторизоваться не удалось.

Такая схема авторизации позволяет избежать передачи API Key в открытом виде, а значит делает невозможным его перехват третьей стороной. SessionKey, полученный в результате этого запроса, имеет срок жизни (параметр ValidUntil) и после устаревания становится недействительным. Таким образом перехват API Key становится невозможным, а перехват Session Key даст неавторизованный доступ к данным только на ограниченное время.

Завершение сессии производится запросом RE.

Входные параметры

  • VirtualOfficeID – ID Виртуального Офиса. Доступен в Виртуальном Офисе при наличии действующей подписки.
  • Token – токен, полученный запросом R0.
  • Hash – хэш, рассчитанный по формуле SHA256(Token + ApiKey) – в нижнем регистре символов.

Параметры JSON-ответа

  • SessionKey – сессионный ключ, используемый во всех остальных запросах.
  • ValidUntil – срок действия сессионного ключа (YYYY-MM-DD hh:mm:ss).