From ca031ee8b38124128888604535c65b45e17d5cb8 Mon Sep 17 00:00:00 2001 From: levon Date: Sun, 15 Sep 2019 02:42:35 +0300 Subject: [PATCH] redo readme --- README.md | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/README.md b/README.md index 4442ac9..a68fda6 100644 --- a/README.md +++ b/README.md @@ -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 - Тестовый роут