From 6e015fe31809681b2b4aae3038493d7a5a277e90 Mon Sep 17 00:00:00 2001 From: ErickSkrauch Date: Fri, 10 Apr 2020 16:27:24 +0300 Subject: [PATCH] Resolves #4. Fix oauth user's info code example. Fix capitalized parameters names in the minecraft-auth article --- source/en/oauth.rst | 2 +- source/ru/minecraft-auth.rst | 33 ++++++++++----------------------- source/ru/oauth.rst | 2 +- 3 files changed, 12 insertions(+), 25 deletions(-) diff --git a/source/en/oauth.rst b/source/en/oauth.rst index a7c9cf6..fa75af8 100644 --- a/source/en/oauth.rst +++ b/source/en/oauth.rst @@ -215,7 +215,7 @@ To send ``access_token``, the ``Authorization`` header is used with the value of $accessToken = 'some_access_token_value'; $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_HTTPHEADER, [ 'Authorization: Bearer ' . $accessToken, diff --git a/source/ru/minecraft-auth.rst b/source/ru/minecraft-auth.rst index fd939cf..034388e 100644 --- a/source/ru/minecraft-auth.rst +++ b/source/ru/minecraft-auth.rst @@ -59,13 +59,9 @@ accessToken для игрового клиента Minecraft. Важно пон Непосредственная авторизация пользователя, используя его логин (ник или e-mail) и пароль. - Входные параметры: - - :username: Никнейм пользователя или его e-mail (более предпочтительно). - - :password: Пароль пользователя. - - :clientToken: Уникальный токен лаунчера пользователя. + :param string username: Никнейм пользователя или его e-mail (более предпочтительно). + :param string password: Пароль пользователя. + :param string clientToken: Уникальный токен лаунчера пользователя. Успешный ответ: @@ -93,11 +89,8 @@ accessToken для игрового клиента Minecraft. Важно пон Обновляет валидный accessToken. Этот запрос позволяет не хранить на клиенте его пароль, а оперировать только сохранённым значением accessToken для практически бесконечной возможности проходить авторизацию. - Входные параметры: - - :accessToken: Уникальный ключ, полученый после авторизации. - - :clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken. + :param string accessToken: Уникальный ключ, полученый после авторизации. + :param string clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken. .. note:: В оригинальном протоколе так же передаётся значение selectedProfile, но на деле от него мало что зависит и для идентификации пользователя достаточно только этих двух параметров. Наш сервер не обидится, увидив его - @@ -125,9 +118,7 @@ accessToken для игрового клиента Minecraft. Важно пон Этот запрос позволяет проверить валиден ли указанный accessToken или нет. Этот запрос не обновляет токен и его время жизни, а только позволяет удостовериться, что он ещё действительный. - Входные параметры: - - :accessToken: Уникальный ключ, полученый после авторизации. + :param string accessToken: Уникальный ключ, полученый после авторизации. Успешным ответом будет являться пустое тело. При ошибке будет получен **400** или **401** статус. Пример ответа сервера при отправке истёкшего токена: @@ -143,11 +134,8 @@ accessToken для игрового клиента Minecraft. Важно пон Этот запрос позволяет выполнить инвалидацию всех выданных пользователю токенов. - Входные параметры: - - :username: Никнейм пользователя или его e-mail (более предпочтительно). - - :password: Пароль пользователя. + :param string username: Никнейм пользователя или его e-mail (более предпочтительно). + :param string password: Пароль пользователя. Успешным ответом будет являться пустое тело. Ориентируйтесь на поле **error** в теле ответа. @@ -158,9 +146,8 @@ accessToken для игрового клиента Minecraft. Важно пон Входные параметры: - :accessToken: Уникальный ключ, полученый после авторизации. - - :clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken. + :param string accessToken: Уникальный ключ, полученый после авторизации. + :param string clientToken: Уникальный идентификатор клиента, относительно которого получен accessToken. Успешным ответом будет являться пустое тело. Ориентируйтесь на поле **error** в теле ответа. diff --git a/source/ru/oauth.rst b/source/ru/oauth.rst index a9409ef..7977387 100644 --- a/source/ru/oauth.rst +++ b/source/ru/oauth.rst @@ -213,7 +213,7 @@ $accessToken = 'some_access_token_value'; $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_HTTPHEADER, [ 'Authorization: Bearer ' . $accessToken,