guild/docs/api/user.md

114 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

# Пользователь
## Методы
<table>
<tr>
<th>
Метод
</th>
<th>
Описание
</th>
</tr>
<tr>
<td>
2022-12-23 17:40:43 +03:00
login
</td>
<td>
2022-12-23 17:40:43 +03:00
Аторизация пользователя
</td>
</tr>
</table>
2022-12-23 17:40:43 +03:00
## Аторизация пользователя
POST: `https://guild.craft-group.xyz/api/user/login`
<table>
<tr>
<th>
2022-12-23 17:40:43 +03:00
Параметры <br>
* - обязательные
</th>
<th>
Значение
</th>
</tr>
<tr>
<td>
2022-12-23 17:40:43 +03:00
username*
</td>
<td>
2022-12-23 17:40:43 +03:00
Логин пользователя(адресс электронной почты пользователя)
</td>
</tr>
<tr>
<td>
password*
</td>
<td>
Пароль пользователя
</td>
</tr>
</table>
<p>
2022-12-23 17:40:43 +03:00
Пример возвращаемых данных:
</p>
```json5
{
2022-12-23 17:40:43 +03:00
"access_token": "RKZIA06yVbIkcbzdD7szVE5nnbRuxISV",
"access_token_expired_at": "2022-12-30",
"user_id": 1,
"card_id": 1
}
```
<p>
2022-12-23 17:40:43 +03:00
Возвращаемые параметры:
</p>
<table>
<tr>
<th>
Параметры
</th>
<th>
Значение
</th>
</tr>
<tr>
<td>
2022-12-23 17:40:43 +03:00
access_token
</td>
<td>
2022-12-23 17:40:43 +03:00
токен доступа
</td>
</tr>
<tr>
<td>
2022-12-23 17:40:43 +03:00
access_token_expired_at
</td>
<td>
2022-12-23 17:40:43 +03:00
дата истечения срока действия токена доступа
</td>
</tr>
<tr>
<td>
2022-12-23 17:40:43 +03:00
id
</td>
<td>
2022-12-23 17:40:43 +03:00
id пользователя
</td>
</tr>
<tr>
<td>
2022-12-23 17:40:43 +03:00
card_id
</td>
<td>
2022-12-23 17:40:43 +03:00
id профиля пользователя (при отсутствии профиля будет возвращено NULL)
</td>
</tr>
</table>