Регистрация
POST
DOMAIN/auth/register
- Параметры
| Параметр |
Тип |
Описание |
| firstName required |
string |
Имя пользователя |
| lastName required |
string |
Фамилия пользователя |
| email required |
string |
Электронный адрес |
| password required |
string |
Пароль пользователя |
| rePassword required |
string |
Повторение пароля пользователя |
- Пример запроса
{
firstName: 'Joe',
lastName: 'Cole',
email: 'test@gmail.com',
password: '7887wds!dsads',
rePassword: '7887wds!dsads'
}
- Успешный Ответ
HTTP1/1 200 OK
{
status: 'success'
}
- Неверный Ответ
HTTP1/1 400 Bad Request
{
status: 'error',
message: 'Неправильный Запрос'
}
- Translation message keys
| Ключ |
Описание |
| system.bad_request |
Неправильный Запрос |
| system.incorrect_first_name |
Неправильное Имя |
| system.incorrect_last_name |
Неправильная Фамилия |
| system.email_address_exist |
Такой адрес электронной почты уже существует |
| system.incorrect_re_password |
Пароль и повторение пароля не совпадают |
Вход
POST
DOMAIN/auth/login
- Параметры
| Параметр |
Тип |
Описание |
| email required |
строковой |
Электронный адрес |
| password required |
строковой |
Пароль клиента |
| rememberMe optional |
int |
Параметр для запоминания пароля |
- Образец Запроса
{
email: 'test@gmail.com',
password: '454dwds77',
rememberMe: 1
}
- Успешный Ответ
HTTP1/1 200 OK
{
status: 'success'
}
- Неверный Ответ
HTTP/1.1 400 Bad Request
{
status: 'error',
message: 'Неправильный Запрос'
}
- Ключи для перевода
| Ключ |
Описание |
| system.bad_request |
Ошибка в запросе |
| system.incorrect_login_or_password |
Неверный электронный адрес или пароль |
Изменение Профиля
POST
DOMAIN/auth/change
- Параметры
| Параметр |
Тип |
Описание |
| id required |
int |
Идентификатор Пользователя |
| firstName required |
string |
Имя пользователя |
| lastName required |
string |
Фамилия пользователя |
| password optional |
string |
Пароль пользователя |
| rePassword optional |
string |
Повторение пароля пользователя |
- Пример запроса
{
id: 5,
firstName: 'Joe',
lastName: 'Cole',
password: '7887wds!dsads',
rePassword: '7887wds!dsads'
}
- Успешный Ответ
HTTP1/1 200 OK
{
status: 'success',
message: 'Успешно обновлено'
}
- Неверный Ответ
HTTP1/1 400 Bad Request
{
status: 'error',
message: 'Неправильный Запрос'
}
- Ключи для перевода
| Ключ |
Описание |
| system.bad_request |
Неправильный Запрос |
| system.incorrect_first_name |
Неправильное Имя |
| system.incorrect_last_name |
Неправильная Фамилия |
| system.successfully_updated |
Усшешно обновлено |
Восстановления Пароля
POST
DOMAIN/auth/reset-password
- Параметры
| Параметр |
Тип |
Описание |
| id required |
int |
Идентификатор Пользователя |
| resetHash required |
string |
Код для восстановления |
| password required |
string |
Пароль пользователя |
| rePassword required |
string |
Повторение пароля пользователя |
- Пример запроса
{
id: 5,
resetHash: '45dsadsaefewfcweeds',
password: '7887wds!dsads',
rePassword: '7887wds!dsads'
}
- Успешный Ответ
HTTP1/1 200 OK
{
status: 'success',
message: 'Успешно обновлено'
}
- Неверный Ответ
HTTP1/1 400 Bad Request
{
status: 'error',
message: 'Неправильный Запрос'
}
- Ключи для перевода
| Ключ |
Описание |
| system.bad_request |
Неправильный Запрос |
| system.incorrect_reset_hash |
Неправильный Код |
| system.successfully_updated |
Усшешно обновлено |
Выход
GET
DOMAIN/auth/logout
Подтверждение Регистрации
GET
DOMAIN/auth/prompt/{hash}/{id}
- Параметры
| Параметр |
Тип |
Описание |
| hash required |
string |
Уникальный хеш-код |
| id required |
int |
Идентификатор Пользователя |
- Ключи для перевода
| Ключ |
Описание |
| system.bad_request |
Неправильный Запрос |
| system.thank_you_confirmation_message |
Успешно подтвержден |
Если тип запроса не xmlHttpRequest, скрипт создает flash message и переводит на главную страницу.