Аутентификация и авторизация (API версия 2) - История изменений

Administrator в 08:03, 6 февраля 2024

2024-02-06T08:03:03Z

← Предыдущая		Версия 08:03, 6 февраля 2024
Строка 65:		Строка 65:
	{		{
	"code": 412,		"code": 412,
	"message": "~~Некоректні дані користувача~~. ~~Перевірте коректність введених даних і спробуйте ще раз~~."		"message": "Некорректные данные пользователя. Проверьте корректность введенных данных и повторите попытку."
	}		}
	</pre>		</pre>

Administrator в 07:18, 6 февраля 2024

2024-02-06T07:18:00Z

← Предыдущая		Версия 07:18, 6 февраля 2024
Строка 86:		Строка 86:
	}		}
	</pre>		</pre>



	== Обновление просроченного token-а == <!--T:8-->		== Обновление просроченного token-а == <!--T:8-->

Administrator в 07:10, 6 февраля 2024

2024-02-06T07:10:23Z

← Предыдущая		Версия 07:10, 6 февраля 2024
Строка 60:		Строка 60:
	<!--T:7-->		<!--T:7-->
	В случае указания неправильного имени пользователя или пароля, вы получите следующий ответ		В случае указания неправильного имени пользователя или пароля, вы получите следующий ответ
	* Status Code: ~~401 Unauthorized~~		* Status Code: 412 Precondition Failed
	* Body:		* Body:
	<pre>		<pre>
	{		{
	"code": ~~401~~,		"code": 412,
	"message": {		"message": "Некоректні дані користувача. Перевірте коректність введених даних і спробуйте ще раз."
	~~"status": "401 Unauthorized~~",
	"~~message": "Bad credentials, please verify that your login/password are correctly set"~~
	}
	}		}
	</pre>		</pre>

Administrator в 06:44, 6 февраля 2024

2024-02-06T06:44:35Z

← Предыдущая		Версия 06:44, 6 февраля 2024
Строка 50:		Строка 50:
	добавив при этом в headers<br>		добавив при этом в headers<br>
	<pre>		<pre>
	Authorization: Bearer eyJ0eXAiOiJKV1Q...~~<br>~~		Authorization: Bearer eyJ0eXAiOiJKV1Q...
	</pre>		</pre>
	Где в '''''Authorization''''' после ключевого слова Bearer нужно передать полученный выше '''''token'''''.		Где в '''''Authorization''''' после ключевого слова Bearer нужно передать полученный выше '''''token'''''.

Administrator: Отметить эту версию для перевода

2021-06-04T08:14:15Z

Отметить эту версию для перевода

← Предыдущая		Версия 08:14, 4 июня 2021
Строка 21:		Строка 21:


			<!--T:2-->
	Обязательно отправляйте заголовок '''''Content-Type''''':		Обязательно отправляйте заголовок '''''Content-Type''''':
	<pre>		<pre>
Строка 27:		Строка 28:


			<!--T:3-->
	На отправленный запрос будет получен ответ в json-формате:		На отправленный запрос будет получен ответ в json-формате:
	<pre>		<pre>
Строка 36:		Строка 38:
	</pre>		</pre>

			<!--T:4-->
	из которого необходимо извлечь поля<br>		из которого необходимо извлечь поля<br>
	'''''token''''' – токен, потребуется для авторизации при выполнении последующих запросов, имеет срок действия<br>		'''''token''''' – токен, потребуется для авторизации при выполнении последующих запросов, имеет срок действия<br>
	'''''refresh_token''''' – токен, который потребуется потребуется для последующего обновления поля token, после окончания его срока действия<br><br>		'''''refresh_token''''' – токен, который потребуется потребуется для последующего обновления поля token, после окончания его срока действия<br><br>

			<!--T:5-->
	Например, для поиска детали по артикулу OC90, посылаем следующий запрос:		Например, для поиска детали по артикулу OC90, посылаем следующий запрос:
	<pre>		<pre>
Строка 52:		Строка 56:


	== Ошибка аутентификации ==		== Ошибка аутентификации == <!--T:6-->

			<!--T:7-->
	В случае указания неправильного имени пользователя или пароля, вы получите следующий ответ		В случае указания неправильного имени пользователя или пароля, вы получите следующий ответ
	* Status Code: 401 Unauthorized		* Status Code: 401 Unauthorized
Строка 87:		Строка 92:


	== Обновление просроченного token-а ==		== Обновление просроченного token-а == <!--T:8-->

			<!--T:9-->
	В случае окончания срока действия token-а, вы получите следующий ответ		В случае окончания срока действия token-а, вы получите следующий ответ
	* Status Code: 401 Unauthorized		* Status Code: 401 Unauthorized
Строка 110:		Строка 116:
	</pre>		</pre>

			<!--T:10-->
	Где:<br>		Где:<br>
	'''''refresh_token''''' – рефреш токен полученный ранее.<br>		'''''refresh_token''''' – рефреш токен полученный ранее.<br>
	'''''browser_fingerprint''''' – подпись браузера, строка должна быть аналогичная той которая использовалась при авторизации.<br>		'''''browser_fingerprint''''' – подпись браузера, строка должна быть аналогичная той которая использовалась при авторизации.<br>

			<!--T:11-->
	На отправленный запрос будет получен ответ в json-формате:		На отправленный запрос будет получен ответ в json-формате:
	<pre>		<pre>

Administrator: Новая страница: « Для получения доступа к API, необходимо выполнить вход в свою учетную...»

2021-06-04T08:13:07Z

Новая страница: «<languages/> <translate>  Для получения доступа к API, необходимо выполнить вход в свою учетную...»

Новая страница

<languages/>
<translate>

Для получения доступа к API, необходимо выполнить вход в свою учетную запись, выполнив POST запрос на URI
<pre>
https://order24-api.utr.ua/api/login_check
</pre>
Передав в теле запроса логин, пароль и подпись браузера, например:
<pre>
{
"email":"test@mail.ua",
"password":"mysecretpassword",
"browser_fingerprint": "some-unique-key-here"
}
</pre>

Где: 
'''''email''''' – логин пользователя 
'''''password''''' – пароль пользователя 
'''''browser_fingerprint''''' – подпись браузера, для API используйте любую уникальную строку длиной не более 128 символов. Мы, например, используем хеш md5(); 

Обязательно отправляйте заголовок '''''Content-Type''''':
<pre>
Content-Type: application/json
</pre>

На отправленный запрос будет получен ответ в json-формате:
<pre>
{
"token": "eyJ0eXAiOiJKV1Q...",
"expires_at": "2020-01-17 15:04:50",
"refresh_token": "2a3bb84af9a3..."
}
</pre>

из которого необходимо извлечь поля 
'''''token''''' – токен, потребуется для авторизации при выполнении последующих запросов, имеет срок действия 
'''''refresh_token''''' – токен, который потребуется потребуется для последующего обновления поля token, после окончания его срока действия 

Например, для поиска детали по артикулу OC90, посылаем следующий запрос:
<pre>
https://order24-api.utr.ua/api/search/oc90
</pre>
добавив при этом в headers 
<pre>
Authorization: Bearer eyJ0eXAiOiJKV1Q... 
</pre>
Где в '''''Authorization''''' после ключевого слова Bearer нужно передать полученный выше '''''token'''''.

== Ошибка аутентификации ==

В случае указания неправильного имени пользователя или пароля, вы получите следующий ответ
* Status Code: 401 Unauthorized
* Body:
<pre>
{
"code": 401,
"message": {
"status": "401 Unauthorized",
"message": "Bad credentials, please verify that your login/password are correctly set"
}
}
</pre>
В случае отсутствия Authorization или отсутствия ключевого слова Bearer, вы получите следующий ответ
* Status Code: 401 Unauthorized
* Body:
<pre>
{
"code": 401,
"message": "JWT Token not found"
}
</pre>
В случае указания неправильного Authorization вы получите следующий ответ
* Status Code: 401 Unauthorized
* Body:
<pre>
{
"code": 401,
"message": "Invalid JWT Token"
}
</pre>

== Обновление просроченного token-а ==

В случае окончания срока действия token-а, вы получите следующий ответ
* Status Code: 401 Unauthorized
* Body:
<pre>
{
"code": 401,
"message": "Expired JWT Token"
}
</pre>
Для обновления значения просроченного token-а необходимо выполнить запрос POST запрос на URI
<pre>
https://order24-api.utr.ua/api/token/refresh
</pre>
передав в теле запроса значение '''''refresh_token''''', полученный ранее:
<pre>
{
"refresh_token": "2a3bb84af9a3...",
"browser_fingerprint": "some-unique-key-here"
}
</pre>

Где: 
'''''refresh_token''''' – рефреш токен полученный ранее. 
'''''browser_fingerprint''''' – подпись браузера, строка должна быть аналогичная той которая использовалась при авторизации. 

На отправленный запрос будет получен ответ в json-формате:
<pre>
{
"token": "eyJ0eXAiOiJKV1Q...",
"expires_at": "2020-01-17 15:14:50",
"refresh_token": "2a3bb84af9a3..."
}
</pre>
При отсутствии или указании неверного значения '''''refresh_token''''', вы получите следующий ответ
* Status Code: 401 Unauthorized
* Body:
<pre>
{
"code": 401,
"message": {
"status": "401 Unauthorized",
"message": "Bad credentials, please verify that your login/password are correctly set"
}
}
</pre>

</translate>