Процесс авторизации в шлюзе: различия между версиями

Текущая версия на 01:42, 7 сентября 2021

Реквизиты для авторизации

Параметры для авторизации приходят в письме, которое подтверждает успешную обработку заявки на подключение к Ветис.API. В письме содержатся следующие данные:

login - логин для авторизации в security-слое.
password - пароль для авторизации в security-слое.

Для того, чтобы получить доступ к шлюзу, необходимо пройти авторизацию в security-слое (HTTP-авторизацию) с использованием логина и пароля. Пара логин-пароль выдается одна на информационную систему.

APIKey - уникальный ключ, однозначно идентифицирующий информационную систему в шлюзе. Выдаётся один на одну информационную систему.
issuerID - уникальный идентификатор хозяйствующего субъекта или ветеринарного управления, работающего через указанную информационную систему. Является уникальным идентификатором организации (хозяйствующего субъекта или ветеринарного управления) в реестре РСХН.

Через одну информационную систему может работать несколько организаций и тогда им будет выдан один APIKey и множество IssuerID. Связка APIKey - IssuerID идентифицирует подключающегося к шлюзу хозяйствующего субъекта или ветеринарное управление. Эта авторизация происходит непосредственно в шлюзе и обеспечивает доступ к приложениям.

Сценарий подключения к шлюзу

При подключении к шлюзу пользователь проходит трех этапную авторизацию. Процесс авторизации изображён на рис. 1.

Первый этап - авторизация в security-слое с использованием логина и пароля, указанных в письме в разделе с APIKey и issuerId. Это HTTP-авторизация и в случае, если она не пройдена, доступ к шлюзу не будет открыт.
Второй этап - авторизация непосредственно в самом шлюзе с использованием APIKey и IssuerID. В ходе этого процесса происходит удостоверение в подлинности информационной системы и хозяйствующего субъекта, который через неё работает.
Третий этап - авторизация в приложении (сервисе) с использованием логина пользователя, зарегистрированного в ВетИС. Это должен быть либо логин ветеринарного врача, либо, для некоторых операций (не выписки ВСД), логин пользователя ХС. По сути, это уже не работа со шлюзом, а работа с приложением через шлюз. Хозяйствующий субъект может получить реквизиты доступа к системе, обратившись в Территориальное управление Россельхознадзора. Логин идентифицирует пользователя, который производит операции в приложении. Кроме того, именно от имени этого пользователя будут выданы ветеринарные сертификаты.

Рис. 1. Процесс авторизации в универсальном шлюзе Ветис.API

Список типичных ошибок при авторизации

Ошибка и сообщение	Причина
401 Unauthorized. The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.46) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization failed.	Пользователь шлюза не прошёл первичную авторизацию в security-слое. Причины могут быть следующие: Не указаны логин и пароль, требуемые для авторизации. Они приходят в письме вместе с apiKey и IssuerID. Логин и/или пароль указаны неверно. Необходимо проверить правильность идентифкационных данных.
Указан некорректный ключ доступа к интеграционному шлюзу.	Неверно указан apiKey. Необходимо проверить, насколько правильно его скопировали из письма.
Доступ запрещен для комбинации указанных ключа доступ и идентификатора заявителя.	Неверно указан issuerID. Необходимо проверить правильность указанного issuerID.
Ошибка авторизации в приложении.	Пользователь с указанным логином не найден в списке пользователей.

@@ Строка 1: / Строка 1: @@
-=Реквизиты для авторизации=
+==Реквизиты для авторизации==
-Параметры для авторизации приходят в письме, которое подтверждает успешную обработку заявки на подключение к Ветис.API. В письме обычно содержатся следующие данные:
-* '''APIKey''' - уникальный ключ, однозначно идентифицирующий информационную систему в шлюзе. Выдаётся один на одну информационную систему.
-* '''issuerID''' - уникальный идентификатор хозяйствующего субъекта, работающего через указанную информационную систему. Является уникальным идентификатором в реестре РСХН.
-Через одну информационную систему может работать несколько хозяйствующих субъектов и тогда будет выдан один APIKey и множество IssuerID. Связка APIKey-IssuerID идентифицирует подключающегося к шлюзу хозяйствующего субъекта. Эта авторизация происходит непосредственно в шлюзе и обспечивает доступ к приложениям. которые потребут собственной авторизации.
+Параметры для авторизации приходят в письме, которое подтверждает успешную обработку заявки на подключение к Ветис.API. В письме содержатся следующие данные:
 * '''login''' - логин для авторизации в security-слое.
 * '''password''' - пароль для авторизации в security-слое.
-Авторизация в security-слое (HTTP-авторизация) --- первая из трёх в цепочке авторизаций. Необходима для того, чтобы получить доступ к шлюзу.
+Для того, чтобы получить доступ к шлюзу, необходимо пройти авторизацию в security-слое (HTTP-авторизацию) с использованием логина и пароля. Пара логин-пароль выдается одна на информационную систему.
+* '''APIKey''' - уникальный ключ, однозначно идентифицирующий информационную систему в шлюзе. Выдаётся один на одну информационную систему.
+* '''issuerID''' - уникальный идентификатор хозяйствующего субъекта или ветеринарного управления, работающего через указанную информационную систему. Является уникальным идентификатором организации (хозяйствующего субъекта или ветеринарного управления) в реестре РСХН.
+Через одну информационную систему может работать несколько организаций и тогда им будет выдан один APIKey и множество IssuerID. Связка '''APIKey - IssuerID''' идентифицирует подключающегося к шлюзу хозяйствующего субъекта или ветеринарное управление. Эта авторизация происходит непосредственно в шлюзе и обеспечивает доступ к приложениям.
-=Сценарий подключения к шлюзу=
+==Сценарий подключения к шлюзу==
-Процесс авторизации изображён на рисунке.
+При подключении к шлюзу пользователь проходит трех этапную авторизацию. Процесс авторизации изображён на рис. 1.
-[[Файл:ConnectToGate.png]]
-* Первый этап авторизации - авторизация в security-слое с помощью присланных в письме логина  и пароля. Это HTTP-авторизация и в случае, если она не пройдена, доступ к шлюзу не будет открыт.
+* Первый этап  - авторизация в security-слое с использованием логина  и пароля, указанных в письме в разделе с APIKey и issuerId. Это HTTP-авторизация и в случае, если она не пройдена, доступ к шлюзу не будет открыт.
-* Второй этап авторизации - авторизация в самом шлюзе. В ходе этого процесса происходит удостоверение в подлинности информационной системы и хозяйствующего субъекта, который через неё работает.
+* Второй этап  - авторизация непосредственно в самом шлюзе с использованием APIKey и IssuerID. В ходе этого процесса происходит удостоверение в подлинности информационной системы и хозяйствующего субъекта, который через неё работает.
-* Третий этап авторизации - в приложении (сервисе). По сути, это уже не работа со шлюзом, а работа с приложением через шлюз. Логин пользователь может получить в региональном управлении ветеринарии. Логин идентифицирует пользователя, который производит операции в приложении. Кроме того, именно подпись этого пользователя будет отображаться в ветеринарных сертификатах.
+* Третий этап  - авторизация в приложении (сервисе) с использованием логина пользователя, зарегистрированного в ВетИС. Это должен быть либо логин ветеринарного врача, либо, для некоторых операций (не выписки ВСД), логин пользователя ХС. По сути, это уже не работа со шлюзом, а работа с приложением через шлюз. Хозяйствующий субъект может получить реквизиты доступа к системе, обратившись в Территориальное управление Россельхознадзора. Логин идентифицирует пользователя, который производит операции в приложении. Кроме того, именно от имени этого пользователя будут выданы ветеринарные сертификаты.
-=Список типичных ошибок при авторизации =
-{| class="wikitable"
+[[Image:ConnectToGate.png|center|frame|Рис. 1. Процесс авторизации в универсальном шлюзе Ветис.API]]
+==Список типичных ошибок при авторизации ==
+{| class="wikitable"  width:75%}.
 |-
 ! Ошибка и сообщение !! Причина
 |-
 | 401 Unauthorized. The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.46)
-containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field
+containing a challenge applicable to the requested resource.
-(section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization failed. || Пользователь шлюза не прошёл первичную авторизацию в security-слое. Причины могут быть следующие:
+The client MAY repeat the request with a suitable Authorization header field
+(section 14.8). If the request already included Authorization credentials,
+then the 401 response indicates that authorization failed.
+|| Пользователь шлюза не прошёл первичную авторизацию в security-слое. Причины могут быть следующие:
 * Не указаны логин и пароль, требуемые для авторизации. Они приходят в письме вместе с apiKey и IssuerID.
 * Логин и/или пароль указаны неверно. Необходимо проверить правильность идентифкационных данных.
@@ Строка 37: / Строка 44: @@
 | Ошибка авторизации в приложении. || Пользователь с указанным логином не найден в списке пользователей.
 |}
+[[Category: Ветис.API]]

Процесс авторизации в шлюзе: различия между версиями

Текущая версия на 01:42, 7 сентября 2021

Реквизиты для авторизации

Сценарий подключения к шлюзу

Список типичных ошибок при авторизации

Навигация

Поиск