curl --request GET 'https://forum.arzguard.com/api/me/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"me": {
"user_id": 42,
"username": "example_user"
}
}
Текущий пользователь
Получить текущего пользователя
Возвращает пользователя, в контексте которого выполняется API-запрос.
GET
/
api
/
me
/
curl --request GET 'https://forum.arzguard.com/api/me/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"me": {
"user_id": 42,
"username": "example_user"
}
}
Возвращает пользователя, в контексте которого выполняется API-запрос.
Отдельный scope для вызова не требуется. При наличии
Других входных параметров у метода нет. Общие параметры контекста описаны в разделе авторизации.
Ошибки возвращаются в общей структуре
Примеры сокращены и содержат только условные значения. Состав полей объектов зависит от прав, контекста и установленных дополнений.
user:read используется подробное представление пользователя, без него — сокращённое. Для Super key пользователь выбирается заголовком XF-Api-User; без него контекст гостевой. Это не /users/me/.
Доступ
ПередавайтеXF-Api-Key в заголовке каждого запроса. Типы ключей и выбор пользователя.
Дополнительные scopes для самого вызова не требуются.
Права текущего API-пользователя проверяются отдельно от scopes. Для Super key контекст задаётся заголовком XF-Api-User.
Параметры
string
required
Секретный API-ключ. В примерах ключ берётся из серверной переменной
$FORUM_API_KEY.Ответ
HTTP200, JSON. Схемы объектов и условные поля.
User
Текущий API-пользователь. Без scope
user:read возвращается сокращённый набор полей.errors. Обрабатывайте поле code; текст message может меняться или переводиться. Формат ошибок.
curl --request GET 'https://forum.arzguard.com/api/me/' \
--header "XF-Api-Key: $FORUM_API_KEY"
{
"me": {
"user_id": 42,
"username": "example_user"
}
}