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 39afe17 commit a853125
Showing 1 changed file with 9 additions and 27 deletions.
36 changes: 9 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ API

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

######
######
######
######*

GET
(optional, everyone has access)
Expand All @@ -38,78 +36,62 @@ API

Общедоступные роуты позволяющие получить аутентификацию через социальные сети 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

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

######
######
######
######*

Deploy
------
Expand Down

0 comments on commit a853125

Please sign in to comment.