curl --request POST 'https://forum.arzguard.com/api/auth/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'login=example_user' \
--data-urlencode 'password=EXAMPLE_PASSWORD'
{
"user": {
"user_id": 42,
"username": "example_user"
}
}
Аутентификация
Проверить логин и пароль
Проверяет учётные данные и возвращает пользователя при успешной проверке.
POST
/
api
/
auth
/
curl --request POST 'https://forum.arzguard.com/api/auth/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'login=example_user' \
--data-urlencode 'password=EXAMPLE_PASSWORD'
{
"user": {
"user_id": 42,
"username": "example_user"
}
}
Проверяет учётные данные и возвращает пользователя при успешной проверке.
Нужен Super key со scope
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
auth. Метод проверяет пароль, но не создаёт браузерную сессию и не является OAuth-обменом. Для защиты от перебора передавайте реальный IP клиента в limit_ip. Логин и пароль отправляйте в теле формы.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: auth. Все перечисленные разрешения нужны одновременно.
Метод доступен только с Super key.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.application/x-www-form-urlencoded. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
string
required
Имя пользователя или email для проверки входа. Передавайте в теле запроса.
string
required
Проверяемый пароль. Передавайте в теле запроса; API-ключ его не заменяет.
string
IP клиента для проверки входа и ограничения перебора. Это адрес клиента, а не сервера интеграции.
Ответ
HTTP200, JSON. Схемы объектов и условные поля.
User
Объект найденного пользователя. При проверке сессии может представлять гостя; при
success=false отсутствует.errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/auth/' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'login=example_user' \
--data-urlencode 'password=EXAMPLE_PASSWORD'
{
"user": {
"user_id": 42,
"username": "example_user"
}
}