Перейти к содержанию

GET /player/{player_identifier}

Конечная точка: GET /v1/pdapi/player/<player_identifier>

Аутентификация: Токен носителя

Разрешение: REST.Player.Read

Цель

Возвращает одного игрока. Идентификатором может быть поддерживаемый идентификатор игрока, например UserId или PlayerUID.

Параметры пути

  • player_identifier: UserId или PlayerUID для целевого игрока.

Параметры запроса

Нет.

Тело запроса

Нет тела запроса.

Схема ответа

200 response schema

Field Type Description
Player object Player details.

Player object schema:

Field Type Description
Name string Current or saved player name.
IP string Player IP address, or an empty string when unavailable.
PlayerUID string Player UID used by Palworld save data.
UserId string Platform user ID, or an empty string when unavailable.
GuildName string Guild name, or an empty string when unavailable.
GuildUUID string Guild UUID, or a zero GUID when unavailable.
Status string Saved player account state.
WorldLocation object Current or last saved world coordinates.
MapLocation object Converted map coordinates.

Location object schema:

Field Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

Реакции на ошибки

Тела ошибок используют следующую форму:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Код ошибки Когда это произойдет
401 INVALID_TOKEN Заголовок Authorization отсутствует, имеет неправильный формат или не соответствует настроенному токену носителя.
403 MISSING_PERMISSION Токен действителен, но не включает это разрешение конечной точки.
400 INVALID_JSON Текст запроса был предоставлен, но его не удалось проанализировать как JSON.
400 REQUEST_FAILED Обратный вызов игрового потока вызвал исключение, или произошел сбой общего преобразователя player/resource.
500 REQUEST_TIMEOUT Обратный вызов внутреннего игрового потока не завершился в течение 5 секунд.
404 PLAYER_NOT_FOUND Ни один онлайн-плеер не соответствует указанному player_identifier.
404 PLAYER_ACCOUNT_NOT_FOUND Игрок найден, но данные аккаунта игрока загрузить не удалось.

Примеры

Поиск по идентификатору пользователя Steam

GET /v1/pdapi/player/steam_76561198012345678

Поиск по PlayerUID

GET /v1/pdapi/player/b7f4e91a-2c53-4d8f-a6e1-93c4bb62a7d1

Сценарии

  • Откройте страницу сведений об игроке после выбора строки из GET /players.
  • Подтвердите цель, прежде чем давать награды или применять наказания.
  • Проверьте, может ли игрок в данный момент быть разрешен сервером.