Секция /v1/user/

user/confirm

Запрос /v1/user/confirm/ подтверждает принадлежность адреса электронной почты пользователю, совершившему регистрацию, и активирует учётную запись. При выполнении запроса необходимо предоставить проверочный код, который отправляется на адрес, указанный при регистрации. Количество попыток подтверждения ограничено. После превышения лимита адрес электронной почты освобождается для новых попыток регистрации. В случае успешного подтверждения учётной записи следует получить токен доступа при помощи запроса /v1/user/atoken/. Токен доступа должен передаваться при выполнении большинства запросов к серверу.

  • Адрес запроса: https://books.luwrain.org/v1/user/confirm/
  • Метод: GET
  • Параметры:
    • mail: подлежащий потверждению адрес электронной почты
    • code: код подтверждения из сообщения, полученного при регистрации
  • Формат ответа: JSON
  • Поля ответа:
    • type: код ответа, принимающий следующие значения:
      • OK: адрес успешно подтверждён
      • NO_MAIL: адрес электронной почты отсутствует в запросе
      • NO_CONFIRMATION_CODE: код подтверждения отсутствует в запросе
      • INVALID_MAIL: неверный адрес электронной почты (возвращается также в случае, когда адрес уже подтверждён)
      • INVALID_CONFIRMATION_CODE: предоставленный проверочный код неверен
      • TOO_MANY_ATTEMPTS: произведено слишком много неуспешных попыток подтверждения, адрес электронной почты освобождён

user/register

Запрос /v1/user/register/ выполняет регистрацию пользователя на сервере. Необходимо предоставить адрес электронной почты и пароль в теле запроса POST, закодированных в формате URL. После регистрации учётная запись пользователя должна быть подтверждена путём запроса /v1/user/confirm/ с предоставлением кода подтверждения, полученного при помощи сообщения, отправленного на указанный адрес.

  • Адрес запроса: https://books.luwrain.org/v1/user/register/
  • Метод: POST
  • Параметры:
    • mail: адрес электронной почты для идентификации пользователя (URL-кодирование в теле запроса)
    • passwd: пароль (URL-кодирование в теле запроса)
  • Формат ответа: JSON
  • Поля ответа:
    • type: код ответа, принимающий следующие значения:
      • OK: регистрация выполнена
      • INVALID_MAIL: неверный формат адреса электронной почты
      • MAIL_ADDRESS_IN_ALREADY_IN_USE: пользователь с указанным адресом электронной почты уже зарегистрирован на сервере

user/verify-atoken

Запрос /v1/user/verify-atoken/ проверяет статус токена доступа. Если токен является допустимым, то в ответе предоставляется адрес электронной почты учётной записи, с которым токен связан.

Во всех иных случаях возвращается ошибка (токен неизвестен или был отозван).

  • Адрес запроса: https://books.luwrain.org/v1/user/verify-atoken/
  • Метод: GET
  • Параметры:
    • atoken: токен доступа для проверки
    • code: код подтверждения из сообщения, полученного при регистрации
  • Формат ответа: JSON
  • Поля ответа:
    • type: код ответа, принимающий следующие значения:
      • OK: токен является правильным и актуальным, может использоваться для выполнения операций
      • INVALID_QUERY: неверно оформленынй запрос
      • NO_VALID_ACCESS_TOKEN: предоставлен неизвестный или отозванный токен
    • mail: адрес электронной почты, для которого создан предоставленный токен
© 2012–2021 Проект LUWRAIN
Дизайн от Strash