curl --request POST 'https://forum.arzguard.com/api/auth/login-token' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'user_id=42'
{
"login_token": "EXAMPLE_LOGIN_TOKEN",
"login_url": "https://forum.arzguard.com/login/api-token?token=EXAMPLE_LOGIN_TOKEN",
"expiry_date": 1700000300
}
Аутентификация
Создать ссылку для входа
Создаёт ограниченный по времени токен и URL входа в указанный аккаунт.
POST
/
api
/
auth
/
login-token
curl --request POST 'https://forum.arzguard.com/api/auth/login-token' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'user_id=42'
{
"login_token": "EXAMPLE_LOGIN_TOKEN",
"login_url": "https://forum.arzguard.com/login/api-token?token=EXAMPLE_LOGIN_TOKEN",
"expiry_date": 1700000300
}
Создаёт ограниченный по времени токен и URL входа в указанный аккаунт.
Нужен Super key и одновременно scopes
Тело запроса:
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
auth и auth:login_token. Сначала API создаёт токен; вход в браузере происходит только после открытия login_url. Уже вошедший посетитель сохраняет аккаунт, если не задан force=1. По умолчанию remember=1. Ссылка и токен дают возможность входа: не публикуйте их и проверяйте expiry_date.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Требуемые scopes: auth, auth:login_token. Все перечисленные разрешения нужны одновременно.
Метод доступен только с Super key.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.application/x-www-form-urlencoded. Вложенные значения передавайте в форме с квадратными скобками в имени поля.
integer
required
ID пользователя, для которого создаётся ссылка входа.
string
Ограничить использование создаваемого токена указанным IP клиента.
string
Адрес перехода после входа. Без него пользователь попадёт на главную страницу форума.
boolean
При
1 ссылка заменяет вход в другой аккаунт. По умолчанию 0: уже вошедший посетитель сохраняет свой аккаунт.boolean
Сохранять вход через cookie «запомнить меня». По умолчанию
1.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
string
Секретный токен автоматического входа.
string
Секретная ссылка, которую нужно открыть в браузере для входа.
integer
Срок действия токена в Unix time. После него ссылка входа недействительна.
errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request POST 'https://forum.arzguard.com/api/auth/login-token' \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'user_id=42'
{
"login_token": "EXAMPLE_LOGIN_TOKEN",
"login_url": "https://forum.arzguard.com/login/api-token?token=EXAMPLE_LOGIN_TOKEN",
"expiry_date": 1700000300
}