Przejdź do treści

GET /players

Punkt końcowy: GET /v1/pdapi/players

Uwierzytelnianie: token Bearer

Wymagane uprawnienie: REST.Players.Read

Przeznaczenie

Wyświetla znanych graczy wraz z identyfikatorami i informacjami o stanie. Przydaje się do tworzenia list wyboru graczy w narzędziach administratora.

Parametry ścieżki

Brak.

Parametry zapytania

Brak.

Treść żądania

Brak treści żądania.

Schemat odpowiedzi

Schemat odpowiedzi 200

Pole Typ Opis
Meta obiekt Liczebności listy graczy.
Players tablica obiektów Znani gracze wraz z identyfikatorami i informacjami o gildii, stanie i pozycji.

Meta — schemat obiektu:

Pole Typ Opis
PlayerCount liczba całkowita Liczba zwróconych kont graczy.
OnlineCount liczba całkowita Liczba zwróconych graczy będących obecnie online.

Players[] — schemat elementu:

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ć:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Czytelny opis błędu",
        "Details": {}
    }
}
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.
500 PLAYER_MANAGER_UNAVAILABLE Serwer nie uzyskał dostępu do menedżera graczy Palworld.

Przykłady

Wyświetlenie wszystkich znanych graczy

GET /v1/pdapi/players

Odświeżenie listy wyboru graczy administratora

GET /v1/pdapi/players

Przykładowe zastosowania

  • Tworzenie listy rozwijanej graczy online i znanych graczy.
  • Wyszukanie właściwego UserId lub PlayerUID przed wywołaniem punktów końcowych nagród, kar lub ekwipunku.
  • Sprawdzanie obecności graczy przed wysłaniem wiadomości lub ostrzeżenia o przerwie technicznej.

Powiązane strony