Skip to content

Commit

Permalink
redo readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ushliypakostnik committed Sep 14, 2019
1 parent aee1d41 commit ca031ee
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,66 +21,56 @@ API
POST { body : { user: { usermail, password } } }
(optional, everyone has access)
${HOST}/api/user/login

Общедоступный роут выдающий аутентификацию пользователю по адресу электронной почты и паролю или регистриющиющий пользователя если такого емейла нет в базе.


GET
(optional, everyone has access)
${HOST}/api/user/facebook

GET
(optional, everyone has access)
${HOST}/api/user/vkontakte

Общедоступные роуты позволяющие получить аутентификацию через социальные сети Facebook и VKontakte. Если полученного от соцсети адреса электронной почты пользователя нет в базе - он добавляется в нее.


POST { user: { id } }
(authentification required)
${HOST}/api/user/send-verify-email

Защищенный роут позволяющий отправить письмо о верификации аккаунта пользователя с переданным емейлом


POST { body: { id } }
(authentification required)
${HOST}/api/user/verify

Роут позволяющий верифицировать аккаунт пользователя по полученному айди


POST { body: { usermail } }
(optional, everyone has access)
${HOST}/api/user/remind

бщедоступный роут позволяющий отправить письмо со ссылкой на востановление пароля по переданному адресу электронной почты
Общедоступный роут позволяющий отправить письмо со ссылкой на востановление пароля по переданному адресу электронной почты


POST { body: { user: { id, password } } }
(authentification required)
${HOST}/api/user/password

Защищенный роут позволяющий создать новый пароль для пользователя по переданному айди


GET { user: { id } }
(authentification required)
${HOST}/api/user/profile

Защищенный роут возвращающий профиль пользователя по переданому айди


GET { user: { id } }
(authentification required)
${HOST}/api/user/logout

Защищенный роут прерываюший аунтентификацию


GET
${HOST}/test

Тестовый роут


Expand Down

0 comments on commit ca031ee

Please sign in to comment.