ElyBy-Mirror/docs
1
0
Fork 0
mirror of https://github.com/elyby/docs.git synced 2024-11-26 16:52:04 +05:30
Code Issues Packages Projects Releases Wiki Activity

Resolves #4. Fix oauth user's info code example. Fix capitalized parameters names in the minecraft-auth article

Browse Source
This commit is contained in:
ErickSkrauch 2020-04-10 16:27:24 +03:00
parent 4aebf1a446
commit 6e015fe318
No known key found for this signature in database
GPG Key ID: 669339FCBB30EE0E
3 changed files with 12 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/en/oauth.rst
View File

@ -215,7 +215,7 @@ To send ``access_token``, the ``Authorization`` header is used with the value of
$accessToken = 'some_access_token_value'; $accessToken = 'some_access_token_value';
$curl = curl_init(); $curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://account.ely.by/api/oauth2/v1/token'); curl_setopt($curl, CURLOPT_URL, 'https://account.ely.by/api/account/v1/info');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, [ curl_setopt($curl, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $accessToken, 'Authorization: Bearer ' . $accessToken,

33
source/ru/minecraft-auth.rst
View File

@ -59,13 +59,9 @@ accessToken для игрового клиента Minecraft. Важно пон
Непосредственная авторизация пользователя, используя его логин (ник или e-mail) и пароль. Непосредственная авторизация пользователя, используя его логин (ник или e-mail) и пароль.
Входные параметры: :param string username: Никнейм пользователя или его e-mail (более предпочтительно).
:param string password: Пароль пользователя.
:username: Никнейм пользователя или его e-mail (более предпочтительно). :param string clientToken: Уникальный токен лаунчера пользователя.
:password: Пароль пользователя.
:clientToken: Уникальный токен лаунчера пользователя.
Успешный ответ: Успешный ответ:
@ -93,11 +89,8 @@ accessToken для игрового клиента Minecraft. Важно пон
Обновляет валидный accessToken. Этот запрос позволяет не хранить на клиенте его пароль, а оперировать только сохранённым Обновляет валидный accessToken. Этот запрос позволяет не хранить на клиенте его пароль, а оперировать только сохранённым
значением accessToken для практически бесконечной возможности проходить авторизацию. значением accessToken для практически бесконечной возможности проходить авторизацию.
Входные параметры: :param string accessToken: Уникальный ключ, полученый после авторизации.
:param string clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken.
:accessToken: Уникальный ключ, полученый после авторизации.
:clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken.
.. note:: В оригинальном протоколе так же передаётся значение selectedProfile, но на деле от него мало что зависит и .. note:: В оригинальном протоколе так же передаётся значение selectedProfile, но на деле от него мало что зависит и
для идентификации пользователя достаточно только этих двух параметров. Наш сервер не обидится, увидив его - для идентификации пользователя достаточно только этих двух параметров. Наш сервер не обидится, увидив его -
@ -125,9 +118,7 @@ accessToken для игрового клиента Minecraft. Важно пон
Этот запрос позволяет проверить валиден ли указанный accessToken или нет. Этот запрос не обновляет токен и его время Этот запрос позволяет проверить валиден ли указанный accessToken или нет. Этот запрос не обновляет токен и его время
жизни, а только позволяет удостовериться, что он ещё действительный. жизни, а только позволяет удостовериться, что он ещё действительный.
Входные параметры: :param string accessToken: Уникальный ключ, полученый после авторизации.
:accessToken: Уникальный ключ, полученый после авторизации.
Успешным ответом будет являться пустое тело. При ошибке будет получен **400** или **401** статус. Пример ответа сервера Успешным ответом будет являться пустое тело. При ошибке будет получен **400** или **401** статус. Пример ответа сервера
при отправке истёкшего токена: при отправке истёкшего токена:
@ -143,11 +134,8 @@ accessToken для игрового клиента Minecraft. Важно пон
Этот запрос позволяет выполнить инвалидацию всех выданных пользователю токенов. Этот запрос позволяет выполнить инвалидацию всех выданных пользователю токенов.
Входные параметры: :param string username: Никнейм пользователя или его e-mail (более предпочтительно).
:param string password: Пароль пользователя.
:username: Никнейм пользователя или его e-mail (более предпочтительно).
:password: Пароль пользователя.
Успешным ответом будет являться пустое тело. Ориентируйтесь на поле **error** в теле ответа. Успешным ответом будет являться пустое тело. Ориентируйтесь на поле **error** в теле ответа.
@ -158,9 +146,8 @@ accessToken для игрового клиента Minecraft. Важно пон
Входные параметры: Входные параметры:
:accessToken: Уникальный ключ, полученый после авторизации. :param string accessToken: Уникальный ключ, полученый после авторизации.
:param string clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken.
:clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken.
Успешным ответом будет являться пустое тело. Ориентируйтесь на поле **error** в теле ответа. Успешным ответом будет являться пустое тело. Ориентируйтесь на поле **error** в теле ответа.

2
source/ru/oauth.rst
View File

@ -213,7 +213,7 @@
$accessToken = 'some_access_token_value'; $accessToken = 'some_access_token_value';
$curl = curl_init(); $curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://account.ely.by/api/oauth2/v1/token'); curl_setopt($curl, CURLOPT_URL, 'https://account.ely.by/api/account/v1/info');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, [ curl_setopt($curl, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $accessToken, 'Authorization: Bearer ' . $accessToken,