Pular para conteúdo

GET /player/{player_identifier}

Ponto final: GET /v1/pdapi/player/<player_identifier>

Autenticação: Token do portador

Permissão: REST.Player.Read

Objetivo

Retorna um jogador. O identificador pode ser um identificador de jogador compatível, como UserId ou PlayerUID.

Parâmetros de caminho

  • player_identifier: UserId ou PlayerUID para o jogador alvo.

Parâmetros de consulta

Nenhum.

Solicitar corpo

Nenhum corpo de solicitação.

Esquema de resposta

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.

Respostas de erro

Os corpos de erro usam esta forma:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Código de erro Quando isso acontece
401 INVALID_TOKEN O cabeçalho Authorization está ausente, malformado ou não corresponde a um token de portador configurado.
403 MISSING_PERMISSION O token é válido, mas não inclui essa permissão de endpoint.
400 INVALID_JSON Um corpo de solicitação foi fornecido, mas não pôde ser analisado como JSON.
400 REQUEST_FAILED O retorno de chamada do thread do jogo gerou uma exceção ou um resolvedor player/resource compartilhado falhou.
500 REQUEST_TIMEOUT O retorno de chamada do thread de jogo interno não foi concluído em 5 segundos.
404 PLAYER_NOT_FOUND Nenhum jogador online correspondeu ao player_identifier fornecido.
404 PLAYER_ACCOUNT_NOT_FOUND O jogador foi encontrado, mas não foi possível carregar os dados da conta do jogador.

Exemplos

Pesquisa por ID de usuário Steam

GET /v1/pdapi/player/steam_76561198012345678

Pesquisa por PlayerUID

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

Cenários

  • Abra uma página de detalhes do jogador após selecionar uma linha de GET /players.
  • Confirme a meta antes de dar recompensas ou aplicar punições.
  • Verifique se o jogador pode atualmente ser resolvido pelo servidor.