GET /player/{player_identifier}
Punkt końcowy: GET /v1/pdapi/player/<player_identifier>
Uwierzytelnianie: token Bearer
Wymagane uprawnienie: REST.Player.Read
Przeznaczenie
Zwraca dane jednego gracza. Można użyć obsługiwanego identyfikatora, takiego jak UserId lub PlayerUID.
Parametry ścieżki
player_identifier:UserIdlubPlayerUIDdocelowego gracza.
Parametry zapytania
Brak.
Treść żądania
Brak treści żądania.
Schemat odpowiedzi
Schemat odpowiedzi 200
| Pole | Typ | Opis |
|---|---|---|
Player |
obiekt | Szczegóły gracza. |
Player — schemat obiektu:
| Pole | Typ | Opis |
|---|---|---|
Name |
ciąg znaków | Bieżąca lub zapisana nazwa gracza. |
IP |
ciąg znaków | Adres IP gracza lub pusty ciąg znaków, jeśli jest niedostępny. |
PlayerUID |
ciąg znaków | UID gracza używany w danych zapisu Palworld. |
UserId |
ciąg znaków | Identyfikator użytkownika platformy lub pusty ciąg znaków, jeśli jest niedostępny. |
GuildName |
ciąg znaków | Nazwa gildii lub pusty ciąg znaków, jeśli jest niedostępna. |
GuildUUID |
ciąg znaków | UUID gildii lub zerowy GUID, jeśli jest niedostępny. |
Status |
ciąg znaków | Zapisany stan konta gracza. |
WorldLocation |
obiekt | Bieżące lub ostatnio zapisane współrzędne w świecie. |
MapLocation |
obiekt | Przeliczone współrzędne mapy. |
Pozycja — schemat obiektu:
| Pole | Typ | Opis |
|---|---|---|
x |
liczba | Współrzędna X. |
y |
liczba | Współrzędna Y. |
z |
liczba | Współrzędna Z. |
Odpowiedzi błędów
Treść odpowiedzi błędu ma następującą postać:
| HTTP | Kod błędu | Kiedy występuje |
|---|---|---|
401 |
INVALID_TOKEN |
Brakuje nagłówka Authorization, ma on nieprawidłowy format lub nie odpowiada żadnemu skonfigurowanemu tokenowi Bearer. |
403 |
MISSING_PERMISSION |
Token jest prawidłowy, ale nie ma uprawnienia wymaganego przez ten punkt końcowy. |
400 |
INVALID_JSON |
Przesłano treść żądania, ale nie można jej odczytać jako JSON. |
400 |
REQUEST_FAILED |
Funkcja wywołana w wątku gry zgłosiła wyjątek lub wspólny mechanizm wyszukiwania gracza/zasobu zakończył się niepowodzeniem. |
500 |
REQUEST_TIMEOUT |
Wewnętrzna funkcja wywołana w wątku gry nie zakończyła się w ciągu 5 sekund. |
404 |
PLAYER_NOT_FOUND |
Nie znaleziono gracza online o podanym player_identifier. |
404 |
PLAYER_ACCOUNT_NOT_FOUND |
Znaleziono gracza, ale nie udało się wczytać danych jego konta. |
Przykłady
Wyszukiwanie według UserID Steam
Wyszukiwanie według PlayerUID
Przykładowe zastosowania
- Otwarcie szczegółów gracza po wybraniu wiersza z
GET /players. - Sprawdzanie celu przed przyznaniem nagród lub nałożeniem kar.
- Sprawdzanie, czy serwer może obecnie odnaleźć gracza.